Ticket Tags API Reference

Schema

The schema defines all the fields that exist for a ticket-tag object.

id
integer

Unique identifier for the term.

Read only

Context: view, embed, edit

count
integer

Number of published posts for the term.

Read only

Context: view, edit

description
string

HTML description of the term.

Context: view, edit

name
string

HTML title for the term.

Context: view, embed, edit

slug
string

An alphanumeric identifier for the term unique to its type.

Context: view, embed, edit

taxonomy
string

Type attribution for the term.

Read only

Context: view, embed, edit

One of: category, post_tag, nav_menu, link_category, post_format, ticket-tag, product, department, ticket_priority, ticket_channel

meta
object

Meta fields.

Context: view, edit

Example Request

$ curl -X OPTIONS -i http://demo.getawesomesupport.com/wp-json/wpas-api/v1/ticket-tag

List Ticket Tags

Arguments

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

exclude

Ensure result set excludes specific IDs.

Default:

include

Limit result set to specific IDs.

Default:

offset

Offset the result set by a specific number of items.

order

Order sort attribute ascending or descending.

Default: asc

One of: asc, desc

orderby

Sort collection by term attribute.

Default: name

One of: id, include, name, slug, term_group, description, count

hide_empty

Whether to hide terms not assigned to any posts.

post

Limit result set to terms assigned to a specific post.

slug

Limit result set to terms with one or more specific slugs.

Definition

GET /wpas-api/v1/ticket-tag

Example Request

$ curl http://demo.getawesomesupport.com/wp-json/wpas-api/v1/ticket-tag

Create a Ticket Tag

Arguments

description

HTML description of the term.

name

HTML title for the term.

Required: true

slug

An alphanumeric identifier for the term unique to its type.

meta

Meta fields.

Definition

POST /wpas-api/v1/ticket-tag

Retrieve a Ticket Tag

Arguments

id

Unique identifier for the term.

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

Definition

GET /wpas-api/v1/ticket-tag/<id>

Example Request

$ curl http://demo.getawesomesupport.com/wp-json/wpas-api/v1/ticket-tag/<id>

Update a Ticket Tag

Arguments

id

Unique identifier for the term.

description

HTML description of the term.

name

HTML title for the term.

slug

An alphanumeric identifier for the term unique to its type.

meta

Meta fields.

Definition

POST /wpas-api/v1/ticket-tag/<id>

Example Request

$ curl -X POST http://awesomesupport.dev/wp-json -d '{"title":"My New Title"}'

Delete a Ticket Tag

Arguments

id

Unique identifier for the term.

force

Required to be true, as terms do not support trashing.

Definition

DELETE /wpas-api/v1/ticket-tag/<id>

Example Request

$ curl -X DELETE http://demo.getawesomesupport.com/wp-json/wpas-api/v1/ticket-tag/<id>