Skip to content

Function: createCustomFieldContext() ​

ts
function createCustomFieldContext(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  issueTypeIds?: string[];
  name: string;
  projectIds?: string[];
}>;

Defined in: src/cloud/api/issueCustomFieldContexts.ts:74

Creates a custom field context.

If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ description?: string; fieldId: string; id?: string; issueTypeIds?: string[]; name: string; projectIds?: string[]; }-
parameters.description?stringThe description of the context.
parameters.fieldId?stringThe ID of the custom field.
parameters.id?stringThe ID of the context.
parameters.issueTypeIds?string[]The list of issue types IDs for the context. If the list is empty, the context refers to all issue types.
parameters.name?stringThe name of the context.
parameters.projectIds?string[]The list of project IDs associated with the context. If the list is empty, the context is global.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; description?: string; id?: string; issueTypeIds?: string[]; name: string; projectIds?: string[]; }>