Appearance

Delete Fields ​

Endpoint ​

http
DELETE /unified/ticketing/fields/{id}
Integrations supported
  • Teamwork Project Management

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

id
string

The field's unique identifier

name
string

The field's name. This is the name of the property in the entity.

label
string

The field's label

description
string

The field's description

type
string

The field's type. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
is_hidden
boolean

Whether the field is hidden

is_unique
boolean

Whether the field is unique

is_required
boolean

Whether the field is required

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

is_hidden
boolean

Whether the option is hidden

is_user_defined
boolean

Whether the field is user defined

entity_type
string

The entity type the field belongs to

All possible enum values:
  • ticket_type
  • ticket
  • collection
  • user
entity_id
string

The unique identifier for the entity the field belongs to

created_at
string · date-time

The date and time of the field's creation

updated_at
string · date-time

The date and time of the field's last update

etag
string

The unique identifier for the specific version of the resource.

applicable_in
string

The context in which the field is applicable

All possible enum values:
  • collection
  • workspace
  • ticket
applicable_for
string

The unique identifier of the applicable

remote_data
object

Raw data returned from the remote API call.