2.3 API description format
The items below provide descriptions for individual APIs. Note that some items might not be described for some APIs.
- Function
Describes the function of an API.
- Execution permissions
Indicates the permissions and roles that are required to execute an API.
- API version
Indicates the version of an API.
- Request format
Describes the request format for requesting the use of an API.
- Status code
Describes the status code after you execute an API by using the HTTP or HTTPS protocol. For details about the status code when an error occurs before an API is executed, see 2.2.17 Status code.
- Response schema
Describes schema information of the response that is returned when an API is successfully completed.
- Usage example
Provides examples of the request for the use of API, and its response.
Note that the HTTP protocol is used in the examples. If the HTTPS protocol is used, replace HTTP with HTTPS when you read the description. In addition, depending on a version of JP1/AO, some parameters of the usage example may be different. Therefore, according to the mention of the request format and the response schema, replace the usage example when you read it.