JetBrains Space Help

Custom Fields v2

Set values for entity

post /api/http/custom-fields-v2/values/{entity}

Request arguments

entity: string in one of the formats

(Path) Required

object with fields:

Response

No arguments

Get all values for entity

get /api/http/custom-fields-v2/values/{entity}

Request arguments

entity: string in one of the formats

(Path) Required

Response

array of CustomFieldValueData

Set single value

post /api/http/custom-fields-v2/values/{entity}/{customField}

Request arguments

entity: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

object with fields:

Response

No arguments

Get single value

get /api/http/custom-fields-v2/values/{entity}/{customField}

Request arguments

entity: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

Create custom field

post /api/http/custom-fields-v2/{entityType}/fields

Request arguments

entityType: string in one of the formats

(Path) Required

object with fields:

  • name: string Required

  • type: CustomFieldType Required

  • multivalued: boolean ( Optional , defaults to false)

  • parameters: CFCreateParameters ( Nullable and Optional , defaults to null)

  • required: boolean ( Optional , defaults to false)

  • defaultValue: CFInputValue ( Nullable and Optional , defaults to null)

  • constraint: CFConstraint ( Nullable and Optional , defaults to null)

  • description: string ( Nullable and Optional , defaults to null)

  • order: integer (format: int32) ( Nullable and Optional , defaults to null)

Get custom fields

get /api/http/custom-fields-v2/{entityType}/fields

Get all configured custom fields for an entity type

Request arguments

entityType: string in one of the formats

(Path) Required

withArchived: boolean (Query) ( Optional , defaults to false)

Response

array of CustomFieldData

Reorder custom fields

post /api/http/custom-fields-v2/{entityType}/fields/reorder

Re-order custom fields. Pass identifiers of the custom fields in the order you wish the custom fields to be.

Request arguments

entityType: string in one of the formats

(Path) Required

object with fields:

Response

No arguments

Archive custom field

post /api/http/custom-fields-v2/{entityType}/fields/{customField}/archive

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

Response

No arguments

Restore custom field

post /api/http/custom-fields-v2/{entityType}/fields/{customField}/restore

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

Response

No arguments

Get single custom field

get /api/http/custom-fields-v2/{entityType}/fields/{customField}

Get configured custom field

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

Update custom field

patch /api/http/custom-fields-v2/{entityType}/fields/{customField}

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

object with fields:

  • name: string ( Nullable and Optional , defaults to null)

  • parameters: CFUpdateParameters ( Nullable and Optional , defaults to null)

  • required: boolean ( Nullable and Optional , defaults to null)

  • defaultValue: CFInputValue ( Nullable and Optional , defaults to null)

  • constraint: CFConstraint ( Nullable and Optional , defaults to null)

  • description: string ( Nullable and Optional , defaults to null)

Response

No arguments

Delete custom field

delete /api/http/custom-fields-v2/{entityType}/fields/{customField}

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

Response

No arguments

Create enum value

post /api/http/custom-fields-v2/{entityType}/fields/{customField}/enum-values

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

object with fields:

  • enumValueToAdd: string Required

Response

CFEnumValue

Get enum values

get /api/http/custom-fields-v2/{entityType}/fields/{customField}/enum-values

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

query: string (Query) ( Nullable and Optional , defaults to null)

ordering: EnumValueOrdering (Query) ( Nullable and Optional , defaults to "NAME_ASC")

addedByProfileId: string (Query) ( Nullable and Optional , defaults to null)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

  • next: string Required

  • totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)

  • data: array of CFEnumValue Required

Update enum value

patch /api/http/custom-fields-v2/{entityType}/fields/{customField}/enum-values

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

object with fields:

Response

No arguments

Bulk update enum values

post /api/http/custom-fields-v2/{entityType}/fields/{customField}/enum-values/bulk-update

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

object with fields:

Response

No arguments

Delete enum value

delete /api/http/custom-fields-v2/{entityType}/fields/{customField}/enum-values/{enumValueToRemove}

Request arguments

entityType: string in one of the formats

(Path) Required

customField: string in one of the formats

  • id: string

  • name: string

(Path) Required

enumValueToRemove: string in one of the formats

  • id: string

  • name: string

(Path) Required

Response

No arguments

Last modified: 19 October 2021