Interface FieldLayoutPayload

Defines the payload for the field layouts. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-group-issue-field-configurations"

interface FieldLayoutPayload {
    configuration?: FieldLayoutConfiguration[];
    description?: string;
    name?: string;
    pcri?: ProjectCreateResourceIdentifier;
}

Properties

configuration? description? name? pcri?

Properties

Optionalconfiguration

configuration?: FieldLayoutConfiguration[]

The field layout configuration. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfiguration-post

Optionaldescription

description?: string

The description of the field layout

Example

Thisis a field layout

Optionalname

name?: string

The name of the field layout

Example

MyField Layout

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