2.2 Specifications common to APIs

The following shows the specifications common to all APIs. Note that the API functions provided by JP1/AO follow the REST (Representational State Transfer) architecture style.

This section describes the specifications that are specific to JP1/AO. The specifications conform to HTTP1.1 unless otherwise described.

Note that API in this section refers to the API provided by JP1/AO, and user programs that use APIs (such as a portal program) are generally called API clients.

Organization of this section

• 2.2.1 Communication protocol

• 2.2.2 Security and authentication

• 2.2.3 Input/output format

• 2.2.4 Namespace

• 2.2.5 Request format

• 2.2.6 Response format

• 2.2.7 Supported methods

• 2.2.8 Domain names and resources that can be managed by APIs

• 2.2.9 Query parameter

• 2.2.10 Request header

• 2.2.11 Using HQL standard

• 2.2.12 Domain object format

• 2.2.13 Response header

• 2.2.14 Members of resources

• 2.2.15 Members to be returned for APIs that execute JP1/AO operations

• 2.2.16 Members to be returned for API functions that acquire executable operations

• 2.2.17 Status code

• 2.2.18 Error information

To Page Top