2.2.8 Domain names and resources that can be managed by APIs
Specify the domain name for the resource to be operated by the API to be executed, and a resource supported by JP1/AO.
Note that, for XML requests and response data, the resource names for the objects domain are replaced with singular names.
The following table describes the list of domain names and resources that can be managed by APIs.
Domain name |
Resource |
Description of the resource |
---|---|---|
objects |
ServiceTemplates |
Service templates |
Services |
Services registered in JP1/AO |
|
Schedules |
Schedules set for tasks |
|
Tasks |
Tasks created by execution of services |
|
FlowSteps |
Steps included in a task |
|
TaskLogs |
Task logs |
|
PropertyDefinitions |
Definitions of service template properties or service share properties |
|
PropertyInformations |
Property definitions and property values |
|
PropertyValues |
Values of service properties, schedule properties, task properties, and service share properties |
|
PropertyGroups |
Property groups |
|
ServiceGroups |
Service groups |
|
TagGroups |
Tag groups |
|
Tags |
Tags |
|
user |
UserInfo# |
Information about a user authenticated by JP1/AO |
configuration |
VersionInfo# |
Information about JP1/AO and API versions |
- #
This resource name is not specified for a request because it is included in a response. For details about how to specify a request, see Request format in the description of each API.