Atlassian · Schema

CustomFieldValueUpdate

A list of issue IDs and the value to update a custom field to.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
issueIds array The list of issue IDs.
value object The value for the custom field. The value must be compatible with the [custom field type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#data-types) as fo
View JSON Schema on GitHub

JSON Schema

atlassian-customfieldvalueupdate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomFieldValueUpdate",
  "title": "CustomFieldValueUpdate",
  "additionalProperties": false,
  "description": "A list of issue IDs and the value to update a custom field to.",
  "properties": {
    "issueIds": {
      "description": "The list of issue IDs.",
      "items": {
        "format": "int64",
        "type": "integer",
        "writeOnly": true
      },
      "type": "array",
      "writeOnly": true
    },
    "value": {
      "description": "The value for the custom field. The value must be compatible with the [custom field type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#data-types) as follows:\n\n *  `string` the value must be a string.\n *  `number` the value must be a number.\n *  `datetime` the value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example, `\"2023-01-18T12:00:00-03:00\"` or `\"2023-01-18T12:00:00.000Z\"`. However, the milliseconds part is ignored.\n *  `user` the value must be an object that contains the `accountId` field.\n *  `group` the value must be an object that contains the group `name` or `groupId` field. Because group names can change, we recommend using `groupId`.\n\nA list of appropriate values must be provided if the field is of the `list` [collection type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#collection-types)."
    }
  },
  "required": [
    "issueIds",
    "value"
  ],
  "type": "object",
  "writeOnly": true
}