2. Detailed API reference information

This section describes each API function in detail.
The API functions are described separately in the following lists.

  • Standard API functions:
    These are used for user and group management, checking YAML file registration status, etc.
    You cannot customize these APIs.
  • Custom API functions:
    These are used for ticket management.
    When customizing the Ticket screen, the API must also be customized.



NoteNote

  • Fields marked "(Reserved Field)" in the request body and response description are reserved fields.
  • Do not refer to the value of the reserved fields in the response.
  • The reserved fields in the request body of the POST method should be set to the values described in the field descriptions.
  • Set the request body of the PUT method to the response body obtained by executing the GET method, changing only the fields that are supported for updating as described in the API function explanation.
  • The status codes returned by the API are listed in "(Table) Status codes returned by the API".


(Table) Status codes returned by the API

Status code Description
400 When there is incorrect JSON syntax in the request body
When the request body is different from the object being requested
When there is an error in the value specified in the request body
401 When the Ops I token has an invalid value
403 When the user is not given permission to execute the API request
When the API path is incorrectly specified
Other than the above This differs between each API function.
See "Standard API functions" and "Custom API functions".
If an error occurs in the execution of an API request, the error is returned in the response format (JSON) described. However, depending on the error that occurs, a response format (such as HTML) or response content not described might be returned. In this case, review the request with reference to the status code and message.

Chapter structure

2.1 Standard API functions
2.2 Custom API functions