Returns information on a query from the Workflow module. Queries are accessible only to their authors, editors, and audience members.
URL
{WSUrl}/api/queries/<Query>/metadata
REQUEST METHOD
GET
URL PARAMETERS
Query: This parameter is provided in the URL and can be either the query name or the query GUID. Queries with special characters in their names cannot be run through the API.
REQUEST EXAMPLES
{WSUrl}/api/queries/Grouping/metadata
{WSUrl}/api/queries/cc45b704-b3d5-11e0-8b69-001ec91f4b0a/metadata
SUCCESS RESPONSE
Returns a QueryMetadata in the following format:
QueryMetadata
{
Guid Id;
string Name;
ColumnMetadata[] Columns;
}
The "Columns" field has the following format:
{
string Name;
string Caption;
int? Order;
bool IsGroup;
bool IsCustomAttribute;
ColumnType? Type;
}
The "Column Type" field may have the following values: Text, Number, Real, Date, DateTime, Time, Boolean.
SUCCESS RESPONSE EXAMPLE
{
"Name":"Workflow Query",
"Oid":1,
"Columns":[
{"Caption":"Code","IsCustomAttribute":false,"IsGroup":false,"Name":"EventID","Type":"Text"},{"Caption":"Status","IsCustomAttribute":false,"IsGroup":false,"Name":"Status","Type":"Text"},{"Caption":"Title","IsCustomAttribute":false,"IsGroup":false,"Name":"Title","Type":"Text"},{"Caption":"Type","IsCustomAttribute":false,"IsGroup":false,"Name":"Type","Type":"Text"}
]