Retrieve a list of tag items.
query | string Default: "cql.allRecords=1" A query expressed as a CQL string |
offset | integer [ 0 .. 2147483647 ] Default: 0 Skip over a number of elements by specifying an offset value for the query |
limit | integer [ 1 .. 2147483647 ] Default: 1000 Limit the number of elements returned in the response |
{- "tags": [
- {
- "id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
- "label": "important",
- "description": "This is important stuff."
}, - {
- "id": "46669e09-8b45-4ede-afbd-ca73bb89cdb3",
- "label": "urgent",
- "description": "This is urgent stuff."
}
], - "totalRecords": 2
}
Create a new tag.
Tag object
id | string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... | ||||||||
label required | string The short label of this tag | ||||||||
description | string The description of this tag | ||||||||
object (Metadata) Metadata about creation and changes to records | |||||||||
|
{- "label": "urgent",
- "description": "This is urgent stuff"
}
{- "id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
- "label": "important",
- "description": "This is important stuff."
}
Retrieve tag with given ID
id required | string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... Example: 46669e09-8b45-4ede-afbd-ca73bb89cdb3 The UUID of a tag |
{- "id": "118dbd8c-5ba0-47a9-a850-34bbb1dbf3b7",
- "label": "important",
- "description": "This is important stuff."
}
Update tag with given ID. When renaming the tag label mod-tags doesn't update it in other modules, the client must ensure this.
id required | string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... Example: 46669e09-8b45-4ede-afbd-ca73bb89cdb3 The UUID of a tag |
Tag object
id | string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... | ||||||||
label required | string The short label of this tag | ||||||||
description | string The description of this tag | ||||||||
object (Metadata) Metadata about creation and changes to records | |||||||||
|
{- "label": "urgent",
- "description": "This is urgent stuff"
}
unable to perform action -- unauthorized
Delete tag with given ID. This neither checks whether other modules still use the tag label nor does it delete the tag from other modules. The client must ensure this.
id required | string (uuid) ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... Example: 46669e09-8b45-4ede-afbd-ca73bb89cdb3 The UUID of a tag |
unable to perform action -- unauthorized