GET

Get status type details

Get details on a given status.

Request

Path parameters

id

string

Required

Responses

Returns status details.

application/json

StatusTypeEntry
GET/assets/1.0/config/statustype/{id}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/config/statustype/{id}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "id": 2154, "name": "<string>", "description": "<string>", "category": 2154, "objectSchemaId": 2154 }
PUT

Update status type

Update an existing status type.

Request

Path parameters

id

string

Required

Request bodyapplication/json

The status type to update

id

integer

name

string

description

string

category

integer

objectSchemaId

integer

Responses

Returns the updated status type.

application/json

StatusTypeEntry
PUT/assets/1.0/config/statustype/{id}
1 2 3 4 5 6 7 8 9 10 11 curl --request PUT \ --url 'http://{baseurl}/rest/assets/1.0/config/statustype/{id}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 2154, "name": "<string>", "description": "<string>", "category": 2154, "objectSchemaId": 2154 }'
200Response
1 2 3 4 5 6 7 { "id": 2154, "name": "<string>", "description": "<string>", "category": 2154, "objectSchemaId": 2154 }
DEL

Delete status type

Delete a single status type.

Request

Path parameters

id

string

Required

Responses

The status type was deleted.

application/json

any

DEL/assets/1.0/config/statustype/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/assets/1.0/config/statustype/{id}' \ --header 'Accept: application/json'
GET

Find status types

Find status types for a given object schema ID.

Request

Query parameters

objectSchemaId

string

Responses

Returns a list of status types for the request object schema.

application/json

StatusTypeEntry
GET/assets/1.0/config/statustype
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/assets/1.0/config/statustype' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "id": 2154, "name": "<string>", "description": "<string>", "category": 2154, "objectSchemaId": 2154 }
POST

Store status type

Store a new status type.

Request

Request bodyapplication/json

The status type to store

id

integer

name

string

description

string

category

integer

objectSchemaId

integer

Responses

Returns the new status type.

application/json

StatusTypeEntry
POST/assets/1.0/config/statustype
1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'http://{baseurl}/rest/assets/1.0/config/statustype' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 2154, "name": "<string>", "description": "<string>", "category": 2154, "objectSchemaId": 2154 }'
200Response
1 2 3 4 5 6 7 { "id": 2154, "name": "<string>", "description": "<string>", "category": 2154, "objectSchemaId": 2154 }

Rate this page: