ATatlassian
Status Page

Batch process draft components

Create, update, or delete draft components for a Status page in a single batch operation.

post/stakeholder-comms/cloudId/{cloudId}/api/components/batch_process

Request

  • Base URL
    https://api.atlassian.com/jsm/ops
  • URL
    https://api.atlassian.com/jsm/ops/stakeholder-comms/cloudId/{cloudId}/api/components/batch_process
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.stg.atlassian.com/authorize
      Token URL: https://auth.stg.atlassian.com/oauth/token scopes: write:stakeholder-comms.component:jira-service-management

Request body

pageIdstring

Identifier of the page to process components for.

deleteComponentsstring[]

IDs of components to delete.

Response

Returned if the batch operation is successfully processed.

idstring

Unique identifier of the component.

namestring

Name of the component.

pageIdstring

Identifier of the page this component belongs to.

serviceIdstring

Identifier of the linked service.

status'OPERATIONAL' | 'DEGRADED_PERFORMANCE' | 'PARTIAL_OUTAGE' | 'MAJOR_OUTAGE' | 'UNDER_MAINTENANCE'

Current status of the component.

type'COMPONENT' | 'GROUP_COMPONENT'

Type of the component.

descriptionstring

Description of the component.

positioninteger

Display position of the component.

componentsStakeholderCommsNestedComponent[] circular

Changes

No recorded changes to this operation across all 5 revisions of this API.