Tags

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

get
Authorizations
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
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
Body
elementTypestring · enumOptionalPossible values:
tagsstring[]Optional

List of tags

elementGuidsstring · uuid[]Optional

List of element unique identifiers

Responses
204

Tags were successfully overwritten.

No content

put
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
Body
elementTypestring · enumOptionalPossible values:
tagsstring[]Optional

List of tags

elementGuidsstring · uuid[]Optional

List of element unique identifiers

Responses
204

Tags were successfully deleted.

No content

delete
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
Body
elementTypestring · enumOptionalPossible values:
tagsstring[]Optional

List of tags

elementGuidsstring · uuid[]Optional

List of element unique identifiers

Responses
204

Tags were successfully added.

No content

patch
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
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
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
Path parameters
elementGuidstring · uuidRequired
Responses
204

All tags were successfully deleted.

No content

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

All tags were successfully deleted.

No content

Was this helpful?