- URL:
- https://<root>/logs/errorreports/findErrorReportIds
- Methods:
POST- Version Introduced:
- 11.5
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The find operation allows administrators to search for error reports generated by a specific service, by specific service types, or by services located in a specific folder. If no parameter values are specified, this operation returns a list of all stored error reports.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | The ID of the service that the error report was generated for. Example |
(Optional) | The folder in which the service is located. If the service is located on the root folder, no value needs to be provided. Example |
(Optional) | The name of the service that the error report was generated for. |
(Optional) | The service type of the service that the error report was generated for. Example |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the find operation:
POST /<context>/admin/logs/errorreports/findErrorReportIds HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
serviceId=&folderName=&serviceName=&serviceType=MapServer&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response example
{
"filteredErrorReportIds": [
"b7ead586-35b9-43a7-9c08-d16dcc8e802f",
"a48a550b-bd21-4643-b0e6-87b8ceff2a15",
"31e842d8-85d7-4dbc-b4de-9bb3a6b03ae9",
"57d33cee-83c4-47f5-b223-f89436d649f6",
"3088f65e-1e7f-4d71-8244-fede72e303fe"
]
}