Get a specific object

Displays a specific object.

URL : /api2/[object name]/{id}

Method : GET

Auth required : NO

Permissions required : None

Success Responses

Code : 200 OK

Get a list of objects

Get information related to a list of objects.

URL : /api2/[object name]

Method : GET

Auth required : NO

Permissions required : None

Success Responses

Code : 200 OK

Content : Display a list of objects.

Update a field

Update a field using the specified ID.

URL : /api2/[object name]/{id}

Method : POST

Success Response

Condition : Successful update.

Code : 200 SUCCESS

Error Responses

Condition : Missing entity.

Code : 404 NOT FOUND

Content.

{
    "statusCode": 404,
    "error": "Not Found",
    "message": "Not Found"
}

Execute a command

Execute a command using the specified ID.

URL : /api2/[object name]/[command]/{id}

Method : POST

Success Response

Condition : Successful update.

Code : 200 SUCCESS

Error Responses

Condition : Missing entity.

Code : 404 NOT FOUND

Content

{
    "statusCode": 404,
    "error": "Not Found",
    "message": "Not Found"
}

Back to X2-SERIES API Home