EmbedThis

Appearance

Ticket ​

Support case management.

Create ​

Endpoint

POST /ticket/create

Authorized User Role

user

Request Body

Field | Type | Required | Role

  • | - | - | - assigned | string | | support cc | string | | productId | string | | subject | string | yes | severity | string | yes | status | string | yes | updated | date | yes |

Response

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number

Get ​

Endpoint

POST /ticket/get

Authorized User Role

user

Request Body

Field | Type | Required

  • | - | - id | string | yes owner | string |

Response

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number

Fetch ​

Endpoint

POST /ticket/fetch

Authorized User Role

support

Request Body

Field | Type

  • | - status | string

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number

Find ​

Endpoint

POST /ticket/find

Authorized User Role

user

Request Body

Field | Type | Role

  • | - | - id | string | accountId | string | support

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Paged response.

Field | Type | Notes

  • | - | - data | array | An array of metrics each containing an array of metric with the following properties. next | string | Paged cursor to use for the next page of items. prev | string | Pages cursor to use for the previous page of items.

Ticket

An array of Ticket items.

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number

Init ​

Endpoint

POST /ticket/init

Authorized User Role

user

Request Body

A object.

Response

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number

Remove ​

Endpoint

POST /ticket/remove

Authorized User Role

support

Request Body

Field | Type | Role

  • | - | - id | string | accountId | string | support

Update ​

Endpoint

POST /ticket/update

Authorized User Role

user

Request Body

Field | Type | Required | Role

  • | - | - | - accountId | string | | support assigned | string | | support cc | string | | id | string | yes | productId | string | | subject | string | yes | severity | string | yes | status | string | yes | updated | date | yes |

Response

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number

UpdateWorked ​

Endpoint

POST /ticket/updateWorked

Authorized User Role

support

Request Body

Field | Type | Required

  • | - | - accountId | string | yes id | string | yes description | string | yes hours | number | yes

Response

Field | Type

  • | - accountId | string assigned | string cc | string hours | number id | string productId | string subject | string severity | string status | string updated | date work | array

Work

An array of Work items.

Field | Type

  • | - date | date description | string hours | number