POST api/metrics/summaries
Returns an array of metrics for a given project, baseline and entities combination.
Request Information
URI Parameters
None.
Body Parameters
Contains the ProjectId, BaselineId, EntityIdList, SummaryLevelID and SummaryStartDate identifiers
metricSummaryRequestName | Description | Type | Additional information |
---|---|---|---|
ProjectId | integer |
None. |
|
BaselineId | integer |
None. |
|
EntityIdList | string |
None. |
|
SummaryLevelID | integer |
None. |
|
SummaryStartDate | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ProjectId": 1, "BaselineId": 2, "EntityIdList": "sample string 3", "SummaryLevelID": 4, "SummaryStartDate": "sample string 5" }
application/xml, text/xml
Sample:
<MetricsController.metricSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sumerian.API.Controllers"> <BaselineId>2</BaselineId> <EntityIdList>sample string 3</EntityIdList> <ProjectId>1</ProjectId> <SummaryLevelID>4</SummaryLevelID> <SummaryStartDate>sample string 5</SummaryStartDate> </MetricsController.metricSummaryRequest>
Response Information
Resource Description
Dictionary of string [key] and string [value]Response Formats
application/json, text/json
Sample:
{ "sample string 1": "sample string 2", "sample string 3": "sample string 4" }
application/xml, text/xml
Sample:
<ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <KeyValueOfstringstring> <Key>sample string 1</Key> <Value>sample string 2</Value> </KeyValueOfstringstring> <KeyValueOfstringstring> <Key>sample string 3</Key> <Value>sample string 4</Value> </KeyValueOfstringstring> </ArrayOfKeyValueOfstringstring>