POST api/app/reporting

Allows apps to access readonly stored proceedures for reporting These stored procs are only written by rezi, and will have to be approved before adding to the system, the stored procs must return a json string Processes this app API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

{ "StoredProcName": "MyStoredProceedureName", "parameters": [ { "Name": "parameter1Name", "Value": "10-10-2021" }, { "Name": "monthsAgo", "Value": 3 }, { "Name": "negIds", "Value": [10101,10102,10103], "Type":"Int64" //c# .net built in type name }, ] }

AppReportingQueryDataContract
NameDescriptionTypeAdditional information
StoredProcName

The stored proc name value.

string

None.

parameters

The collection of parameters.

Collection of AppReportingQueryParametersDataContract

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "StoredProcName": "sample string 1",
  "parameters": [
    {
      "Name": "sample string 1",
      "Value": {},
      "Type": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Value": {},
      "Type": "sample string 3"
    }
  ]
}

Response Information

Resource Description

the values as dictionary of names and values

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

The version value.

Version

None.

Content

The content value.

HttpContent

None.

StatusCode

The status code classification.

HttpStatusCode

None.

ReasonPhrase

The reason phrase value.

string

None.

Headers

The collection of headers.

Collection of Object

None.

RequestMessage

The request message value.

HttpRequestMessage

None.

IsSuccessStatusCode

Indicates whether this item is success status code.

boolean

None.