Atlassian: Issue panels schemas
5 Atlassian schemas with complete fields and constraints.
← Issue panels operations · All schemas
Bulk pin or unpin issue panel to projects — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
moduleId | string | Required within parent | The moduleId of the Forge panel in the format `ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key}` |
projectList | array | Required within parent | The list of projects to pin or unpin the issue panel to or from. Maximum items: 1000 Minimum items: 0 |
projectList[] | Model | Each item | Expand Bulk pin or unpin issue panel to projects — request body — body project List item |
Referenced models: Bulk pin or unpin issue panel to projects — request body — body project List item
Bulk pin or unpin issue panel to projects — request body — body project List item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of projects to pin or unpin the issue panel to or from. Additional keys: not allowed |
action | string | Required within parent | The action to perform: PIN or UNPIN. One of: PIN, UNPIN |
projectIdOrKey | string | Required within parent | The project ID or key. |
Get issue panel pin status for projects — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
moduleId | string | Required within parent | The moduleId of the Forge panel in the format `ari:cloud:ecosystem::extension/{app-id}/{environment-id}/static/{module-key}` |
projectList | array | Required within parent | The IDs or keys of the projects to check the issue panel pin status for. Maximum items: 1000 Minimum items: 0 |
projectList[] | string | Each item | The IDs or keys of the projects to check the issue panel pin status for. |
Get issue panel pin status for projects — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
moduleId | JSON | Optional | |
moduleId (anyOf 1) | string | Alternative | The moduleId of the Forge panel that was requested. |
moduleId (anyOf 2) | null | Alternative | |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | The pin status of the issue panel, with one entry per requested project. |
statuses (anyOf 1)[] | Model | Each item | Expand Get issue panel pin status for projects — response body — statuses array item |
statuses (anyOf 2) | null | Alternative |
Referenced models: Get issue panel pin status for projects — response body — statuses array item
Get issue panel pin status for projects — response body — statuses array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The pin status of an issue panel (added by a Forge app) for a single project. |
error | JSON | Optional | |
error (anyOf 1) | string | Alternative | The reason the pin status could not be read for the project. Null if the pin status was read successfully. |
error (anyOf 2) | null | Alternative | |
pinned | JSON | Optional | |
pinned (anyOf 1) | boolean | Alternative | Whether the issue panel is currently pinned to the project. |
pinned (anyOf 2) | null | Alternative | |
pinnedAt | JSON | Optional | |
pinnedAt (anyOf 1) | JSON | Alternative | |
pinnedAt (anyOf 1) (anyOf 1) | integer | Alternative | The time the issue panel was pinned to the project, in epoch milliseconds. Format: int64 |
pinnedAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pinnedAt (anyOf 2) | null | Alternative | |
projectIdOrKey | JSON | Optional | |
projectIdOrKey (anyOf 1) | string | Alternative | The project ID or key supplied in the request. |
projectIdOrKey (anyOf 2) | null | Alternative |