Interface FieldLayoutSchemePayload

Defines the payload for the field layout schemes. See "Field Configuration Scheme" - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfigurationscheme-post https://support.atlassian.com/jira-cloud-administration/docs/configure-a-field-configuration-scheme/

interface FieldLayoutSchemePayload {
    defaultFieldLayout?: ProjectCreateResourceIdentifier;
    description?: string;
    explicitMappings?: {
        [key: string]: ProjectCreateResourceIdentifier;
    };
    name?: string;
    pcri?: ProjectCreateResourceIdentifier;
}

Properties

defaultFieldLayout? description? explicitMappings? name? pcri?

Properties

OptionaldefaultFieldLayout

defaultFieldLayout?: ProjectCreateResourceIdentifier

Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

Example

pcri:permissionScheme:id:10001

Optionaldescription

description?: string

The description of the field layout scheme

Example

Thisis a field layout scheme

OptionalexplicitMappings

explicitMappings?: {
    [key: string]: ProjectCreateResourceIdentifier;
}

There is a default configuration "fieldlayout" that is applied to all issue types using this scheme that don't have an explicit mapping users can create (or re-use existing) configurations for other issue types and map them to this scheme

Type declaration

  • [key: string]: ProjectCreateResourceIdentifier

    Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

    Example

    pcri:permissionScheme:id:10001

Optionalname

name?: string

The name of the field layout scheme

Example

MyField Layout Scheme

Optionalpcri

pcri?: ProjectCreateResourceIdentifier

Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:\[entityType\]:\[type\]:\[entityId\] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation

Example

pcri:permissionScheme:id:10001

Settings

Member Visibility

On This Page

Properties