{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Identifiers API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Identifiers", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Addon Linkers Key Values Value Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/addon/linkers/:linker_key/values/:value_id", "params": [ { "name": "linker_key", "value": "", "type": "path", "description": "The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor." }, { "name": "value_id", "value": "", "type": "path", "description": "The numeric ID of the linker value." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application." }, { "info": { "name": "Atlassian Delete Addon Linkers Key Values Value Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.atlassian.com/addon/linkers/:linker_key/values/:value_id", "params": [ { "name": "linker_key", "value": "", "type": "path", "description": "The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor." }, { "name": "value_id", "value": "", "type": "path", "description": "The numeric ID of the linker value." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.atlassian.com/authorize", "accessTokenUrl": "https://auth.atlassian.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application." }, { "info": { "name": "Atlassian Get Content by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be returned. If you don't know the content ID,\nuse [Get content](#api-content-get) and filter the results." }, { "name": "status", "value": "", "type": "query", "description": "Filter the results to a set of content based on their status.\nIf set to `any`, content with any status is returned. Note, the\n`historical` status is currently not supported." }, { "name": "version", "value": "", "type": "query", "description": "The version number of the content to be returned." }, { "name": "embeddedContentRender", "value": "", "type": "query", "description": "The version of embedded content (e.g. attachments) to render.\n\n- current renders the latest version of the embedded content.\n- version-at-save renders the version of the embedded content\nat the time of save." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment." }, { "name": "trigger", "value": "", "type": "query", "description": "If set to `viewed`, the request will trigger a 'viewed' event for the content.\nWhen this event is triggered, the page/blogpost will appear on the 'Recently visited'\ntab of the user's Confluence dashboard." } ] }, "docs": "The Get Content By Id operation retrieves a single piece of content from Atlassian Confluence using its unique identifier. This REST API endpoint accepts the content ID as a path parameter and returns detailed information about the specified content, including its type (page, blog post, comment, etc.), title, body, version information, space details, metadata, and associated properties. The response can be customized using query parameters to expand specific fields, limit the body representation" }, { "info": { "name": "Atlassian Get Macro Body by Macro Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/history/:version/macro/id/:macroId", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the content that contains the macro." }, { "name": "version", "value": "", "type": "path", "description": "The version of the content that contains the macro. Specifying `0` as the `version` will return\nthe macro body for the latest content version." }, { "name": "macroId", "value": "", "type": "path", "description": "The ID of the macro. This is usually passed by the app that the\nmacro is in. Otherwise, find the macro ID by querying the desired\ncontent and version, then expanding the body in storage format.\nFor example, '/content/196611/version/7?expand=content.body.storage'." } ] }, "docs": "Retrieves the body content of a specific macro identified by its macro ID within a particular version of a Confluence page. This endpoint requires three path parameters: the content ID of the page, the version number of that content, and the unique macro ID whose body you want to retrieve. It's particularly useful when you need to extract or inspect the content of a specific macro instance that existed in a historical version of a page, allowing developers to access macro parameters, content, or" }, { "info": { "name": "Atlassian Get Macro Body by Macro Id and Convert the Representation Synchronously", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/history/:version/macro/id/:macroId/convert/:to", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for the content that contains the macro." }, { "name": "version", "value": "", "type": "path", "description": "The version of the content that contains the macro. Specifying `0` as the `version` will return\nthe macro body for the latest content version." }, { "name": "macroId", "value": "", "type": "path", "description": "The ID of the macro. This is usually passed by the app that the\nmacro is in. Otherwise, find the macro ID by querying the desired\ncontent and version, then expanding the body in storage format.\nFor example, '/content/196611/version/7?expand=content.body.storage'." }, { "name": "to", "value": "", "type": "path", "description": "The content representation to return the macro in." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the\n`to` conversion format and may be irrelevant for certain conversions (e.g. `macroRenderedOutput` is redundant when\nconverting to `view` format). \n\nIf rendering to `view` format, and the body content being converted includes arbitrary nested content (such as macros); then it is \nnecessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for\nany nested dynamic content (i.e. macros).\n\n- `embeddedContent` returns metadata for nested content (e.g. page included using page include macro)\n- `mediaToken` returns JWT token for retrieving attachment data from Media API\n- `macroRenderedOutput` additionally converts body to view format\n- `webresource.superbatch.uris.js` returns all common JS dependencies as static URLs\n- `webresource.superbatch.uris.css` returns all common CSS dependencies as static URLs\n- `webresource.superbatch.uris.all` returns all common dependencies as static URLs\n- `webresource.superbatch.tags.all` returns all common JS dependencies as html `