Interface IssueLayoutItemPayload

Defines the payload to configure the issue layout item for a project.

interface IssueLayoutItemPayload {
    itemKey?: ProjectCreateResourceIdentifier;
    properties?: {
        [key: string]: unknown;
    };
    sectionType?: "content" | "primaryContext" | "secondaryContext";
    type?: "FIELD";
}

Properties

itemKey? properties? sectionType? type?

Properties

OptionalitemKey

itemKey?: 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

Optionalproperties

properties?: {
    [key: string]: unknown;
}

Additional properties for this item. This field is only used when the type is FIELD.

Type declaration

  • [key: string]: unknown

    Additional properties for this item. This field is only used when the type is FIELD.

OptionalsectionType

sectionType?: "content" | "primaryContext" | "secondaryContext"

The item section type

Optionaltype

type

The item type. Currently only support FIELD

Settings

Member Visibility

On This Page

Properties