embeds
create-smart-link
Create Smart Link in the content tree
Creates a Smart Link in the content tree in the space.
Permissions required: Permission to view the corresponding space. Permission to create a Smart Link in the content tree in the space.
POST /embeds
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
cf embeds create-smart-linkcreate-smart-link-property
Create content property for Smart Link in the content tree
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.
POST /embeds/{id}/properties
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--id | string | Yes | The ID of the Smart Link in the content tree to create a property for. |
Example:
cf embeds create-smart-link-property --id <id>delete-smart-link
Delete Smart Link in the content tree
Delete a Smart Link in the content tree by id.
Deleting a Smart Link in the content tree moves the Smart Link to the trash, where it can be restored later
Permissions required: Permission to view the Smart Link in the content tree and its corresponding space. Permission to delete Smart Links in the content tree in the space.
DELETE /embeds/{id}
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the Smart Link in the content tree to be deleted. |
Example:
cf embeds delete-smart-link --id <id>delete-smart-link-property-by-id
Delete content property for Smart Link in the content tree by id
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.
DELETE /embeds/{embed-id}/properties/{property-id}
| Flag | Type | Required | Description |
|---|---|---|---|
--embed-id | string | Yes | The ID of the Smart Link in the content tree the property belongs to. |
--property-id | string | Yes | The ID of the property to be deleted. |
Example:
cf embeds delete-smart-link-property-by-id --embed-id <embed-id> --property-id <property-id>get-smart-link-ancestors
Get all ancestors of Smart Link in content tree
Returns all ancestors for a given Smart Link in the content tree by ID in top-to-bottom order (that is, the highest ancestor is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the ID of first ancestor in the response payload.
This endpoint returns minimal information about each ancestor. To fetch more details, use a related endpoint, such as Get Smart Link in the content tree by id.
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the Smart Link in the content tree and its corresponding space
GET /embeds/{id}/ancestors
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the Smart Link in the content tree. |
--limit | string | No | Maximum number of items per result to return. If more results exist, call the endpoint with the highest ancestor's ID to fetch the next set of results. |
Example:
cf embeds get-smart-link-ancestors --id <id>get-smart-link-by-id
Get Smart Link in the content tree by id
Returns a specific Smart Link in the content tree.
Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.
GET /embeds/{id}
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the Smart Link in the content tree to be returned. |
--include-collaborators | string | No | Includes collaborators on the Smart Link. |
--include-direct-children | string | No | Includes direct children of the Smart Link, as defined in the ChildrenResponse object. |
--include-operations | string | No | Includes operations associated with this Smart Link in the response, as defined in the Operation object. |
| The number of results will be limited to 50 and sorted in the default sort order. | |||
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. | |||
--include-properties | string | No | Includes content properties associated with this Smart Link in the response. |
| The number of results will be limited to 50 and sorted in the default sort order. | |||
A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results. |
Example:
cf embeds get-smart-link-by-id --id <id>get-smart-link-content-properties
Get content properties for Smart Link in the content tree
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.
GET /embeds/{id}/properties
| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | 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 | string | Yes | The ID of the Smart Link in the content tree for which content properties should be returned. |
--key | string | No | Filters the response to return a specific content property with matching key (case sensitive). |
--limit | string | No | 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. |
--sort | string | No | Used to sort the result by a particular field. |
Example:
cf embeds get-smart-link-content-properties --id <id>get-smart-link-content-properties-by-id
Get content property for Smart Link in the content tree by id
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.
GET /embeds/{embed-id}/properties/{property-id}
| Flag | Type | Required | Description |
|---|---|---|---|
--embed-id | string | Yes | The ID of the Smart Link in the content tree for which content properties should be returned. |
--property-id | string | Yes | The ID of the content property being requested. |
Example:
cf embeds get-smart-link-content-properties-by-id --embed-id <embed-id> --property-id <property-id>get-smart-link-descendants
Get descendants of a smart link
Returns descendants in the content tree for a given smart link by ID in top-to-bottom order (that is, the highest descendant is the first item in the response payload). The number of results is limited by the limit parameter and additional results (if available) will be available by calling this endpoint with the cursor in the response payload. There is also a depth parameter specifying depth of descendants to be fetched.
The following types of content will be returned:
- Database
- Embed
- Folder
- Page
- Whiteboard
This endpoint returns minimal information about each descendant. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Permission to view the smart link and its corresponding space
GET /embeds/{id}/descendants
| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | 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. |
--depth | string | No | Maximum depth of descendants to return. If more results are required, use the endpoint corresponding to the content type of the deepest descendant to fetch more descendants. |
--id | string | Yes | The ID of the smart link. |
--limit | string | No | Maximum number of items per result to return. If more results exist, call the endpoint with the cursor to fetch the next set of results. |
Example:
cf embeds get-smart-link-descendants --id <id>get-smart-link-direct-children
Get direct children of a Smart Link
Returns all children for given smart link id in the content tree. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.
The following types of content will be returned:
- Database
- Embed
- Folder
- Page
- Whiteboard
This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:
Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.
GET /embeds/{id}/direct-children
| Flag | Type | Required | Description |
|---|---|---|---|
--cursor | string | No | 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 | string | Yes | The ID of the parent smart link. |
--limit | string | No | Maximum number of items 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. |
--sort | string | No | Used to sort the result by a particular field. |
Example:
cf embeds get-smart-link-direct-children --id <id>get-smart-link-operations
Get permitted operations for a Smart Link in the content tree
Returns the permitted operations on specific Smart Link in the content tree.
Permissions required: Permission to view the Smart Link in the content tree and its corresponding space.
GET /embeds/{id}/operations
| Flag | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | The ID of the Smart Link in the content tree for which operations should be returned. |
Example:
cf embeds get-smart-link-operations --id <id>update-smart-link-property-by-id
Update content property for Smart Link in the content tree by id
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.
PUT /embeds/{embed-id}/properties/{property-id}
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--embed-id | string | Yes | The ID of the Smart Link in the content tree the property belongs to. |
--property-id | string | Yes | The ID of the property to be updated. |
Example:
cf embeds update-smart-link-property-by-id --embed-id <embed-id> --property-id <property-id>