Domain Types

Returns domain types matching the given search criteria.

get

Returns domain types 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 domain types satisfy all constraints that are specified in this search criteria. By default a result containing 1000 domain types 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 Domain Type to search for.

nameMatchModestring · enumOptional

The match mode used to compare name. The search is case-insensitive.

Default: ANYWHEREPossible values:

parentIdstring · uuidOptional

The ID of the parent to find the Domain Types in.

excludeMetabooleanOptional

Whether the meta Domain Types should be excluded from search or not.

Default: true

topLevelbooleanOptional

Whether only top level Domain Types should be searched or not.

Default: false

Responses

200

The paged response of found Domain types.

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/domainTypes

HTTPcURLJavaScriptPython

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

200

The paged response of found Domain types.

{
  "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.",
      "publicId": "\"MyDomainType_C\"",
      "parent": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Adds a new domain type.

post

Adds a new domain type.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Body

application/json

idstring · uuidOptional

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

publicIdstring · min: 1 · max: 260Optional

The public id that will be assigned to the new Domain Type. It must be unique within all Domain Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

namestring · min: 1 · max: 255Required

The name of the new Domain Type. Should be unique within all Domain Types.

descriptionstring · max: 4000Optional

The description of the new Domain Type.

parentIdstring · uuidOptional

The ID of the parent of the new Domain Type.

Responses

201

Domain type 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.

publicIdstringOptional

The public id of the domain type.

Example: "MyDomainType_C"

400

A domain type with the given ID already exists

post/domainTypes

HTTPcURLJavaScriptPython

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

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

{
  "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.",
  "publicId": "\"MyDomainType_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}

Adds multiple new domain types.

post

Adds multiple new domain types.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodyobject · AddDomainTypeRequest[]

application/json

idstring · uuidOptional

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

publicIdstring · min: 1 · max: 260Optional

The public id that will be assigned to the new Domain Type. It must be unique within all Domain Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

namestring · min: 1 · max: 255Required

The name of the new Domain Type. Should be unique within all Domain Types.

descriptionstring · max: 4000Optional

The description of the new Domain Type.

parentIdstring · uuidOptional

The ID of the parent of the new Domain Type.

Responses

201

Domain types 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.

publicIdstringOptional

The public id of the domain type.

Example: "MyDomainType_C"

post/domainTypes/bulk

HTTPcURLJavaScriptPython

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

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

201

Domain types 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.",
    "publicId": "\"MyDomainType_C\"",
    "parent": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    }
  }
]

Removes multiple domain types.

delete

Removes multiple domain types identified by the UUIDs passed as parameter.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodystring · uuid[]

application/json

string · uuid[]Optional

Responses

default

default response

application/json

delete/domainTypes/bulk

HTTPcURLJavaScriptPython

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

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

default

default response

Changes the domain types.

patch

Changes the domain types with the information present in the request.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Bodyobject · ChangeDomainTypeRequest[]

application/json

idstring · uuidRequired

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

publicIdstring · min: 1 · max: 260Optional

The new public id for the Domain Type. It must be unique within all Domain Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

namestring · min: 1 · max: 255Optional

The new name for the Domain Type.

descriptionstring · max: 4000Optional

The new description for the Domain Type.

parentIdstring · uuidOptional

The ID of the new parent for the Domain Type.

Responses

200

Domain types 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.

publicIdstringOptional

The public id of the domain type.

Example: "MyDomainType_C"

patch/domainTypes/bulk

HTTPcURLJavaScriptPython

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

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

200

Domain types 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.",
    "publicId": "\"MyDomainType_C\"",
    "parent": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    }
  }
]

Returns domain type identified by given UUID.

get

Returns domain type identified by given UUID.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

domainTypeIdstring · uuidRequired

the unique identifier of the domain type

Responses

200

Domain Type 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.

publicIdstringOptional

The public id of the domain type.

Example: "MyDomainType_C"

404

Domain Type not found.

get/domainTypes/{domainTypeId}

HTTPcURLJavaScriptPython

GET /rest/2.0/domainTypes/{domainTypeId} 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.",
  "publicId": "\"MyDomainType_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}

Removes domain type identified by given UUID.

delete

Removes domain type identified by given UUID.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

domainTypeIdstring · uuidRequired

the unique identifier of the domain type

Responses

default

default response

application/json

delete/domainTypes/{domainTypeId}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/domainTypes/{domainTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

default response

Changes the domain type.

patch

Changes the domain type with the information 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

domainTypeIdstring · uuidRequired

the unique identifier of the domain type

Body

application/json

idstring · uuidRequired

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

publicIdstring · min: 1 · max: 260Optional

The new public id for the Domain Type. It must be unique within all Domain Types. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

namestring · min: 1 · max: 255Optional

The new name for the Domain Type.

descriptionstring · max: 4000Optional

The new description for the Domain Type.

parentIdstring · uuidOptional

The ID of the new parent for the Domain Type.

Responses

200

Domain type 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.

publicIdstringOptional

The public id of the domain type.

Example: "MyDomainType_C"

patch/domainTypes/{domainTypeId}

HTTPcURLJavaScriptPython

PATCH /rest/2.0/domainTypes/{domainTypeId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 148

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

200

Domain type 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.",
  "publicId": "\"MyDomainType_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}

Returns sub domain types matching the given search criteria.

get

Returns sub domain types matching the given search criteria.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

domainTypeIdstring · uuidRequired

the unique identifier of the domain type

Query parameters

includeParentbooleanOptional

Whether parent Domain Type should be included in the search result.

Responses

200

The paged response of found sub Domain types.

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/domainTypes/{domainTypeId}/subTypes

HTTPcURLJavaScriptPython

GET /rest/2.0/domainTypes/{domainTypeId}/subTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

The paged response of found sub Domain types.

{
  "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.",
      "publicId": "\"MyDomainType_C\"",
      "parent": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Get the domain type by public id

get

Returns the domain type identified by the given public id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

publicIdstringRequired

The public identifier of the domain type

Responses

200

Domain type 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.

publicIdstringOptional

The public id of the domain type.

Example: "MyDomainType_C"

404

Domain type not found.

get/domainTypes/publicId/{publicId}

HTTPcURLJavaScriptPython

GET /rest/2.0/domainTypes/publicId/{publicId} 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.",
  "publicId": "\"MyDomainType_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  }
}