Jira.js - Jira Cloud API library
    Preparing search index...

    Interface CustomFieldPayload

    Defines the payload for the custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-post

    interface CustomFieldPayload {
        cfType?: string;
        description?: string;
        name?: string;
        onConflict?: string;
        pcri?: Version3Models.ProjectCreateResourceIdentifier;
        searcherKey?: string;
    }
    Index

    Properties

    cfType? description? name? onConflict? pcri? searcherKey?

    Properties

    cfType?: string

    The type of the custom field

    description?: string

    The description of the custom field

    name?: string

    The name of the custom field

    onConflict?: string

    The strategy to use when there is a conflict with an existing custom field. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters

    pcri?: Version3Models.ProjectCreateResourceIdentifier
    searcherKey?: string

    The searcher key of the custom field

    Settings

    Member Visibility

    On This Page

    Properties