Attributes

Find attributes

get

Returns attributes 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 attributes satisfy all constraints that are specified in this search criteria. By default a result containing 1000 attributes is returned.

For fetching large numbers of attributes or attributes of multiple assets consider using the async methods of Output Module REST API instead, which allow getting attributes for multiple assets in one call and eliminate the risk of timing out. Additionally, consider the CSV endpoint of the Output Module REST API for particularly large result sets, as it's more memory efficient.

Authorizations

AuthorizationstringRequired

Query parameters

offsetinteger · int32OptionalDeprecated

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0. Cursor should be preferred over offset for better performance and stable results. It is forbidden to use both in the same request.

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 · int32OptionalDeprecated

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped. For cursor pagination this parameter is ignored and count is skipped.

Default: -1

cursorstringOptional

Cursor for the current page of results. To retrieve the first page with cursor pagination you need to pass this parameter with an empty value (must be non-null). For the next pages, the value must be taken from the response (nextCursor property).

typeIdsstring · uuid[]Optional

The list of IDs of the attribute types the found attributes should have, or null or empty if no type filtering should be applied.

assetIdstring · uuidOptional

The ID of the asset to find the attributes in, or null if no asset filtering should be applied.

sortOrderstring · enumOptional

The sorting order.

Default: DESCPossible values:

sortFieldstring · enumRequired

The field on which the results are sorted.

Default: LAST_MODIFIEDPossible values:

typePublicIdsstring[]Optional

The list of public IDs of the attribute types the found attributes should have, or null or empty if no type filtering should be applied.

Responses

200

OK - The request has succeeded.

application/json

totalinteger · int64Optional

The total number of results. -1 when cursor pagination is used.

Example: 1000

offsetinteger · int64Optional

The offset for the results. -1 when cursor pagination is used.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

nextCursorstringOptional

Cursor value to be passed in next request to retrieve next page of results. Not returned on last page or when offset pagination is used.

401

Unauthorized - Authentication has failed or has not been provided.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

get/attributes

GET /rest/2.0/attributes?sortField=LAST_MODIFIED HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "attributeDiscriminator": "text",
      "asset": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "value": {},
      "type": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "createdOn": 1475503010320,
      "lastModifiedOn": 1476703764163,
      "system": true,
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "nextCursor": "text"
}

Add attribute

post

Adds a new attribute to an asset.

Authorizations

AuthorizationstringRequired

Body

assetIdstring · uuidRequired

The ID of the asset this attribute should belong to.

typeIdstring · uuidOptional

The ID of the attribute type for the new attribute.

typePublicIdstringOptional

The public ID of the attribute type for the new attribute.

valueobjectRequired

The value of this attribute. Expected type of the value depends on the type of the attribute.
Following list presents type of the value depending on the kind of the attribute

• kind: Numeric -> value type: number or string
  
• kind: Script -> value type: string
  
• kind: Single Value List -> value type: string
  
• kind: Date -> value type: number or string
  
• kind: String -> value type: string
  
• kind: Boolean -> value type: boolean or string
  
• kind: Multi Value List -> value type: array of strings
  

Responses

201

Created - The request has been fulfilled and resulted in a new resource being created.

application/json

The list of attributes corresponding to the complex relation.

attributeDiscriminatorstringOptional

valueobjectOptional

resourceTypestring · enumOptionalDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

createdBystring · uuidOptional

The id of the user that created this resource.

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

lastModifiedBystring · uuidOptional

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

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

createdOninteger · int64Optional

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

Example: 1475503010320

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.

idstring · uuidOptional

The id of the represented object (entity).

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

post/attributes

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

{
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "typeId": "123e4567-e89b-12d3-a456-426614174000",
  "typePublicId": "text",
  "value": {}
}

{
  "attributeDiscriminator": "text",
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "value": {},
  "type": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "createdOn": 1475503010320,
  "lastModifiedOn": 1476703764163,
  "system": true,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Add attributes

post

Adds multiple attributes.

Authorizations

AuthorizationstringRequired

Bodyobject · AddAttributeRequest[]

assetIdstring · uuidRequired

The ID of the asset this attribute should belong to.

typeIdstring · uuidOptional

The ID of the attribute type for the new attribute.

typePublicIdstringOptional

The public ID of the attribute type for the new attribute.

valueobjectRequired

The value of this attribute. Expected type of the value depends on the type of the attribute.
Following list presents type of the value depending on the kind of the attribute

• kind: Numeric -> value type: number or string
  
• kind: Script -> value type: string
  
• kind: Single Value List -> value type: string
  
• kind: Date -> value type: number or string
  
• kind: String -> value type: string
  
• kind: Boolean -> value type: boolean or string
  
• kind: Multi Value List -> value type: array of strings
  

Responses

201

Created - The request has been fulfilled and resulted in a new resource being created.

application/json

The list of attributes corresponding to the complex relation.

attributeDiscriminatorstringOptional

valueobjectOptional

resourceTypestring · enumOptionalDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

createdBystring · uuidOptional

The id of the user that created this resource.

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

lastModifiedBystring · uuidOptional

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

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

createdOninteger · int64Optional

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

Example: 1475503010320

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.

idstring · uuidOptional

The id of the represented object (entity).

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

post/attributes/bulk

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

[
  {
    "assetId": "123e4567-e89b-12d3-a456-426614174000",
    "typeId": "123e4567-e89b-12d3-a456-426614174000",
    "typePublicId": "text",
    "value": {}
  }
]

[
  {
    "attributeDiscriminator": "text",
    "asset": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "value": {},
    "type": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "createdOn": 1475503010320,
    "lastModifiedOn": 1476703764163,
    "system": true,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Remove attributes

delete

Removes the attributes identified by given ids.

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

204

No Content - The server has fulfilled the request but does not need to return an entity-body.

No content

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

delete/attributes/bulk

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

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

No content

Change attributes

patch

Changes multiple attributes 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

AuthorizationstringRequired

Bodyobject · ChangeAttributeRequest[]

idstring · uuidRequired

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

valueobjectRequired

The value of this attribute. Expected type of the value depends on the type of the attribute.
Following list presents type of the value depending on the kind of the attribute

• kind: Numeric -> value type: number or string
  
• kind: Script -> value type: string
  
• kind: Single Value List -> value type: string
  
• kind: Date -> value type: number or string
  
• kind: String -> value type: string
  
• kind: Boolean -> value type: boolean or string
  
• kind: Multi Value List -> value type: array of strings
  

Responses

200

OK - The request has succeeded.

application/json

The list of attributes corresponding to the complex relation.

attributeDiscriminatorstringOptional

valueobjectOptional

resourceTypestring · enumOptionalDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

createdBystring · uuidOptional

The id of the user that created this resource.

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

lastModifiedBystring · uuidOptional

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

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

createdOninteger · int64Optional

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

Example: 1475503010320

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.

idstring · uuidOptional

The id of the represented object (entity).

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

patch/attributes/bulk

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

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

[
  {
    "attributeDiscriminator": "text",
    "asset": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "value": {},
    "type": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "createdOn": 1475503010320,
    "lastModifiedOn": 1476703764163,
    "system": true,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Get attribute

get

Returns the attribute identified by given id.

Authorizations

AuthorizationstringRequired

Path parameters

attributeIdstring · uuidRequired

the id of the attribute

Responses

200

OK - The request has succeeded.

application/json

The list of attributes corresponding to the complex relation.

attributeDiscriminatorstringOptional

valueobjectOptional

resourceTypestring · enumOptionalDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

createdBystring · uuidOptional

The id of the user that created this resource.

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

lastModifiedBystring · uuidOptional

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

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

createdOninteger · int64Optional

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

Example: 1475503010320

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.

idstring · uuidOptional

The id of the represented object (entity).

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

get/attributes/{attributeId}

GET /rest/2.0/attributes/{attributeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "attributeDiscriminator": "text",
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "value": {},
  "type": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "createdOn": 1475503010320,
  "lastModifiedOn": 1476703764163,
  "system": true,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Remove attribute

delete

Removes the attribute identified by given id.

Authorizations

AuthorizationstringRequired

Path parameters

attributeIdstring · uuidRequired

the id of the attribute

Responses

204

No Content - The server has fulfilled the request but does not need to return an entity-body.

No content

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

delete/attributes/{attributeId}

DELETE /rest/2.0/attributes/{attributeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Change attribute

patch

Changes the attribute 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

AuthorizationstringRequired

Path parameters

attributeIdstring · uuidRequired

the id of the attribute

Body

idstring · uuidRequired

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

valueobjectRequired

The value of this attribute. Expected type of the value depends on the type of the attribute.
Following list presents type of the value depending on the kind of the attribute

• kind: Numeric -> value type: number or string
  
• kind: Script -> value type: string
  
• kind: Single Value List -> value type: string
  
• kind: Date -> value type: number or string
  
• kind: String -> value type: string
  
• kind: Boolean -> value type: boolean or string
  
• kind: Multi Value List -> value type: array of strings
  

Responses

200

OK - The request has succeeded.

application/json

The list of attributes corresponding to the complex relation.

attributeDiscriminatorstringOptional

valueobjectOptional

resourceTypestring · enumOptionalDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. To stay backwards compatible while still allowing new types of resources to be introduced, a resource discriminator property (of type String) has been added to the subtypes of Resource where it adds value, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. A discriminator is only added on subtypes whose declared return type can represent more than one kind of resource; it is omitted where the return type can only ever be a single kind, as it would then always hold the same value and carry no additional information. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

createdBystring · uuidOptional

The id of the user that created this resource.

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

lastModifiedBystring · uuidOptional

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

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

createdOninteger · int64Optional

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

Example: 1475503010320

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.

idstring · uuidOptional

The id of the represented object (entity).

400

Bad Request - Request data is malformed or illegal. The request body will contain additional information.

401

Unauthorized - Authentication has failed or has not been provided.

403

Forbidden - Insufficient permissions to perform the requested operation.

404

Not Found - One of the requested resources could not be found or the requested URI is invalid.

500

Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.

patch/attributes/{attributeId}

PATCH /rest/2.0/attributes/{attributeId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "value": {}
}

{
  "attributeDiscriminator": "text",
  "asset": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "value": {},
  "type": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "createdOn": 1475503010320,
  "lastModifiedOn": 1476703764163,
  "system": true,
  "id": "123e4567-e89b-12d3-a456-426614174000"
}