Function: getProjectContextMapping()
function getProjectContextMapping(
client,
parameters,
options?
): Promise<{
[key: string]: unknown;
isLast: boolean;
maxResults: number;
nextPage?: string;
self?: string;
startAt: number;
total: number;
values: object[];
}>;Defined in: src/cloud/api/issueCustomFieldContexts.ts:216
Returns a paginated list of context to project mappings for a custom field. The result can be filtered by contextId. Otherwise, all mappings are returned. Invalid IDs are ignored.
Note: Jira is adding support for multiple field contexts per project. On sites where this is enabled, a custom field can have more than one context associated with the same project, so this operation can return several mappings that share the same projectId, each with a different contextId. Do not assume that a project appears at most once in the response. See CHANGE-3082 for more details.
Permissions required:Administer Jira global permission.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { contextId?: number[]; fieldId: string; maxResults?: number; startAt?: number; } | - |
parameters.contextId? | number[] | The list of context IDs. To include multiple context, separate IDs with ampersand: contextId=10000&contextId=10001. |
parameters.fieldId? | string | The ID of the custom field, for example customfield\_10000. |
parameters.maxResults? | number | The maximum number of items to return per page. |
parameters.startAt? | number | The index of the first item to return in a page of results (page offset). |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>