Class ContentPropertiesService

See

https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties

Hierarchy

CommonHttpService
- ContentPropertiesService

Index

Constructors

Methods

Constructors

constructor

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

Methods

createAttachmentProperty

createAttachmentProperty(params): Promise<ContentProperty>
Creates a new content property for an attachment.

Permissions required: Permission to update the attachment.
Parameters
- params: {
  attachmentId: string;
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  }
  - attachmentId: string
    The ID of the attachment to create a property for.
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /attachments/{attachment-id}/properties @scopes-current read:attachment:confluence, write:attachment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-post

createBlogpostProperty

createBlogpostProperty(params): Promise<ContentProperty>
Creates a new property for a blogpost.

Permissions required: Permission to update the blog post.
Parameters
- params: {
  blogpostId: number;
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  }
  - blogpostId: number
    The ID of the blog post to create a property for.
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /blogposts/{blogpost-id}/properties @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-post

createCommentProperty

createCommentProperty(params): Promise<ContentProperty>
Creates a new content property for a comment.

Permissions required: Permission to update the comment.
Parameters
- params: {
  commentId: number;
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  }
  - commentId: number
    The ID of the comment to create a property for.
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /comments/{comment-id}/properties @scopes-current read:comment:confluence, write:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-post

createCustomContentProperty

createCustomContentProperty(params): Promise<ContentProperty>
Creates a new content property for a piece of custom content.

Permissions required: Permission to update the custom content.
Parameters
- params: {
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  customContentId: number;
  }
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
  - customContentId: number
    The ID of the custom content to create a property for.
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /custom-content/{custom-content-id}/properties @scopes-current read:custom-content:confluence, write:custom-content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-post

createDatabaseProperty

createDatabaseProperty(params): Promise<ContentProperty>
Creates a new content property for a database.

Permissions required: Permission to update the database.
Parameters
- params: {
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  id: number;
  }
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
  - id: number
    The ID of the database to create a property for.
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /databases/{id}/properties @scopes-current read:database:confluence, write:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-post

createFolderProperty

createFolderProperty(params): Promise<ContentProperty>
Creates a new content property for a folder.

Permissions required: Permission to update the folder.
Parameters
- params: {
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  id: number;
  }
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
  - id: number
    The ID of the folder to create a property for.
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /folders/{id}/properties @scopes-current read:folder:confluence, write:folder:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-folders-id-properties-post

createPageProperty

createPageProperty(params): Promise<ContentProperty>
Creates a new content property for a page.

Permissions required: Permission to update the page.
Parameters
- params: {
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  pageId: number;
  }
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
  - pageId: number
    The ID of the page to create a property for.
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /pages/{page-id}/properties @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-post

createSmartLinkProperty

createSmartLinkProperty(params): Promise<ContentProperty>
Creates a new content property for a Smart Link in the content tree.

Permissions required: Permission to update the Smart Link in the content tree.
Parameters
- params: {
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  id: number;
  }
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
  - id: number
    The ID of the Smart Link in the content tree to create a property for.
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /embeds/{id}/properties @scopes-current read:embed:confluence, write:embed:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-post

createWhiteboardProperty

createWhiteboardProperty(params): Promise<ContentProperty>
Creates a new content property for a whiteboard.

Permissions required: Permission to update the whiteboard.
Parameters
- params: {
  contentPropertyCreateRequest: ContentPropertyCreateRequest;
  id: number;
  }
  - contentPropertyCreateRequest: ContentPropertyCreateRequest
    The content property to be created
  - id: number
    The ID of the whiteboard to create a property for.
Returns Promise<ContentProperty>
Returned if the content property was created successfully.

Path
POST /whiteboards/{id}/properties @scopes-current read:whiteboard:confluence, write:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-post

deleteAttachmentPropertyById

deleteAttachmentPropertyById(params): Promise<void>
Deletes a content property for an attachment by its id.

Permissions required: Permission to attachment the page.
Parameters
- params: {
  attachmentId: string;
  propertyId: number;
  }
  - attachmentId: string
    The ID of the attachment the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /attachments/{attachment-id}/properties/{property-id} @scopes-current read:attachment:confluence, write:attachment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-delete

deleteBlogpostPropertyById

deleteBlogpostPropertyById(params): Promise<void>
Deletes a content property for a blogpost by its id.

Permissions required: Permission to edit the blog post.
Parameters
- params: {
  blogpostId: number;
  propertyId: number;
  }
  - blogpostId: number
    The ID of the blog post the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /blogposts/{blogpost-id}/properties/{property-id} @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-delete

deleteCommentPropertyById

deleteCommentPropertyById(params): Promise<void>
Deletes a content property for a comment by its id.

Permissions required: Permission to edit the comment.
Parameters
- params: {
  commentId: number;
  propertyId: number;
  }
  - commentId: number
    The ID of the comment the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /comments/{comment-id}/properties/{property-id} @scopes-current read:comment:confluence, write:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-delete

deleteCustomContentPropertyById

deleteCustomContentPropertyById(params): Promise<void>
Deletes a content property for a piece of custom content by its id.

Permissions required: Permission to edit the custom content.
Parameters
- params: {
  customContentId: number;
  propertyId: number;
  }
  - customContentId: number
    The ID of the custom content the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /custom-content/{custom-content-id}/properties/{property-id} @scopes-current read:custom-content:confluence, write:custom-content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-delete

deleteDatabasePropertyById

deleteDatabasePropertyById(params): Promise<void>
Deletes a content property for a database by its id.

Permissions required: Permission to edit the database.
Parameters
- params: {
  databaseId: number;
  propertyId: number;
  }
  - databaseId: number
    The ID of the database the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /databases/{database-id}/properties/{property-id} @scopes-current read:database:confluence, write:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-delete

deleteFolderPropertyById

deleteFolderPropertyById(params): Promise<void>
Deletes a content property for a folder by its id.

Permissions required: Permission to edit the folder.
Parameters
- params: {
  folderId: number;
  propertyId: number;
  }
  - folderId: number
    The ID of the folder the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /folders/{folder-id}/properties/{property-id} @scopes-current read:folder:confluence, write:folder:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-folders-folder-id-properties-property-id-delete

deletePagePropertyById

deletePagePropertyById(params): Promise<void>
Deletes a content property for a page by its id.

Permissions required: Permission to edit the page.
Parameters
- params: {
  pageId: number;
  propertyId: number;
  }
  - pageId: number
    The ID of the page the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /pages/{page-id}/properties/{property-id} @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-delete

deleteSmartLinkPropertyById

deleteSmartLinkPropertyById(params): Promise<void>
Deletes a content property for a Smart Link in the content tree by its id.

Permissions required: Permission to edit the Smart Link in the content tree.
Parameters
- params: {
  embedId: number;
  propertyId: number;
  }
  - embedId: number
    The ID of the Smart Link in the content tree the property belongs to.
  - propertyId: number
    The ID of the property to be deleted.
Returns Promise<void>
Path
DELETE /embeds/{embed-id}/properties/{property-id} @scopes-current read:embed:confluence, write:embed:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-delete

deleteWhiteboardPropertyById

deleteWhiteboardPropertyById(params): Promise<void>
Deletes a content property for a whiteboard by its id.

Permissions required: Permission to edit the whiteboard.
Parameters
- params: {
  propertyId: number;
  whiteboardId: number;
  }
  - propertyId: number
    The ID of the property to be deleted.
  - whiteboardId: number
    The ID of the whiteboard the property belongs to.
Returns Promise<void>
Path
DELETE /whiteboards/{whiteboard-id}/properties/{property-id} @scopes-current read:whiteboard:confluence, write:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-delete

getAttachmentContentProperties

getAttachmentContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves all Content Properties tied to a specified attachment.

Permissions required: Permission to view the attachment.
Parameters
- params: {
      attachmentId: string;
      cursor?: string;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - attachmentId: string
    The ID of the attachment for which content properties should be returned.
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /attachments/{attachment-id}/properties @scopes-current read:attachment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-get

getAttachmentContentPropertiesById

getAttachmentContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified attachment.

Permissions required: Permission to view the attachment.
Parameters
- params: {
  attachmentId: string;
  propertyId: number;
  }
  - attachmentId: string
    The ID of the attachment for which content properties should be returned.
  - propertyId: number
    The ID of the content property to be returned
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /attachments/{attachment-id}/properties/{property-id} @scopes-current read:attachment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-get

getBlogpostContentProperties

getBlogpostContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves all Content Properties tied to a specified blog post.

Permissions required: Permission to view the blog post.
Parameters
- params: {
      blogpostId: number;
      cursor?: string;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - blogpostId: number
    The ID of the blog post for which content properties should be returned.
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /blogposts/{blogpost-id}/properties @scopes-current read:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-get

getBlogpostContentPropertiesById

getBlogpostContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified blog post.

Permissions required: Permission to view the blog post.
Parameters
- params: {
  blogpostId: number;
  propertyId: number;
  }
  - blogpostId: number
    The ID of the blog post for which content properties should be returned.
  - propertyId: number
    The ID of the property being requested
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /blogposts/{blogpost-id}/properties/{property-id} @scopes-current read:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-get

getCommentContentProperties

getCommentContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties attached to a specified comment.

Permissions required: Permission to view the comment.
Parameters
- params: {
      commentId: number;
      cursor?: string;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - commentId: number
    The ID of the comment for which content properties should be returned.
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /comments/{comment-id}/properties @scopes-current read:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-get

getCommentContentPropertiesById

getCommentContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified comment.

Permissions required: Permission to view the comment.
Parameters
- params: {
  commentId: number;
  propertyId: number;
  }
  - commentId: number
    The ID of the comment for which content properties should be returned.
  - propertyId: number
    The ID of the content property being requested.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /comments/{comment-id}/properties/{property-id} @scopes-current read:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-get

getCustomContentContentProperties

getCustomContentContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties tied to a specified custom content.

Permissions required: Permission to view the custom content.
Parameters
- params: {
      cursor?: string;
      customContentId: number;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - customContentId: number
    The ID of the custom content for which content properties should be returned.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /custom-content/{custom-content-id}/properties @scopes-current read:custom-content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-get

getCustomContentContentPropertiesById

getCustomContentContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified custom content.

Permissions required: Permission to view the page.
Parameters
- params: {
  customContentId: number;
  propertyId: number;
  }
  - customContentId: number
    The ID of the custom content for which content properties should be returned.
  - propertyId: number
    The ID of the content property being requested.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /custom-content/{custom-content-id}/properties/{property-id} @scopes-current read:custom-content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-get

getDatabaseContentProperties

getDatabaseContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties tied to a specified database.

Permissions required: Permission to view the database.
Parameters
- params: {
      cursor?: string;
      id: number;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - id: number
    The ID of the database for which content properties should be returned.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /databases/{id}/properties @scopes-current read:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-get

getDatabaseContentPropertiesById

getDatabaseContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified database.

Permissions required: Permission to view the database.
Parameters
- params: {
  databaseId: number;
  propertyId: number;
  }
  - databaseId: number
    The ID of the database for which content properties should be returned.
  - propertyId: number
    The ID of the content property being requested.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /databases/{database-id}/properties/{property-id} @scopes-current read:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-get

getFolderContentProperties

getFolderContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties tied to a specified folder.

Permissions required: Permission to view the folder.
Parameters
- params: {
      cursor?: string;
      id: number;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - id: number
    The ID of the folder for which content properties should be returned.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /folders/{id}/properties @scopes-current read:folder:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-folders-id-properties-get

getFolderContentPropertiesById

getFolderContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified folder.

Permissions required: Permission to view the folder.
Parameters
- params: {
  folderId: number;
  propertyId: number;
  }
  - folderId: number
    The ID of the folder for which content properties should be returned.
  - propertyId: number
    The ID of the content property being requested.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /folders/{folder-id}/properties/{property-id} @scopes-current read:folder:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-folders-folder-id-properties-property-id-get

getPageContentProperties

getPageContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties tied to a specified page.

Permissions required: Permission to view the page.
Parameters
- params: {
      cursor?: string;
      key?: string;
      limit?: number;
      pageId: number;
      sort?: ContentPropertySortOrder;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - pageId: number
    The ID of the page for which content properties should be returned.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /pages/{page-id}/properties @scopes-current read:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-get

getPageContentPropertiesById

getPageContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified page.

Permissions required: Permission to view the page.
Parameters
- params: {
  pageId: number;
  propertyId: number;
  }
  - pageId: number
    The ID of the page for which content properties should be returned.
  - propertyId: number
    The ID of the content property being requested.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /pages/{page-id}/properties/{property-id} @scopes-current read:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-get

getSmartLinkContentProperties

getSmartLinkContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties tied to a specified Smart Link in the content tree.

Permissions required: Permission to view the Smart Link in the content tree.
Parameters
- params: {
      cursor?: string;
      id: number;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - id: number
    The ID of the Smart Link in the content tree for which content properties should be returned.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of Smart Links per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /embeds/{id}/properties @scopes-current read:embed:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-get

getSmartLinkContentPropertiesById

getSmartLinkContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified Smart Link in the content tree.

Permissions required: Permission to view the Smart Link in the content tree.
Parameters
- params: {
  embedId: number;
  propertyId: number;
  }
  - embedId: number
    The ID of the Smart Link in the content tree for which content properties should be returned.
  - propertyId: number
    The ID of the content property being requested.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /embeds/{embed-id}/properties/{property-id} @scopes-current read:embed:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-get

getWhiteboardContentProperties

getWhiteboardContentProperties(params): Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Retrieves Content Properties tied to a specified whiteboard.

Permissions required: Permission to view the whiteboard.
Parameters
- params: {
      cursor?: string;
      id: number;
      key?: string;
      limit?: number;
      sort?: ContentPropertySortOrder;
  }
  - Optionalcursor?: string
    Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
  - id: number
    The ID of the whiteboard for which content properties should be returned.
  - Optionalkey?: string
    Filters the response to return a specific content property with matching key (case sensitive).
  - Optionallimit?: number
    Maximum number of attachments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
  - Optionalsort?: ContentPropertySortOrder
    Used to sort the result by a particular field.
Returns Promise<{
    _links?: MultiEntityLinks;
    results?: ContentProperty[];
} & {
    [key: string]: unknown;
}>
Returned if the requested content properties are successfully retrieved.

Path
GET /whiteboards/{id}/properties @scopes-current read:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-get

getWhiteboardContentPropertiesById

getWhiteboardContentPropertiesById(params): Promise<ContentProperty>
Retrieves a specific Content Property by ID that is attached to a specified whiteboard.

Permissions required: Permission to view the whiteboard.
Parameters
- params: {
  propertyId: number;
  whiteboardId: number;
  }
  - propertyId: number
    The ID of the content property being requested.
  - whiteboardId: number
    The ID of the whiteboard for which content properties should be returned.
Returns Promise<ContentProperty>
Returned if the requested content property is successfully retrieved.

Path
GET /whiteboards/{whiteboard-id}/properties/{property-id} @scopes-current read:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-get

updateAttachmentPropertyById

updateAttachmentPropertyById(params): Promise<ContentProperty>
Update a content property for attachment by its id.

Permissions required: Permission to edit the attachment.
Parameters
- params: {
      attachmentId: string;
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      propertyId: number;
  }
  - attachmentId: string
    The ID of the attachment the property belongs to.
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /attachments/{attachment-id}/properties/{property-id} @scopes-current read:attachment:confluence, write:attachment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-put

updateBlogpostPropertyById

updateBlogpostPropertyById(params): Promise<ContentProperty>
Update a content property for blog post by its id.

Permissions required: Permission to edit the blog post.
Parameters
- params: {
      blogpostId: number;
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      propertyId: number;
  }
  - blogpostId: number
    The ID of the blog post the property belongs to.
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /blogposts/{blogpost-id}/properties/{property-id} @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-put

updateCommentPropertyById

updateCommentPropertyById(params): Promise<ContentProperty>
Update a content property for a comment by its id.

Permissions required: Permission to edit the comment.
Parameters
- params: {
      commentId: number;
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      propertyId: number;
  }
  - commentId: number
    The ID of the comment the property belongs to.
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /comments/{comment-id}/properties/{property-id} @scopes-current read:comment:confluence, write:comment:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-put

updateCustomContentPropertyById

updateCustomContentPropertyById(params): Promise<ContentProperty>
Update a content property for a piece of custom content by its id.

Permissions required: Permission to edit the custom content.
Parameters
- params: {
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      customContentId: number;
      propertyId: number;
  }
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - customContentId: number
    The ID of the custom content the property belongs to.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /custom-content/{custom-content-id}/properties/{property-id} @scopes-current read:custom-content:confluence, write:custom-content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-put

updateDatabasePropertyById

updateDatabasePropertyById(params): Promise<ContentProperty>
Update a content property for a database by its id.

Permissions required: Permission to edit the database.
Parameters
- params: {
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      databaseId: number;
      propertyId: number;
  }
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - databaseId: number
    The ID of the database the property belongs to.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /databases/{database-id}/properties/{property-id} @scopes-current read:database:confluence, write:database:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-put

updateFolderPropertyById

updateFolderPropertyById(params): Promise<ContentProperty>
Update a content property for a folder by its id.

Permissions required: Permission to edit the folder.
Parameters
- params: {
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      folderId: number;
      propertyId: number;
  }
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - folderId: number
    The ID of the folder the property belongs to.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /folders/{folder-id}/properties/{property-id} @scopes-current read:folder:confluence, write:folder:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-folders-folder-id-properties-property-id-put

updatePagePropertyById

updatePagePropertyById(params): Promise<ContentProperty>
Update a content property for a page by its id.

Permissions required: Permission to edit the page.
Parameters
- params: {
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      pageId: number;
      propertyId: number;
  }
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - pageId: number
    The ID of the page the property belongs to.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /pages/{page-id}/properties/{property-id} @scopes-current read:page:confluence, write:page:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-put

updateSmartLinkPropertyById

updateSmartLinkPropertyById(params): Promise<ContentProperty>
Update a content property for a Smart Link in the content tree by its id.

Permissions required: Permission to edit the Smart Link in the content tree.
Parameters
- params: {
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      embedId: number;
      propertyId: number;
  }
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - embedId: number
    The ID of the Smart Link in the content tree the property belongs to.
  - propertyId: number
    The ID of the property to be updated.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /embeds/{embed-id}/properties/{property-id} @scopes-current read:embed:confluence, write:embed:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-put

updateWhiteboardPropertyById

updateWhiteboardPropertyById(params): Promise<ContentProperty>
Update a content property for a whiteboard by its id.

Permissions required: Permission to edit the whiteboard.
Parameters
- params: {
      contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
      propertyId: number;
      whiteboardId: number;
  }
  - contentPropertyUpdateRequest: ContentPropertyUpdateRequest
    The content property to be updated.
  - propertyId: number
    The ID of the property to be updated.
  - whiteboardId: number
    The ID of the whiteboard the property belongs to.
Returns Promise<ContentProperty>
Returned if the content property was updated successfully.

Path
PUT /whiteboards/{whiteboard-id}/properties/{property-id} @scopes-current read:whiteboard:confluence, write:whiteboard:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class ContentPropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ContentPropertiesService

Methods

createAttachmentProperty

Parameters

attachmentId: string

contentPropertyCreateRequest: ContentPropertyCreateRequest

Returns Promise<ContentProperty>

Path

See

createBlogpostProperty

Parameters

blogpostId: number

contentPropertyCreateRequest: ContentPropertyCreateRequest

Returns Promise<ContentProperty>

Path

See

createCommentProperty

Parameters

commentId: number

contentPropertyCreateRequest: ContentPropertyCreateRequest

Returns Promise<ContentProperty>

Path

See

createCustomContentProperty

Parameters

contentPropertyCreateRequest: ContentPropertyCreateRequest

customContentId: number

Returns Promise<ContentProperty>

Path

See

createDatabaseProperty

Parameters

contentPropertyCreateRequest: ContentPropertyCreateRequest

id: number

Returns Promise<ContentProperty>

Path

See

createFolderProperty

Parameters

contentPropertyCreateRequest: ContentPropertyCreateRequest

id: number

Returns Promise<ContentProperty>

Path

See

createPageProperty

Parameters

contentPropertyCreateRequest: ContentPropertyCreateRequest

pageId: number

Returns Promise<ContentProperty>

Path

See

createSmartLinkProperty

Parameters

contentPropertyCreateRequest: ContentPropertyCreateRequest

id: number

Returns Promise<ContentProperty>

Path

See

createWhiteboardProperty

Parameters

contentPropertyCreateRequest: ContentPropertyCreateRequest

id: number

Returns Promise<ContentProperty>

Path

See

deleteAttachmentPropertyById

Parameters

attachmentId: string

propertyId: number

Returns Promise<void>

`Optional`cursor?: string

`Optional`key?: string

`Optional`limit?: number

`Optional`sort?: ContentPropertySortOrder

Returns Promise<{
_links?: MultiEntityLinks;
results?: ContentProperty[];
} & {
[key: string]: unknown;
}>