Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

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.
NoteThe table gives general descriptions of each status code. Specific information and descriptions might vary depending on the URI. For specific status code descriptions, see the return codes provided for each resource URI.

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
  1. Invoke the GET method of ServiceGroups and acquire resource group list.
  2. Identify the target instanceID from resource group list, specify it as a query, and invoke the GET method of Services.
Edit Service Edit the service. N/A

Update the service

  1. Invoke the GET method of Services and acquire service list.
  2. Identify the target instanceID from service list and invoke the GET method of Services/<instanceID>.
  3. Edit the Service object of the response of 2).
  4. Specify the object edited at 3) as an argument, and invoke the PUT method of Services/<instanceID>.
N/A

Updated the property

  1. Invoke the GET method of Services and acquire service list.
  2. Identify the target serviceID from service list, invoke the GET method of PropertyValues?serviceID= <serviceID>, and acquire a list of PropertyValues.
  3. Identify and edit the target instanceID from the list of PropertyValues.
  4. Specify the object edited at 3) as an argument, and invoke the PUT method of PropertyValues/<instanceID>.
Delete Service Delete the service. N/A
  1. Invoke the GET method of Services and acquire service list.
  2. Identify the target instanceID from service list and invoke the DELETE method of Services/<instanceID>.
Submit Service Submit the service to run immediately. N/A
  1. Invoke the GET method of Services and acquire service list.
  2. Identify the target instanceID from service list and invoke the GET method of Services/<instanceID>/actions/submit.
  3. Change the schedule and property of a response of 2) accordingly.
  4. Specify the object edited at 3) as an argument, and invoke the POST method of Services/<instanceID>/actions/submit/invoke.

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
  1. Invoke the GET method of Service and acquire service list.
  2. Identify the target instanceID from a service list, specify it as a query, and invoke the GET method of Task.
serviceGroupID
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, specify it as a query, and invoke the GET method of Task.
scheduleID
  1. Invoke the GET method of Schedule and acquire schedule list.
  2. Identify the target instanceID from schedule list, specify it as a query, and invoke the GET method of Task.
Display task details dialog box. N/A Acquire task summary
  1. Invoke the GET method of Task and acquire task list.
  2. Identify the target instanceID from task list and invoke the GET method of Tasks/<instanceID>.
N/A Acquire task property
  1. Invoke the GET method of Task and acquire task list.
  2. Identify the target taskID from task list and invoke the GET method of PropertyValue?taskID=taskID.
Suspend the schedule. N/A
  1. Invoke the GET method of Task and acquire task list.
  2. Identify instanceID of the target schedule and invoke the GET method of Services/<instanceID>/actions/suspend.
  3. Edit the return value of 2) and invoke the POST method of Services/<instanceID>/actions/suspend/invoke.
Cancel the schedule. N/A
  1. Invoke the GET method of Task and acquire task list.
  2. Identify instanceID of the target schedule and invoke the GET method of Services/<instanceID>/actions/cancel.

) Edit the return value of 2) and invoke the POST method of Services/<instanceID>/actions/cancel/invoke.

Resume the schedule. N/A
  1. Invoke the GET method of Task and acquire task list.
  2. Identify instanceID of the target schedule and invoke the GET method of Services/<instanceID>/actions/resume.
  3. Edit the return value of 2) and invoke the POST method of Services/<instanceID>/actions/resume/invoke.
Resubmit the task. N/A
  1. Invoke the GET method of Task and acquire task list.
  2. Identify the target instanceID from task list and invoke the GET method of Tasks/<instanceID>/actions/resubmit.
  3. Edit the return value of 2) and invoke the POST method of Tasks/<instanceID>/actions/resubmit/invoke.
Archive the task. N/A
  1. Invoke the GET method of Task and acquire task list.
  2. Identify the target instanceID from task list and invoke the GET method of Tasks/<instanceID>/actions/archive.
  3. Edit the return value of 2) and invoke the POST method of Tasks/<instanceID>/actions/archive/invoke.
Stop the task. N/A
  1. Invoke the GET method of Task and acquire task list.
  2. Identify the target instanceID from task list and invoke the GET method of Tasks/<instanceID>/actions/stop.
  3. Edit the return value of 2) and invoke the POST method of Tasks/<instanceID>/actions/stop/invoke.
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
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, specify it as a query, and invoke the GET method of TaskHistory.
Delete Task History Delete the task history. N/A
  1. Invoke the GET method of TaskHistory and acquire task history list.
  2. Identify the target instanceID from task history list, and invoke the DELETE method of Tasks/<instanceID>.
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
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, and invoke the GET method of ServiceGroups/<instanceID>.
  3. Edit the ServiceGroup object of the response of 2).
  4. Specify the object edited at 3) as an argument, and invoke the PUT method of ServiceGroups/<instanceID>.
Delete Resource Group Delete the resource group. N/A
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, and invoke the DELETE method of ServiceGroups/<instanceID>.
Edit User Group/Add Resource Group Edit the resource group to the user group. N/A
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, and invoke the GET method of ServiceGroups/<instanceID>/actions/assign.
  3. Edit the assign object of the response of 2). Specify the user group name set as UserGroupName by confirming it on GUI.
  4. Specify the object edited at 3) as an argument, and invoke the POST method of ServiceGroups/<instanceID>/actions/assign/invoke.
Edit User Group/Edit Role of Resource Group Edit the resource group to the user group. N/A
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, and invoke the GET method of ServiceGroups/<instanceID>/actions/assign.
  3. Edit the assign object of the response of 2). Specify the user group name set as UserGroupName by confirming it on GUI.
  4. Specify the object edited at 3) as an argument, and invoke the POST method of ServiceGroups/<instanceID>/actions/assign/invoke.
Edit User Group/Delete Resource Group Remove the resource group from the user group. N/A
  1. Invoke the GET method of ServiceGroup and acquire resource group list.
  2. Identify the target instanceID from resource group list, and invoke the GET method of ServiceGroups/<instanceID>/actions/unassign.
  3. Edit the unassign object of the response of 2). Specify the user group name set as UserGroupName by confirming it on GUI.
  4. Specify the object edited at 3) as an argument, and invoke the POST method of ServiceGroups/<instanceID>/actions/unassign/invoke.