Tags

Get tag.

get

Returns the tag with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

tagIdstring · uuidRequired

The ID of the tag.

Responses

200

Tag successfully found.

application/json

Represents a tag. Tag is a label applied to one or more assets and used to enrich content with additional meta-data in a crowdsourcing way without having to go through the formal process.

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 tag.

descriptionstringOptional

The description of the tag.

assetsCountinteger · int32Optional

Count of all assets to which this tag is assigned.

404

Tag could not be found.

get/tags/{tagId}

GET /rest/2.0/tags/{tagId} 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": "text",
  "description": "text",
  "assetsCount": 1
}

Remove tag.

delete

Removes the tag with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

tagIdstring · uuidRequired

The ID of the tag.

Responses

204

Tag successfully removed.

No content

404

Tag with given ID could not be found.

delete/tags/{tagId}

DELETE /rest/2.0/tags/{tagId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Change tag.

patch

Modifies the tag with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

tagIdstring · uuidRequired

The ID of the tag to be changed.

Body

The properties of the tag to be changed.

namestring · min: 1 · max: 255Required

The new name of the tag.

Responses

200

Tag successfully changed.

application/json

Represents a tag. Tag is a label applied to one or more assets and used to enrich content with additional meta-data in a crowdsourcing way without having to go through the formal process.

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

Possible values:

namestringOptional

The name of the tag.

descriptionstringOptional

The description of the tag.

assetsCountinteger · int32Optional

Count of all assets to which this tag is assigned.

404

Tag could not be found.

patch/tags/{tagId}

PATCH /rest/2.0/tags/{tagId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "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": "text",
  "description": "text",
  "assetsCount": 1
}

Check tag name.

get

Checks whether a tag with given name exists. Returns true if a tag with given name exists, false otherwise.

Authorizations

AuthorizationstringRequired

Path parameters

tagNamestringRequired

The name of the tag.

Query parameters

encodedbooleanOptional

Whether the tag name is encoded using URL and Filename safe type base64 encoding scheme.

Default: false

Responses

200

true if a tag exists, false otherwise.

application/json

booleanOptional

get/tags/exists/{tagName}

GET /rest/2.0/tags/exists/{tagName} HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

true if a tag exists, false otherwise.

true

Find tags.

get

Returns tags matching the given search criteria.The returned tags satisfy all constraints that are specified in this search criteria. By default, the result contains 1000 tags.

Authorizations

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 tag 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:

Responses

200

The paged response with found tags.

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

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

200

The paged response with found tags.

{
  "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": "text",
      "description": "text",
      "assetsCount": 1
    }
  ]
}

Get asset tags.

get

Returns all the tags of the asset with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

assetIdstring · uuidRequired

The ID of the asset.

Responses

200

Tags of given asset.

application/json

Represents a tag. Tag is a label applied to one or more assets and used to enrich content with additional meta-data in a crowdsourcing way without having to go through the formal process.

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

Possible values:

namestringOptional

The name of the tag.

descriptionstringOptional

The description of the tag.

assetsCountinteger · int32Optional

Count of all assets to which this tag is assigned.

404

Asset with given ID could not be found.

get/tags/asset/{assetId}

GET /rest/2.0/tags/asset/{assetId} 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": "text",
    "description": "text",
    "assetsCount": 1
  }
]

Merge tags.

post

Merges two tags into one. All assets tagged with the fromId tag receive the toId tag and the fromId tag is removed.

Authorizations

AuthorizationstringRequired

Body

The IDs of the tags to be merged.

fromIdstring · uuidRequired

The ID of the tag to be replaced.

toIdstring · uuidRequired

The ID of the replacement tag.

Responses

204

Tags successfully merged.

No content

404

Tag with ID fromId or toId could not be found

post/tags/merge

POST /rest/2.0/tags/merge HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "fromId": "123e4567-e89b-12d3-a456-426614174000",
  "toId": "123e4567-e89b-12d3-a456-426614174000"
}

No content

Remove tags.

delete

Removes multiple tags with the specified IDs.

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

204

All tags successfully removed.

No content

404

Any tag with given ID could not be found.

delete/tags/bulk

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

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

No content

PreviousResponsibilities NextJobs

Last updated 25 days ago

Was this helpful?