Ticket fields

Ticket fields allow to add

Last updated 3 months ago

Was this helpful?

Get summary settings for dynamic fields

Retrieves a single summary settings by id for dynamic fields.

get

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

Authorizations

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 -L \
  --url '/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  --header 'Authorization: Bearer jwt'

200

404

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

Update summary settings for dynamic fields

Updates a summary settings for dynamic fields

patch

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

Authorizations

Path parameters

workspaceIdstringrequired

summarySettingsIdstringrequired

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

Body

defaultboolean

namestring · min: 1 · max: 255

descriptionstring

useLocalValuesboolean

fieldsobject[]

allowedEntitiesobject[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

404

422

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

updated

Delete summary settings for dynamic fields

Deletes the specific summary settings for dynamic fields

delete

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

Authorizations

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 -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/dynamic-fields-summary-settings/{summarySettingsId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Deleted