2.2.5 Request format

The following shows the request format required for the API to use the functions provided by JP1/AO.

Figure 2‒1: Request format (an example when the domain is objects)

The following table describes the components of the request format.

Table 2‒10: Components of the request format
Item		Description	See
Method		Specify an operation for the resource.	2.2.7 Supported methods
URL	API collection name	API collection^# name. Specify Automation as the fixed value.	--
	API version	Specify the API version to be used.	See API version in the description of each API.
	Domain name	Specify the domain name of the resource that you want to operate by executing the API function. This request format is used when the domain is `objects`.	2.2.8 Domain names and resources that can be managed by APIs
	Resource	The functions provided by JP1/AO are provided as API resources. Specify a resource according to the processing you want to execute.
Query parameter		By adding search conditions to the request, you can filter and sort output results in the response.	2.2.9 Query parameter
Protocol		Specify HTTP as the communication protocol used by the API. Specify HTTP even when you use HTTP as the communication protocol.	2.2.1 Communication protocol
Protocol version		Specify 1.1 as the version of the communication protocol used by the API.	2.2.1 Communication protocol
Request header	Host	Specify the host information.	2.2.10 Request header
	Accept	Specify the data format of the response.
	Accept-Language	Specify the language code for the response.
	User-Agent	Specify the software information of the API client.

For details and components of the request format, see Request format in the description of each API (differs depending on the API).