Reviewer Mapping Async API
| ReviewerMappingAsync | This API submits the report generation request which executes asynchronously. The result of this API contains the identifier for the report, status, and location for retrieving the report data. |
|---|---|
| The report identifier and locations in the result can be used to track the report generation operation. | |
To use the ReviewerMappingAsync API, follow the steps below:
-
Call the ReviewerMappingAsync API to submit a report generation request.
This asynchronous API supports GET and POST query methods. Use any of the following as needed:
-
GET https://<Reporting endpoint base URL>/OData/ReviewerMappingAsync?ReportName=<Name of the report>&ReviewerUsers=[list of comma-separated values] -
POST https://<Reporting endpoint base URL>/OData/ReviewerMappingAsync
Sample Input
-
GET https://<Reporting endpoint Base URL>/odata/ ReviewerMappingAsync?ReportName=<Name of the report>&ReviewerUsers=[1,2,5] -
POST https://<Reporting endpoint base URL>/OData/ReviewerMappingAsync
ReviewerMappingAsync - URL Parameter/Filters
The following parameters/filters can be used with the ReviewerMappingAsync API when invoked using the GET and POST methods. The system uses the AND operator between the filters to return the result based on the specified filters.
| ReportName | Mandatory | Specify the name of the report you want to generate. |
|---|---|---|
| Limitations | ||
| - The report name can be up to a maximum of 256 characters long. | ||
| - Special characters are not allowed; only alphanumeric values are permitted. | ||
| ReviewerUsers | Optional | Specify a list of UserIDs for the reviewers whose details you want to retrieve. |
| Data Type | ||
| JSON array of integers 'id'(identifier fields) that is ReviewerUsersIDs. | ||
| Note: The valid value of the ReviewerUsers is an ID of any user from the Arctera Surveillance User ID list. The User ID list can be fetched from the Users API endpoint. SeeUsers API. Refer to theuserIdfield only. If no reviewer user ID is provided, Arctera Surveillance retrieves the details of all ReviewerUsers. |
Scenario 1: New request to submit a report.
Sample input:
POST https://<Reporting endpoint base URL>/OData/ReviewerMappingAsync
{
"ReportName":"TestReviewerMappingReport",
"ReviewerUsers":[1]
}
Sample response:
Scenario 2: When ReportName is mentioned, but ReviewerUsers is not.
Sample input:
POST https://\<Reporting endpoint base URL\>/OData/ReviewerMappingAsync
{
"ReportName":"TestReviewerMappingReport"
}
Sample response:
Scenario 3: Default behavior when no ReviewerUsers are provided; the request is submitted for all available ReviewerUsers
Sample input:
POST https://<Reporting endpoint base URL>/OData/ReviewerMappingAsync
{
"ReportName":"TestReviewerMappingReport",
"ReviewerUsers":[]
}
Sample response:
Scenario 4: ReportName is not mentioned.
Sample Input:
POST https://\<Reporting endpoint base URL\>/OData/ReviewerMappingAsync
{
"ReportName":"",
"ReviewerUsers":[1,3]
}
Sample Response:
The following table explains the parameters showcased in the response to a Reviewer Mapping Async API request.
| Name | Description |
|---|---|
| reportId | Displays report ID. It is generated upon successful execution of API. |
| reportName | Displays report name. It is generated upon successful execution of API. |
| reportType | Displays the report type as Reviewer Mapping . |
| reportDate | Displays the date of report generation after successful execution of API. |
| reportStatus | Displays report status. For more information on statuses, See Report Status API .. |
| info | Displays a message if the report request has queued successfully or not. |
| newReportInstanceQueued | Specifies whether a new report generation request has been submitted or not. The Rate Limiting feature restricts submission of multiple requests with identical input parameters if attempted within one minute. |
| It returns the following values: | |
| True : The value is shown as True , if the new report request has been queued successfully. | |
| False : The value is shown as False , if the input parameters of the current request are identical to the parameters of the already submitted request within one minute , a new report will not be queued. As a result, the details of the existing report request are returned. | |
| reportStatusLocation | Displays a URL with report ID. |
| To view the status of this report, use the same URL. | |
| reportDataLocation | Displays a URL for the location of report data. |
| To access the report data, use the same URL. |
-
Call the ReportStatus API to get the status of the ReviewerMappingAsync API report. See Report Status API.
-
Once the report is ready, call the ReviewerMapping API to get the report data from the asynchronous API. See Reviewer Mapping API.
Related information