forked from MrRefactoring/jira.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcustomFieldValueUpdate.ts
23 lines (23 loc) · 1.2 KB
/
customFieldValueUpdate.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/** A list of issue IDs and the value to update a custom field to. */
export interface CustomFieldValueUpdate {
/** The list of issue IDs. */
issueIds: number[];
/**
* 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:
*
* - `string` the value must be a string.
* - `number` the value must be a number.
* - `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.
* - `user` the value must be an object that contains the `accountId` field.
* - `group` the value must be an object that contains the group `name` or `groupId` field. Because group names can
* change, we recommend using `groupId`.
*
* A 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).
*/
value: any;
}