Ticket fields

Ticket fields allow to add

Get summary settings for dynamic fields

Retrieves a single summary settings by id for dynamic fields.

GET/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}

Authorization

useraccessKey

Response

200404

ok

Body

application/json

id*string (uuid)

defaultboolean

name*string

description*string

fields*array of SummaryField (object)

useLocalValuesboolean

allowedEntitiesarray of SenderProfileAllowedEntity (object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "default": false,
  "name": "text",
  "description": "text",
  "fields": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "type": "single",
      "values": [
        {
          "id": "text",
          "value": "text",
          "icon": "text",
          "createdAt": "2024-11-21T08:54:52.252Z"
        }
      ]
    }
  ],
  "useLocalValues": false,
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "createdAt": "2024-11-21T08:54:52.252Z",
  "updatedAt": "2024-11-21T08:54:52.252Z"
}

Update summary settings for dynamic fields

Updates a summary settings for dynamic fields

PATCH/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}

Authorization

useraccessKey

Path parameters

workspaceId*string

summarySettingsId*string

Either "default" for the default summary settings, or a UUID for a specific one.

Body

application/json

defaultboolean

namestring

descriptionstring

fieldsarray of CreateSummaryField (object)

useLocalValuesboolean

allowedEntitiesnullable array of SenderProfileAllowedEntity (object)

Response

200404422

updated

Body

application/json

id*string (uuid)

defaultboolean

name*string

description*string

fields*array of SummaryField (object)

useLocalValuesboolean

allowedEntitiesarray of SenderProfileAllowedEntity (object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "default": false,
  "name": "text",
  "description": "text",
  "fields": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "type": "single",
      "values": [
        {
          "id": "text",
          "value": "text",
          "icon": "text",
          "createdAt": "2024-11-21T08:54:52.252Z"
        }
      ]
    }
  ],
  "useLocalValues": false,
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "createdAt": "2024-11-21T08:54:52.252Z",
  "updatedAt": "2024-11-21T08:54:52.252Z"
}

Delete summary settings for dynamic fields

Deletes the specific summary settings for dynamic fields

DELETE/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}

Authorization

useraccessKey

Path parameters

workspaceId*string

summarySettingsId*string

Either "default" for the default summary settings, or a UUID for a specific one.

Response

204404

Deleted

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}