Ticket fields

Ticket fields allow to add

Get summary settings for dynamic fields

get

Retrieves a single summary settings by id for dynamic fields.

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

summarySettingsIdstringrequired

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

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "default": true,
  "name": "text",
  "description": "text",
  "fields": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "type": "single",
      "values": [
        {
          "id": "text",
          "value": "text",
          "icon": "text",
          "createdAt": "2025-04-02T03:10:06.987Z"
        }
      ],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "useLocalValues": true,
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "createdAt": "2025-04-02T03:10:06.987Z",
  "updatedAt": "2025-04-02T03:10:06.987Z"
}

ok

Update summary settings for dynamic fields

patch

Updates a summary settings for dynamic fields

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

summarySettingsIdstringrequired

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

Body

defaultbooleanoptional

namestring · min: 1 · max: 255optional

descriptionstringoptional

fieldsobject[]optional

useLocalValuesbooleanoptional

allowedEntitiesobject[] | nullableoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "default": true,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "type": "single",
        "valueIds": [
          "text"
        ],
        "values": [
          {
            "id": "text",
            "value": "text",
            "icon": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "items": "text",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "useLocalValues": true,
    "allowedEntities": [
      {
        "entityType": "team",
        "operation": "view",
        "entityId": "text"
      }
    ]
  }'

200

404

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "default": true,
  "name": "text",
  "description": "text",
  "fields": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "type": "single",
      "values": [
        {
          "id": "text",
          "value": "text",
          "icon": "text",
          "createdAt": "2025-04-02T03:10:06.987Z"
        }
      ],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "useLocalValues": true,
  "allowedEntities": [
    {
      "entityType": "team",
      "operation": "view",
      "entityId": "text"
    }
  ],
  "createdAt": "2025-04-02T03:10:06.987Z",
  "updatedAt": "2025-04-02T03:10:06.987Z"
}

updated

Delete summary settings for dynamic fields

delete

Deletes the specific summary settings for dynamic fields

Authorizations

useraccessKey

Path parameters

workspaceIdstringrequired

summarySettingsIdstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

Deleted