Tags

Get Tags for many elements i.e. a Processes, ProcessTemplates etc.

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Query parameters

elementIdentifiersstring · uuid[]Optional

Element unique identifiers

Responses

200

Returns a dictionary where the key is the element identifier and the value is a list of tags.

application/json

get

/api/v1/tags

HTTPcURLJavaScriptPython

GET /api/v1/tags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Returns a dictionary where the key is the element identifier and the value is a list of tags.

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Overwrite tags for a Frends element.

put

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

application/json

elementTypestring · enumOptionalPossible values:

tagsstring[]Optional

List of tags

elementGuidsstring · uuid[]Optional

List of element unique identifiers

Responses

204

Tags were successfully overwritten.

400

Tags cannot be empty when overwriting. If you want to delete all tags use the DELETE {elementGuid:guid} method.

put

/api/v1/tags

HTTPcURLJavaScriptPython

PUT /api/v1/tags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "elementType": "Process",
  "tags": [
    "text"
  ],
  "elementGuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

Delete tags from specified Frends elements.

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

application/json

elementTypestring · enumOptionalPossible values:

tagsstring[]Optional

List of tags

elementGuidsstring · uuid[]Optional

List of element unique identifiers

Responses

204

Tags were successfully deleted.

delete

/api/v1/tags

HTTPcURLJavaScriptPython

DELETE /api/v1/tags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "elementType": "Process",
  "tags": [
    "text"
  ],
  "elementGuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

204

Tags were successfully deleted.

No content

Add tags to a Frends element.

patch

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Body

application/json

elementTypestring · enumOptionalPossible values:

tagsstring[]Optional

List of tags

elementGuidsstring · uuid[]Optional

List of element unique identifiers

Responses

204

Tags were successfully added.

patch

/api/v1/tags

HTTPcURLJavaScriptPython

PATCH /api/v1/tags HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "elementType": "Process",
  "tags": [
    "text"
  ],
  "elementGuids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

204

Tags were successfully added.

No content

Get all Tags for an element type i.e. a Process, ProcessTemplate etc.

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

elementTypestring · enumRequired

Element type

Possible values:

Responses

200

Returns a dictionary where the key is the element identifier and the value is a list of tags.

application/json

get

/api/v1/tags/{elementType}

HTTPcURLJavaScriptPython

GET /api/v1/tags/{elementType} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Returns a dictionary where the key is the element identifier and the value is a list of tags.

{
  "data": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Delete all tags from a Frends element.

delete

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

elementGuidstring · uuidRequired

Responses

204

All tags were successfully deleted.

delete

/api/v1/tags/{elementGuid}

HTTPcURLJavaScriptPython

DELETE /api/v1/tags/{elementGuid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

All tags were successfully deleted.

No content