Function deleteCustomField

deleteCustomField(
    client: Client,
    parameters: { id: string },
    options?: RequestOptions,
): Promise<
    {
        description?: string;
        elapsedRuntime: number;
        finished?: number;
        id: string;
        lastUpdate: number;
        message?: string;
        progress: number;
        result?: unknown;
        self: string;
        started?: number;
        status: | string & {}
        | "ENQUEUED"
        | "RUNNING"
        | "COMPLETE"
        | "FAILED"
        | "CANCEL_REQUESTED"
        | "CANCELLED"
        | "DEAD";
        submitted: number;
        submittedBy: number;
        [key: string]: unknown;
    },
>
Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields.

This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required: Administer Jira global permission.
Parameters
- client: Client
- parameters: { id: string }
  - id: string
    
    The ID of a custom field.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        description?: string;
        elapsedRuntime: number;
        finished?: number;
        id: string;
        lastUpdate: number;
        message?: string;
        progress: number;
        result?: unknown;
        self: string;
        started?: number;
        status: | string & {}
        | "ENQUEUED"
        | "RUNNING"
        | "COMPLETE"
        | "FAILED"
        | "CANCEL_REQUESTED"
        | "CANCELLED"
        | "DEAD";
        submitted: number;
        submittedBy: number;
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/issueFields.ts:178

Function deleteCustomField

Parameters

id: string

Settings