Tag
- 16 Jun 2022
- 1 Minute to read
- Print
- DarkLight
Tag
- Updated on 16 Jun 2022
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Tag
Tag of the ticket.
Tag
- Tag ManageGET ticketing/tags
- Get the list of TagGET ticketing/tags/{id}
- Get a single TagPOST ticketing/tags
- Create a new TagPUT ticketing/tags/{id}
- Update the TagDELETE ticketing/tags/{id}
- Remove the Tag
Tag JSON Format
Tag is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id | guid | Id of the tag. |
name | string | Name of the tag. |
Get the list of Tag
GET ticketing/tags
Parameters:
No Parameters
Response:
An array of Tag
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/tags \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \
Response:
HTTP/1.1 200 OK
[
{
"id": "bdf96bad-890f-4af5-8f4e-42d2cc29e61b",
"name": "my tag"
}
]
Get a single Tag
GET ticketing/tags/{id}
Parameters:
No Parameters
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/tags/bdf96bad-890f-4af5-8f4e-42d2cc29e61b \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \
Response:
HTTP/1.1 200 OK
{
"id": "bdf96bad-890f-4af5-8f4e-42d2cc29e61b",
"name": "my tag"
}
Create a new Tag
POST ticketing/tags
Parameters:
Name | Type | in | Required | Description |
---|---|---|---|---|
name | string | body | yes | Name of the tag. |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/tags \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"my tag"}'
Response:
HTTP/1.1 201 Created
{
"id": "bdf96bad-890f-4af5-8f4e-42d2cc29e61b",
"name": "my tag"
}
Update the Tag
PUT ticketing/tags/{id}
Parameters:
Name | Type | in | Required | Description |
---|---|---|---|---|
name | string | body | yes | Name of the tag. |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/tags/bdf96bad-890f-4af5-8f4e-42d2cc29e61b \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"my tag"}'
Response:
HTTP/1.1 200 OK
{
"id": "bdf96bad-890f-4af5-8f4e-42d2cc29e61b",
"name": "my tag"
}
Remove the Tag
DELETE ticketing/tags/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api11.comm100.io/v4/ticketing/tags/bdf96bad-890f-4af5-8f4e-42d2cc29e61b \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \
Response:
HTTP/1.1 204 No Content
Was this article helpful?