GET api/Data/getResultset

Retrieves a dataset based on executing a report

Request Information

URI Parameters

None.

Body Parameters

Contains the report id and criteria to pass into the report (optional)

Name	Description	Type	Additional information
reportId	The internal report id found under Administration > General and Security > Report Manager	string	None.
parameters	The list of criteria for the report, also found under Administration > General and Security > Report Manager. e.g. [{"paramName":"bomId", "paramValue":"B00000000000000A"}]	Collection of Parameters	None.

Request Formats

application/json, text/json

Sample:

{
  "reportId": "sample string 1",
  "parameters": [
    {
      "paramName": "sample string 1",
      "paramValue": "sample string 2"
    },
    {
      "paramName": "sample string 1",
      "paramValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<DataController.getResultsetParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMAPWebAPI.Controllers">
  <parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/CMAPWebAPI.Models">
    <d2p1:Parameters>
      <d2p1:paramName>sample string 1</d2p1:paramName>
      <d2p1:paramValue>sample string 2</d2p1:paramValue>
    </d2p1:Parameters>
    <d2p1:Parameters>
      <d2p1:paramName>sample string 1</d2p1:paramName>
      <d2p1:paramValue>sample string 2</d2p1:paramValue>
    </d2p1:Parameters>
  </parameters>
  <reportId>sample string 1</reportId>
</DataController.getResultsetParam>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'getResultsetParam'.

Response Information

Resource Description

Collection of Dictionary of Object [key] and Object [value]

Response Formats

application/json, text/json

Sample:

[
  {
    "System.Object": {}
  },
  {
    "System.Object": {}
  }
]

application/xml, text/xml

Sample:

<ArrayOfArrayOfKeyValueOfanyTypeanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <ArrayOfKeyValueOfanyTypeanyType>
    <KeyValueOfanyTypeanyType>
      <Key />
      <Value />
    </KeyValueOfanyTypeanyType>
    <KeyValueOfanyTypeanyType>
      <Key />
      <Value />
    </KeyValueOfanyTypeanyType>
  </ArrayOfKeyValueOfanyTypeanyType>
  <ArrayOfKeyValueOfanyTypeanyType>
    <KeyValueOfanyTypeanyType>
      <Key />
      <Value />
    </KeyValueOfanyTypeanyType>
    <KeyValueOfanyTypeanyType>
      <Key />
      <Value />
    </KeyValueOfanyTypeanyType>
  </ArrayOfKeyValueOfanyTypeanyType>
</ArrayOfArrayOfKeyValueOfanyTypeanyType>