Troubleshooting the APIs
When troubleshooting the APIs, it is helpful to review the log files, the HTTP status codes, and the API resource map.
Using the log file for API troubleshooting
Reviewing the log files can be helpful when troubleshooting the Automator API.
The public log (logs/Server*.log) contains the error message when an error occurs.
HTTP status codes
The API uses the following standard HTTP status codes to convey the results of the REST operations:
Status code | HTTP name | Description |
200 | OK |
Success. A request has processed appropriately. |
201 | Created |
Return this code instead of 200 if a resource creation processing is successful. |
204 | No content | Request was successful, but if the response to return does not exist, return this code instead of 200. |
303 | See other | Request was processed successfully using another URI.
Return this code instead of 200. |
400 | Bad request | Request contents missing or not valid. |
401 | Unauthorized | Authentication/authorization credentials are not valid. Notify user that authentication is required to access a resource through the WWW-authenticate header. If the request which already contains the authorization header is being performed, show that the authentication credentials were refused. |
403 | Forbidden | This user is not allowed to perform this request. If there is no update privilege, delete the related resource. |
404 | Not found | Either the resource, the operation, or the Read privilege to the resource is missing. |
405 | Method not allowed | Requested HTTP verb not allowed on this resource. |
406 | Not acceptable | Response format is not supported. |
409 |
Conflict |
Request cannot be finished since it conflicts with the current data existing in the server. |
412 | Precondition failed |
The request was not received in a certain order and has failed a precondition. |
415 | Unsupported media type | Request format is not supported. |
500 | Server-side error | Processing error returned by the server. |
API resource map
The following table gives a map of the API resources according to their GUI location. The table does not represent all available resources.
GUI | ||||
Tab | Window | Operation/Condition | Filter by Query | Resource |
Service | Service List | Acquire service list. | N/A | Invoke the GET method of Services and acquire service list. |
serviceGroupID |
| |||
Edit Service | Edit the service. | N/A |
Update the service
| |
N/A |
Updated the property
| |||
Delete Service | Delete the service. | N/A |
| |
Submit Service | Submit the service to run immediately. | N/A |
To change the interval to immediate/scheduled/periodical, change the scheduleType or taskType. | |
Task | Task list | Acquire task list. | N/A | Invoke the GET method of Task and acquire task list. |
serviceID |
| |||
serviceGroupID |
| |||
scheduleID |
| |||
Display task details dialog box. | N/A | Acquire task summary
| ||
N/A | Acquire task property
| |||
Suspend the schedule. | N/A |
| ||
Cancel the schedule. | N/A |
) Edit the return value of 2) and invoke the POST method of Services/<instanceID>/actions/cancel/invoke. | ||
Resume the schedule. | N/A |
| ||
Resubmit the task. | N/A |
| ||
Archive the task. | N/A |
| ||
Stop the task. | N/A |
| ||
Task History List | Acquire the task history. | N/A | Invoke the GET method of TaskHistory and acquire task history list. | |
start | Specify the start date and time (start) as a query, invoke the GET method of TaskHistory, and acquire a task history list. | |||
end | Specify the end date and time (end) as a query, invoke the GET method of TaskHistory, and acquire task history list. | |||
serviceGroupID |
| |||
Delete Task History | Delete the task history. | N/A |
| |
Administration | Create Resource Group | Create a resource group. | N/A | Invoke the GET method of ServiceGroup and acquire resource group list. |
role | Specify the arbitrary role as a query, invoke the GET method of ServiceGroup, and acquire resource group list. | |||
userGroupID | No method is available to identify the userGroupID. | |||
Edit Resource Group | Edit the resource group. | N/A |
| |
Delete Resource Group | Delete the resource group. | N/A |
| |
Edit User Group/Add Resource Group | Edit the resource group to the user group. | N/A |
| |
Edit User Group/Edit Role of Resource Group | Edit the resource group to the user group. | N/A |
| |
Edit User Group/Delete Resource Group | Remove the resource group from the user group. | N/A |
|