Tag /tag/{tag-id}

Represents an individual tag.

Reading

GET /tag/{tag-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with workspace_environment permission is required.
  • At least one of the following criteria must be met :
    • The access token points to an user and the current person is attached to the workspace at which is attached the tag.
    • The access token points to a workspace and the workspace at which is attached the tag is the current workspace.

Fields

Name Description Type

_id

The tag ID.

string

title

The title of the tag.

string

workspace

The ID of the Workspace at which is attached the tag.

Workspace

Publishing

You can publish tags by using the /workspace/tags edge.

Updating

PUT /tag/{tag-id} HTTP/1.1
Host: localhost:3000

Permissions

  • An access token with manage_environment permission is required.
  • At least one of the following criteria must be met :
    • The access token points to an user and the current person is an admin (with MANAGE permission) of the workspace at which is attached the tag.
    • The access token points to a workspace and the workspace at which is attached the tag is the current workspace.

Fields

Name Description Type

title

The title of the tag.

string

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Deleting

DELETE /tag/{tag-id} HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to update tags are required.

Fields

No fields are required.

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Edges

No edges.