View Compliance Query Details

Returns information on a query from the Compliance module. Each user can only access queries of which they are author, editor, or an audience member.

URL

{RMUrl}/api/Compliance/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 EXAMPLE

{RMUrl}/api/Compliance/queries/Grouping/metadata

{RMUrl}/api/Compliance/queries/cc45b704-b3d5-11e0-8b69-001ec91f4b0a/metadata

SUCCESS RESPONSE

Returns a QueryMetadata in the following format:

QueryMetadata

{

Guid Id;

string Name;

string AuthorId;

string AuthorName;

string AuthorPhone;

string AuthorEmail;

ColumnMetadata[] Columns;

}

The "Columns" field has the following format:

{

string Name;

string SmallCaption;

string Caption;

int? Order;

bool IsGroup;

bool IsCustomAttribute;

ColumnType? Type;

ColumnSortOrder SortOrder;

}

The "ColumnType" field may have the following values: Text, Percentual, Number, Command, TextOrLink, Link, GeoReference, Real, Date, DateTime, Html, Formattable.

The "ColumnSortOrder" field may have the following values: None, Ascending, Descending.

SUCCESS RESPONSE EXAMPLE

{"AuthorId":"340e27e7-58d6-11e0-b958-001b78932efe","AuthorName":"John Smith","AuthorPhone":"+1-212-555-1001","AuthorEmail":"jsmith@example.com","Id":"99031b1a-c877-4a78-9b22-033e83d6a066","Name":"Compliance Results","Columns":[{"Name":"RequirementTitle","SmallCaption":"Req Ttl","Caption":"Requirement Title (Req Ttl)","Order":0,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"RequirementLevel","SmallCaption":"Req Level","Caption":"Requirement Level (Req Level)","Order":1,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ReferenceModelShortName","SmallCaption":"Short Name Auth Doc","Caption":"Short Name of Authoritative Document (Short Name Auth Doc)","Order":2,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ComplianceIndex","SmallCaption":"CI","Caption":"Compliance Index (CI)","Order":3,"IsGroup":false,"IsCustomAttribute":false,"Type":"Percentual","SortOrder":"None"},{"Name":"ComplianceLevel","SmallCaption":"CL","Caption":"Compliance Level (CL)","Order":4,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"QuantityOfInterviews","SmallCaption":"No. Interviews","Caption":"Number of Interviews (No. Interviews)","Order":5,"IsGroup":false,"IsCustomAttribute":false,"Type":"Number","SortOrder":"None"},{"Name":"RequirementType","SmallCaption":"Req Type","Caption":"Requirement Type (Req Type)","Order":6,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ProjectCode","SmallCaption":"Project Code","Caption":"Project Code","Order":7,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"ProjectName","SmallCaption":"Project","Caption":"Project Name (Project)","Order":8,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"RequirementID","SmallCaption":"ID","Caption":"Requirement ID (ID)","Order":9,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"},{"Name":"RequirementCode","SmallCaption":"Req. Code","Caption":"Requirement Code (Req. Code)","Order":10,"IsGroup":false,"IsCustomAttribute":false,"Type":"Text","SortOrder":"None"}],"UpdatedOn":"\/Date(-62135596800000)\/"}