Skip to content

Function: createCustomField() ​

ts
function createCustomField(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  clauseNames?: string[];
  custom?: boolean;
  id?: string;
  name?: string;
  navigable?: boolean;
  orderable?: boolean;
  schema?: {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
  };
  searchable?: boolean;
}>;

Defined in: src/server/api/issueFields.ts:98

Creates a custom field using a definition

Parameters ​

ParameterType
clientClient
parameters{ description?: string; id?: string; issueTypeIds?: string[]; name?: string; projectIds?: number[]; searcherKey?: string; self?: string; type?: string; }
parameters.description?string
parameters.id?string
parameters.issueTypeIds?string[]
parameters.name?string
parameters.projectIds?number[]
parameters.searcherKey?string
parameters.self?string
parameters.type?string
options?RequestOptions

Returns ​

Promise<{ [key: string]: unknown; clauseNames?: string[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }; searchable?: boolean; }>