Atlassian · Schema

UpdateCustomFieldDetails

Details of a custom field.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
description string The description of the custom field. The maximum length is 40000 characters.
name string The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.
searcherKey string The searcher that defines the way the field is searched in Jira. It can be set to `null`, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):
View JSON Schema on GitHub

JSON Schema

atlassian-updatecustomfielddetails-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateCustomFieldDetails",
  "title": "UpdateCustomFieldDetails",
  "additionalProperties": false,
  "description": "Details of a custom field.",
  "properties": {
    "description": {
      "description": "The description of the custom field. The maximum length is 40000 characters.",
      "type": "string"
    },
    "name": {
      "description": "The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.",
      "type": "string"
    },
    "searcherKey": {
      "description": "The searcher that defines the way the field is searched in Jira. It can be set to `null`, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):\n\n *  `cascadingselect`: `cascadingselectsearcher`\n *  `datepicker`: `daterange`\n *  `datetime`: `datetimerange`\n *  `float`: `exactnumber` or `numberrange`\n *  `grouppicker`: `grouppickersearcher`\n *  `importid`: `exactnumber` or `numberrange`\n *  `labels`: `labelsearcher`\n *  `multicheckboxes`: `multiselectsearcher`\n *  `multigrouppicker`: `multiselectsearcher`\n *  `multiselect`: `multiselectsearcher`\n *  `multiuserpicker`: `userpickergroupsearcher`\n *  `multiversion`: `versionsearcher`\n *  `project`: `projectsearcher`\n *  `radiobuttons`: `multiselectsearcher`\n *  `readonlyfield`: `textsearcher`\n *  `select`: `multiselectsearcher`\n *  `textarea`: `textsearcher`\n *  `textfield`: `textsearcher`\n *  `url`: `exacttextsearcher`\n *  `userpicker`: `userpickergroupsearcher`\n *  `version`: `versionsearcher`",
      "enum": [
        "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:daterange",
        "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
        "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
        "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
        "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
        "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"
      ],
      "type": "string"
    }
  },
  "type": "object",
  "writeOnly": true
}