Class ContentStatesService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states

Hierarchy

CommonHttpService
- ContentStatesService

Index

Constructors

Methods

getAvailableContentStates getContentState getContentStateSettings getContentsWithState getCustomContentStates getSpaceContentStates removeContentState setContentState initialize

Constructors

constructor

new ContentStatesService(getClientInstance): ContentStatesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ContentStatesService
Inherited from CommonHttpService.constructor

Methods

getAvailableContentStates

getAvailableContentStates(params): Promise<AvailableContentStates>
Gets content states that are available for the content to be set as. Will return all enabled Space Content States. Will only return most the 3 most recently published custom content states to match UI editor list. To get all custom content states, use the /content-states endpoint.

Permissions required: Permission to edit the content.
Parameters
- params: {
  id: string;
  }
  - id: string
    id of content to get available states for
Returns Promise<AvailableContentStates>
Returned if the content is found and permission is valid.

Path
GET /wiki/rest/api/content/{id}/state/available @scopes-current write:confluence-content @scopes-beta write:content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-content-id-state-available-get

getContentState

getContentState(params): Promise<ContentStateResponse>
Gets the current content state of the draft or current version of content. To specify the draft version, set the parameter status to draft, otherwise archived or current will get the relevant published state. Permissions required: Permission to view the content.
Parameters
- params: {
  id: string;
  status?: "current" | "draft" | "archived";
  }
  - id: string
    The id of the content whose content state is of interest.
  - Optionalstatus?: "current" | "draft" | "archived"
    Set status to one of [current,draft,archived]. Default value is current.
Returns Promise<ContentStateResponse>
Returned if permission allows viewing of content.

Path
GET /wiki/rest/api/content/{id}/state @scopes-current read:confluence-content.summary @scopes-beta read:content-details:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-content-id-state-get

getContentStateSettings

getContentStateSettings(params): Promise<ContentStateSettings>
Get object describing whether content states are allowed at all, if custom content states or space content states are restricted, and a list of space content states allowed for the space if they are not restricted.

Permissions required: 'Admin' permission for the space.
Parameters
- params: {
  spaceKey: string;
  }
  - spaceKey: string
    The key of the space to be queried for its content state settings.
Returns Promise<ContentStateSettings>
Returned if the requested space exists, and user has space admin permission.

Path
GET /wiki/rest/api/space/{spaceKey}/state/settings @scopes-current read:confluence-space.summary @scopes-beta read:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-space-spacekey-state-settings-get

getContentsWithState

getContentsWithState(params): Promise<ContentArray>
Returns all content that has the provided content state in a space.

If the expand query parameter is used with the body.export_view and/or body.styled_view properties, then the query limit parameter will be restricted to a maximum value of 25.

Permissions required: 'View' permission for the space.
Parameters
- params: {
      expand?: string[];
      limit?: number;
      spaceKey: string;
      start?: number;
      stateId: number;
  }
  - Optionalexpand?: string[]
    A multi-value parameter indicating which properties of the content to expand. Options include: space, version, history, children, etc.
    
    Ex: space,version
  - Optionallimit?: number
    Maximum number of results to return
  - spaceKey: string
    The key of the space to be queried for its content state settings.
  - Optionalstart?: number
    Number of result to start returning. (0 indexed)
  - stateId: number
    The id of the content state to filter content by
Returns Promise<ContentArray>
Returned if search was successful.

Path
GET /wiki/rest/api/space/{spaceKey}/state/content @scopes-current read:confluence-content.all @scopes-beta read:content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-space-spacekey-state-content-get

getCustomContentStates

getCustomContentStates(): Promise<ContentState[]>
Get custom content states that authenticated user has created.

Permissions required Must have user authentication.

Returns Promise<ContentState[]>
Custom Content States that user has crated. Returned if user authenticated.

Path
GET /wiki/rest/api/content-states @scopes-current read:user.property:confluence @scopes-beta read:user.property:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-content-states-get

getSpaceContentStates

getSpaceContentStates(params): Promise<ContentState[]>
Get content states that are suggested in the space.

Permissions required: 'View' permission for the space.
Parameters
- params: {
  spaceKey: string;
  }
  - spaceKey: string
    The key of the space to be queried for its content state settings.
Returns Promise<ContentState[]>
Returned if the requested space exists, and user has space view permission.

Path
GET /wiki/rest/api/space/{spaceKey}/state @scopes-current read:confluence-space.summary @scopes-beta read:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-space-spacekey-state-get

removeContentState

removeContentState(params): Promise<ContentStateResponse>
Removes the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new status.

Permissions required: Permission to edit the content.
Parameters
- params: {
  id: string;
  status?: "current" | "draft";
  }
  - id: string
    The Id of the content whose content state is to be set.
  - Optionalstatus?: "current" | "draft"
    status of content state from which to delete state. Can be draft or archived
Returns Promise<ContentStateResponse>
Returned if content state is removed from content.

Path
DELETE /wiki/rest/api/content/{id}/state @scopes-current write:confluence-content @scopes-beta write:content:confluence, read:content-details:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-content-id-state-delete

setContentState

setContentState(params): Promise<ContentStateResponse>
Sets the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new state.

You may pass in either an id of a state, or the name and color of a desired new state. If all 3 are passed in, id will be used. If the name and color passed in already exist under the current user's existing custom states, the existing state will be reused. If custom states are disabled in the space of the content (which can be determined by getting the content state space settings of the content's space) then this set will fail.

You may not remove a content state via this PUT request. You must use the DELETE method. A specified state is required in the body of this request.

Permissions required: Permission to edit the content.
Parameters
- params: {
      contentStateRestInput: ContentStateRestInput;
      id: string;
      status: "current" | "draft";
  }
  - contentStateRestInput: ContentStateRestInput
    Content state fields for state. Pass in id for an existing state, or new name and color for best matching existing state, or new state if allowed in space.
  - id: string
    The Id of the content whose content state is to be set.
  - status: "current" | "draft"
    Status of content onto which state will be placed. If draft, then draft state will change. If current, state will be placed onto a new version of the content with same body as previous version.
Returns Promise<ContentStateResponse>
Returned if content state is set successfully.

Path
PUT /wiki/rest/api/content/{id}/state @scopes-current write:confluence-content @scopes-beta write:content:confluence, read:content-details:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states#api-wiki-rest-api-content-id-state-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class ContentStatesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ContentStatesService

Methods

getAvailableContentStates

Parameters

id: string

Returns Promise<AvailableContentStates>

Path

See

getContentState

Parameters

id: string

Optionalstatus?: "current" | "draft" | "archived"

Returns Promise<ContentStateResponse>

Path

See

getContentStateSettings

Parameters

spaceKey: string

Returns Promise<ContentStateSettings>

Path

See

getContentsWithState

Parameters

Optionalexpand?: string[]

Optionallimit?: number

spaceKey: string

Optionalstart?: number

stateId: number

Returns Promise<ContentArray>

Path

See

getCustomContentStates

Returns Promise<ContentState[]>

Path

See

getSpaceContentStates

Parameters

spaceKey: string

Returns Promise<ContentState[]>

Path

See

removeContentState

Parameters

id: string

Optionalstatus?: "current" | "draft"

Returns Promise<ContentStateResponse>

Path

See

setContentState

Parameters

contentStateRestInput: ContentStateRestInput

id: string

status: "current" | "draft"

Returns Promise<ContentStateResponse>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`status?: "current" | "draft" | "archived"

`Optional`expand?: string[]

`Optional`limit?: number

`Optional`start?: number

`Optional`status?: "current" | "draft"

`Protected` `Static`initialize