POST api/Report/ExecuteStoredProcedure

Executes the Report specific stored procedures to pull report result set.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "StoredProcedureName": "sample string 1",
  "IsIncoming": true,
  "Parameters": [
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "Type": "List",
      "Value": {},
      "Mandatory": true,
      "SortOrder": 5,
      "IsFilterParameter": true,
      "OverrideBehavior": "sample string 7",
      "DefaultValue": {},
      "SelectedValue": "sample string 9",
      "ExcludeFromScheduler": true,
      "FilterName": "sample string 11"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "Type": "List",
      "Value": {},
      "Mandatory": true,
      "SortOrder": 5,
      "IsFilterParameter": true,
      "OverrideBehavior": "sample string 7",
      "DefaultValue": {},
      "SelectedValue": "sample string 9",
      "ExcludeFromScheduler": true,
      "FilterName": "sample string 11"
    },
    {
      "Name": "sample string 1",
      "DisplayName": "sample string 2",
      "Type": "List",
      "Value": {},
      "Mandatory": true,
      "SortOrder": 5,
      "IsFilterParameter": true,
      "OverrideBehavior": "sample string 7",
      "DefaultValue": {},
      "SelectedValue": "sample string 9",
      "ExcludeFromScheduler": true,
      "FilterName": "sample string 11"
    }
  ],
  "SortColumns": [
    {
      "ColumnName": "sample string 1",
      "IsAscending": true,
      "DataType": "sample string 3"
    },
    {
      "ColumnName": "sample string 1",
      "IsAscending": true,
      "DataType": "sample string 3"
    },
    {
      "ColumnName": "sample string 1",
      "IsAscending": true,
      "DataType": "sample string 3"
    }
  ],
  "IsRequestForReportFilter": true,
  "ReportID": 4,
  "Token": "sample string 5",
  "FreeText": "sample string 6",
  "GroupIds": [
    1,
    2,
    3
  ],
  "FromIndex": 7,
  "ToIndex": 8,
  "IsWebCalling": true,
  "RequestMode": "sample string 10",
  "Client": "sample string 11",
  "AppVersion": "sample string 12",
  "AppOperatingSystem": "sample string 13",
  "AppName": "sample string 14",
  "MasterUserID": 15,
  "IsRecurringRequest": true
}

text/html

Sample:

{"StoredProcedureName":"sample string 1","IsIncoming":true,"Parameters":[{"Name":"sample string 1","DisplayName":"sample string 2","Type":"List","Value":{},"Mandatory":true,"SortOrder":5,"IsFilterParameter":true,"OverrideBehavior":"sample string 7","DefaultValue":{},"SelectedValue":"sample string 9","ExcludeFromScheduler":true,"FilterName":"sample string 11"},{"Name":"sample string 1","DisplayName":"sample string 2","Type":"List","Value":{},"Mandatory":true,"SortOrder":5,"IsFilterParameter":true,"OverrideBehavior":"sample string 7","DefaultValue":{},"SelectedValue":"sample string 9","ExcludeFromScheduler":true,"FilterName":"sample string 11"},{"Name":"sample string 1","DisplayName":"sample string 2","Type":"List","Value":{},"Mandatory":true,"SortOrder":5,"IsFilterParameter":true,"OverrideBehavior":"sample string 7","DefaultValue":{},"SelectedValue":"sample string 9","ExcludeFromScheduler":true,"FilterName":"sample string 11"}],"SortColumns":[{"ColumnName":"sample string 1","IsAscending":true,"DataType":"sample string 3"},{"ColumnName":"sample string 1","IsAscending":true,"DataType":"sample string 3"},{"ColumnName":"sample string 1","IsAscending":true,"DataType":"sample string 3"}],"IsRequestForReportFilter":true,"ReportID":4,"Token":"sample string 5","FreeText":"sample string 6","GroupIds":[1,2,3],"FromIndex":7,"ToIndex":8,"IsWebCalling":true,"RequestMode":"sample string 10","Client":"sample string 11","AppVersion":"sample string 12","AppOperatingSystem":"sample string 13","AppName":"sample string 14","MasterUserID":15,"IsRecurringRequest":true}

application/xml, text/xml

Sample:

<APIExecuteStoreProcedureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <AppName>sample string 14</AppName>
  <AppOperatingSystem>sample string 13</AppOperatingSystem>
  <AppVersion>sample string 12</AppVersion>
  <Client>sample string 11</Client>
  <FreeText>sample string 6</FreeText>
  <FromIndex>7</FromIndex>
  <GroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </GroupIds>
  <IsRecurringRequest>true</IsRecurringRequest>
  <IsWebCalling>true</IsWebCalling>
  <MasterUserID>15</MasterUserID>
  <RequestMode>sample string 10</RequestMode>
  <ToIndex>8</ToIndex>
  <Token>sample string 5</Token>
  <IsIncoming>true</IsIncoming>
  <IsRequestForReportFilter>true</IsRequestForReportFilter>
  <Parameters>
    <APIReportParameter>
      <DefaultValue />
      <DisplayName>sample string 2</DisplayName>
      <ExcludeFromScheduler>true</ExcludeFromScheduler>
      <FilterName>sample string 11</FilterName>
      <IsFilterParameter>true</IsFilterParameter>
      <Mandatory>true</Mandatory>
      <Name>sample string 1</Name>
      <OverrideBehavior>sample string 7</OverrideBehavior>
      <SelectedValue>sample string 9</SelectedValue>
      <SortOrder>5</SortOrder>
      <Type>List</Type>
      <Value />
    </APIReportParameter>
    <APIReportParameter>
      <DefaultValue />
      <DisplayName>sample string 2</DisplayName>
      <ExcludeFromScheduler>true</ExcludeFromScheduler>
      <FilterName>sample string 11</FilterName>
      <IsFilterParameter>true</IsFilterParameter>
      <Mandatory>true</Mandatory>
      <Name>sample string 1</Name>
      <OverrideBehavior>sample string 7</OverrideBehavior>
      <SelectedValue>sample string 9</SelectedValue>
      <SortOrder>5</SortOrder>
      <Type>List</Type>
      <Value />
    </APIReportParameter>
    <APIReportParameter>
      <DefaultValue />
      <DisplayName>sample string 2</DisplayName>
      <ExcludeFromScheduler>true</ExcludeFromScheduler>
      <FilterName>sample string 11</FilterName>
      <IsFilterParameter>true</IsFilterParameter>
      <Mandatory>true</Mandatory>
      <Name>sample string 1</Name>
      <OverrideBehavior>sample string 7</OverrideBehavior>
      <SelectedValue>sample string 9</SelectedValue>
      <SortOrder>5</SortOrder>
      <Type>List</Type>
      <Value />
    </APIReportParameter>
  </Parameters>
  <ReportID>4</ReportID>
  <SortColumns>
    <APIReportSortColumn>
      <ColumnName>sample string 1</ColumnName>
      <DataType>sample string 3</DataType>
      <IsAscending>true</IsAscending>
    </APIReportSortColumn>
    <APIReportSortColumn>
      <ColumnName>sample string 1</ColumnName>
      <DataType>sample string 3</DataType>
      <IsAscending>true</IsAscending>
    </APIReportSortColumn>
    <APIReportSortColumn>
      <ColumnName>sample string 1</ColumnName>
      <DataType>sample string 3</DataType>
      <IsAscending>true</IsAscending>
    </APIReportSortColumn>
  </SortColumns>
  <StoredProcedureName>sample string 1</StoredProcedureName>
</APIExecuteStoreProcedureRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "JsonResult": "sample string 1",
  "TotalRemainingSeconds": 2.1,
  "Success": true,
  "ErrorMessage": "sample string 4",
  "MenuAccessData": {
    "HasAccessToMap": true,
    "HasAccessToVehicle": true,
    "HasAccessToVehicleAdministration": true,
    "HasAccessToDriver": true,
    "HasAccessToPOI": true,
    "HasAccessToReports": true,
    "HasAccessToSettings": true,
    "HasAccessToTrips": true,
    "HasAccessToTranslations": true,
    "HasAccessToDashboard": true,
    "HasAccessToLogBook": true,
    "HasAccessToGroup": true,
    "HasAccessToTemplate": true,
    "HasAccessToUnit": true,
    "HasAccessToUser": true,
    "HasAccessToTicket": true,
    "HasAccessToContract": true,
    "HasAccessToSIM": true,
    "HasAccessToCommand": true,
    "HasAccessToUnitProfile": true,
    "HasAccessToProfileTrigger": true,
    "HasAccessToScript": true,
    "HasAccessToTriggerSchedule": true,
    "HasAccessToMetaBaseReport": true,
    "HasAccessToMetaBaseUserDashboard": true,
    "HasAccessToRecoveryMode": true
  },
  "StatusCode": 5,
  "ComponentFilterIds": [
    1,
    2,
    3
  ]
}

text/html

Sample:

{"JsonResult":"sample string 1","TotalRemainingSeconds":2.1,"Success":true,"ErrorMessage":"sample string 4","MenuAccessData":{"HasAccessToMap":true,"HasAccessToVehicle":true,"HasAccessToVehicleAdministration":true,"HasAccessToDriver":true,"HasAccessToPOI":true,"HasAccessToReports":true,"HasAccessToSettings":true,"HasAccessToTrips":true,"HasAccessToTranslations":true,"HasAccessToDashboard":true,"HasAccessToLogBook":true,"HasAccessToGroup":true,"HasAccessToTemplate":true,"HasAccessToUnit":true,"HasAccessToUser":true,"HasAccessToTicket":true,"HasAccessToContract":true,"HasAccessToSIM":true,"HasAccessToCommand":true,"HasAccessToUnitProfile":true,"HasAccessToProfileTrigger":true,"HasAccessToScript":true,"HasAccessToTriggerSchedule":true,"HasAccessToMetaBaseReport":true,"HasAccessToMetaBaseUserDashboard":true,"HasAccessToRecoveryMode":true},"StatusCode":5,"ComponentFilterIds":[1,2,3]}

application/xml, text/xml

Sample:

<APIExecuteStoreProcedureResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Models.APIModels">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Accessor.Common.Model.Transport">Success</ResponseCode>
  <ComponentFilterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </ComponentFilterIds>
  <ErrorMessage>sample string 4</ErrorMessage>
  <MenuAccessData>
    <HasAccessToCommand>true</HasAccessToCommand>
    <HasAccessToContract>true</HasAccessToContract>
    <HasAccessToDashboard>true</HasAccessToDashboard>
    <HasAccessToDriver>true</HasAccessToDriver>
    <HasAccessToGroup>true</HasAccessToGroup>
    <HasAccessToLogBook>true</HasAccessToLogBook>
    <HasAccessToMap>true</HasAccessToMap>
    <HasAccessToMetaBaseReport>true</HasAccessToMetaBaseReport>
    <HasAccessToMetaBaseUserDashboard>true</HasAccessToMetaBaseUserDashboard>
    <HasAccessToPOI>true</HasAccessToPOI>
    <HasAccessToProfileTrigger>true</HasAccessToProfileTrigger>
    <HasAccessToRecoveryMode>true</HasAccessToRecoveryMode>
    <HasAccessToReports>true</HasAccessToReports>
    <HasAccessToSIM>true</HasAccessToSIM>
    <HasAccessToScript>true</HasAccessToScript>
    <HasAccessToSettings>true</HasAccessToSettings>
    <HasAccessToTemplate>true</HasAccessToTemplate>
    <HasAccessToTicket>true</HasAccessToTicket>
    <HasAccessToTranslations>true</HasAccessToTranslations>
    <HasAccessToTriggerSchedule>true</HasAccessToTriggerSchedule>
    <HasAccessToTrips>true</HasAccessToTrips>
    <HasAccessToUnit>true</HasAccessToUnit>
    <HasAccessToUnitProfile>true</HasAccessToUnitProfile>
    <HasAccessToUser>true</HasAccessToUser>
    <HasAccessToVehicle>true</HasAccessToVehicle>
    <HasAccessToVehicleAdministration>true</HasAccessToVehicleAdministration>
  </MenuAccessData>
  <StatusCode>5</StatusCode>
  <Success>true</Success>
  <JsonResult>sample string 1</JsonResult>
  <TotalRemainingSeconds>2.1</TotalRemainingSeconds>
</APIExecuteStoreProcedureResponse>