Skip to content

Tag

GET /v3/tag

List tags

Acl Action: TAG list

Arguments:

  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to name.
  • dir - string: Either asc or desc.

Example Response:

{
    "items": [
        {
            "id": "3",
            "name": "Entertainment",
            "slug": "entertainment",
            "uuid": "AAAA-1234",
            "status": "1",
            "srn": "srn:tsn:ceo-core\/tag:AAAA-1234"
        },
        {
            "id": "4",
            "name": "Opinion",
            "slug": "opinion",
            "uuid": "BBBB-1234",
            "status": "1",
            "srn": "srn:tsn:ceo-core\/tag:BBBB-1234"
        }
    ],
    "first": 1,
    "before": 1,
    "current": 1,
    "last": 1,
    "next": 1,
    "total_pages": 1,
    "total_items": 2,
    "limit": 50
}

GET /v3/tag/{uuid}

Get single tag

Acl Action: TAG get

Example Response:

[
    {
        "id": "3",
        "name": "Entertainment",
        "slug": "entertainment",
        "uuid": "AAAA-1234",
        "status": "1",
        "srn": "srn:tsn:ceo-core\/tag:AAAA-1234"
    }
]

POST /v3/tag

Create new tag

Acl Action: TAG create

Example Request:

{
    'name': 'A tag',
    'slug': 'a-tag',
    'status': 1
}

Example Response: See GET /v3/tag/{uuid}

PUT /v3/tag/{uuid}

Update tag.

Acl Action: TAG update

Example Request: See POST /v3/tag

Example Response: See POST /v3/tag

DELETE /v3/tag/{uuid}[,{uuid}]

Delete one or more tags.

Acl Action: TAG remove

Example Response:

{
    "message": "ok"
}