Statuses

Returns statuses matching the given search criteria.

get

Returns statuses matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. The returned statuses satisfy all constraints that are specified in this search criteria. By default a result containing 1000 statuses is returned.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

namestringOptional

The name of the Status to search for.

nameMatchModestring · enumOptional

The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

Default: ANYWHEREPossible values:

descriptionstringOptional

The description of the Status to search for.

Responses

200

The paged response with found Status information.

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/statuses

HTTPcURLJavaScriptPython

GET /rest/2.0/statuses HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response with found Status information.

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name",
      "description": "Sample descripion of the resource."
    }
  ]
}

Adds a new Status.

post

Adds a new Status.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Body

application/json

idstring · uuidOptional

The ID of the new Status. Should be unique within all Statuses.
It should have a format of universally unique identifier (UUID) and should not start with 00000000-0000-0000- which is a reserved prefix.

namestring · min: 1 · max: 255Required

The name of the new Status. Should be unique within all Statuses.

descriptionstring · max: 4000Optional

The description of the new Status.

Responses

201

Status successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

400

A status with the given ID already exists

post/statuses

HTTPcURLJavaScriptPython

POST /rest/2.0/statuses HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource."
}

Adds multiple statuses in one go.

post

Adds multiple statuses in one go.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodyobject · AddStatusRequest[]

application/json

idstring · uuidOptional

The ID of the new Status. Should be unique within all Statuses.
It should have a format of universally unique identifier (UUID) and should not start with 00000000-0000-0000- which is a reserved prefix.

namestring · min: 1 · max: 255Required

The name of the new Status. Should be unique within all Statuses.

descriptionstring · max: 4000Optional

The description of the new Status.

Responses

201

Statuses successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

post/statuses/bulk

HTTPcURLJavaScriptPython

POST /rest/2.0/statuses/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 82

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text"
  }
]

201

Statuses successfully added.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name",
    "description": "Sample descripion of the resource."
  }
]

Removes multiple statuses.

delete

Removes multiple statuses.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

200

Statuses removed.

No content

delete/statuses/bulk

HTTPcURLJavaScriptPython

DELETE /rest/2.0/statuses/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

200

Statuses removed.

No content

Changes multiple statuses in one go.

patch

Changes multiple statuses in one go.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodyobject · ChangeStatusRequest[]

application/json

idstring · uuidRequired

The ID of the Status to be changed. Silently ignored if the ID is provided as path parameter of the request.

namestring · min: 1 · max: 255Optional

The new name for the Status.

descriptionstring · max: 4000Optional

The new description for the Status.

Responses

200

Statuses were successfully changed.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

patch/statuses/bulk

HTTPcURLJavaScriptPython

PATCH /rest/2.0/statuses/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 82

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text"
  }
]

200

Statuses were successfully changed.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name",
    "description": "Sample descripion of the resource."
  }
]

Returns the Status identified by the given id.

get

Returns the Status identified by the given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

statusIdstring · uuidRequired

The id of the Status

Responses

200

Status found.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

404

Status not found.

get/statuses/{statusId}

HTTPcURLJavaScriptPython

GET /rest/2.0/statuses/{statusId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource."
}

Removes the Status identified by the given id.

delete

Removes the Status identified by the given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

statusIdstring · uuidRequired

The id of the Status.

Responses

200

Status removed.

No content

404

Status not found.

delete/statuses/{statusId}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/statuses/{statusId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Changes the status with the information that is present in the request.

patch

Changes the status with the information that is present in the request. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

statusIdstring · uuidRequired

The unique identifier of the status.

Body

application/json

idstring · uuidRequired

The ID of the Status to be changed. Silently ignored if the ID is provided as path parameter of the request.

namestring · min: 1 · max: 255Optional

The new name for the Status.

descriptionstring · max: 4000Optional

The new description for the Status.

Responses

200

Statuses were successfully changed.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

patch/statuses/{statusId}

HTTPcURLJavaScriptPython

PATCH /rest/2.0/statuses/{statusId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text"
}

200

Statuses were successfully changed.

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource."
}

Returns the Status identified by the given name.

get

Returns the Status identified by the given name.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

statusNamestringRequired

The name that identifies the Status.

Responses

200

Status found.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

404

Status not found.

get/statuses/name/{statusName}

HTTPcURLJavaScriptPython

GET /rest/2.0/statuses/name/{statusName} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource."
}