Datastream Tags

5 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List datastream tags

GET/api/v1/datastream-tags/

API key permissionDatastream: Read-onlydatastream:read

Tags of the workspaces the API key can see, sorted by name. A tag belongs to one workspace, and its name is unique there ignoring case. The same name in another workspace, parent and child included, is a separate tag. Attach tags to datastreams with POST /api/v1/datastreams/tags/.

Query parameters

• workspace_scopestring
• scope_from_workspace_idstring · uuid

  Required only for workspace_scope when multiple roots exist.

• workspace_idarray of string · uuid
• namestring

  Exact tag name, ignoring case. Not a search.

• pageinteger

  Default 1 · Min 1

• page_sizeinteger

  Default 50 · Min 1

Responses

200OKapplication/json

Response schema

object PagedDatastreamTagSchema

• itemsarray of objectrequired
  Items · DatastreamTagSchema

  • idstring · uuidrequired
  • namestringrequired
  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
  • createdstring · date-timerequired
• countintegerrequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/datastream-tags/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "workspace": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "created": "2024-01-01T00:00:00Z"
    }
  ],
  "count": 1
}

Create a datastream tag

POST/api/v1/datastream-tags/

API key permissionDatastream: Writedatastream:write

Create a tag in one workspace. A tag belongs to one workspace, and its name is unique there ignoring case. The same name in another workspace, parent and child included, is a separate tag. Attach tags to datastreams with POST /api/v1/datastreams/tags/. A name the workspace already has returns 409 with the existing tag.

Request bodyrequired

application/json

Body schema

object DatastreamTagCreateSchema

• workspace_idstring · uuidrequired
• namestringrequired

  Up to 25 characters, unique within the workspace ignoring case. Leading and trailing spaces are dropped.

Responses

201Createdapplication/json

Response schema

object DatastreamTagCreatedSchema

• idstring · uuidrequired
• namestringrequired
• workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema

  • idstring · uuidrequired
  • namestringrequired
• createdstring · date-timerequired
• same_name_in_ancestor_workspacesarray of object

  Workspaces above this one, among those the key can see, that already have a tag with this name. Those are separate tags: a datastream only carries tags of its own workspace.

  Items · WorkspaceMinimalSchema

  • idstring · uuidrequired
  • namestringrequired

400Bad Requestapplication/json

Response schema

object ErrorSchema

• detailstringrequired

409Conflictapplication/json

Response schema

object DatastreamTagConflictSchema

• detailstringrequired
• tagobjectrequired
  Attributes · DatastreamTagSchema

  • idstring · uuidrequired
  • namestringrequired
  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
  • createdstring · date-timerequired

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/v1/datastream-tags/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  }'

Response201

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "workspace": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "created": "2024-01-01T00:00:00Z",
  "same_name_in_ancestor_workspaces": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ]
}

Get a datastream tag

GET/api/v1/datastream-tags/{tag_id}/

API key permissionDatastream: Read-onlydatastream:read

Path parameters

• tag_idstring · uuidrequired

Responses

200OKapplication/json

Response schema

object DatastreamTagSchema

• idstring · uuidrequired
• namestringrequired
• workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema

  • idstring · uuidrequired
  • namestringrequired
• createdstring · date-timerequired

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/v1/datastream-tags/{tag_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "workspace": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "created": "2024-01-01T00:00:00Z"
}

Rename a datastream tag

PATCH/api/v1/datastream-tags/{tag_id}/

API key permissionDatastream: Writedatastream:write

Every datastream carrying the tag shows the new name. Their history keeps the old one. A name another tag of the workspace has returns 409 with that tag. The workspace of a tag cannot change.

Path parameters

• tag_idstring · uuidrequired

Request bodyrequired

application/json

Body schema

object DatastreamTagUpdateSchema

• namestringrequired

  The new name. Every datastream carrying the tag shows it. A change of case only is allowed.

Responses

200OKapplication/json

Response schema

object DatastreamTagSchema

• idstring · uuidrequired
• namestringrequired
• workspaceobjectrequired
  Attributes · WorkspaceMinimalSchema

  • idstring · uuidrequired
  • namestringrequired
• createdstring · date-timerequired

400Bad Requestapplication/json

Response schema

object ErrorSchema

• detailstringrequired

409Conflictapplication/json

Response schema

object DatastreamTagConflictSchema

• detailstringrequired
• tagobjectrequired
  Attributes · DatastreamTagSchema

  • idstring · uuidrequired
  • namestringrequired
  • workspaceobjectrequired
    Attributes · WorkspaceMinimalSchema

    • idstring · uuidrequired
    • namestringrequired
  • createdstring · date-timerequired

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/v1/datastream-tags/{tag_id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string"
  }'

Response200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "workspace": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "created": "2024-01-01T00:00:00Z"
}

Delete a datastream tag

DELETE/api/v1/datastream-tags/{tag_id}/

API key permissionDatastream: Writedatastream:write

Deletes the tag and removes it from every datastream, each of which gets a history entry.

Path parameters

• tag_idstring · uuidrequired

Responses

200OKapplication/json

Response schema

object DatastreamTagDeletedSchema

• idstring · uuidrequired
• removed_from_datastreamsintegerrequired

  How many datastreams carried the tag and no longer do.

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/v1/datastream-tags/{tag_id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "removed_from_datastreams": 1
}

Was this page helpful? Yes No