6.4.1 Details of the values to be specified
The following describes details of the values that are to be specified as a request.
- Method
-
Specify the method of the request. The following methods are supported by the APIs:
-
GET
-
POST
-
- Application identifier
-
Specify the identifier of the application that provides the API. Specify the fixed value ajs.
- Component identifier
-
Specify the identifier of the component. Specify the fixed value api.
- API version
-
This version differs depending on the API. See the description for each API.
- Domain
-
Specify the domain for which the API is operated. The following table lists and describes the domain and resources that can be managed by an API.
Table 6‒6: Domain and resources that can be managed by an API Domain
Resource identifier
Description of the resource identifier
objects
statuses
Resource for status monitoring
definitions
Resource for unit definition
- Resource identifier
-
Specify the identifier of the resource on which the API operates. For details about the resources that can be managed by an API, see Table 6-6.
- Value for uniquely identifying a resource and an operation on the resource
-
If necessary, specify the value that uniquely identifies the resource and the action type. For details, see the description for each API.
- Query string
-
If necessary, specify the query string by adding a question mark (?) at the end of the URI, as follows:
parameter-name=value
If there are multiple parameters, specify as follows, by delimiting the parameters by an ampersand (&):
parameter-name=value¶meter-name=value
- Protocol version
-
Specify the fixed value HTTP/1.1.
- Request header
-
Specify the request header in the format of request-header:value. If you specify multiple request headers, delimit them by a line feed character. The following table lists and describes the request headers that can be specified.
Table 6‒7: List of request headers Request Header
Description
Required?
Host
Specify the host information in the following format:
host:port
For host, specify the host name or IP address of the Web Console server.
For port, specify the port number. The default port number is 22252.
Y
X-AJS-Authorization
Specify the authentication information. For details, see 6.2 Authentication when using an API.
Y
Content-Type
Specify the data type of the request message body. Specify the fixed value application/json.
--
Accept-Language
Specify the language code used for the message body of the response to be issued by JP1/AJS3 - Web Console.
If Accept-Language is not specified, the default language code of the system is used.
You can specify the following language codes:
-
ja: Japanese
-
en: English
-
zh: Chinese
Note that only the message body of the messages that begin with KNAK and are issued by JP1/AJS3 - Web Console can be controlled by Accept-Language. The language code for the unit name, comment, execution result details, and inherit result that are contained in the message cannot be controlled.
--
- Legend:
-
Y: Required
--: Optional
-
- Message body
-
Specify the input information in JSON format. Use UTF-8 for the character encoding.