Private clientAdds a list of labels to the specified content. The body is the json representation of the list.
Optional callback: undefinedAdd one or more attachments to a Confluence Content entity, with optional comments.
Comments are optional, but if included there must be as many comments as there are files, and the comments must be in the same order as the files.
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
The name of the multipart/form-data parameter that contains attachments must be "file"
A simple example to attach a file called "myfile.txt" to the container with id "123", with a comment included: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "comment=This is my File" http://myhost/rest/api/content/123/child/attachment A example to attach a file called "myfile.txt" to the container with id "123", with a comment, and set the minorEdits flag to be true: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This is my File" http://myhost/rest/api/content/123/child/attachment An example to attach the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment
Add one or more attachments to a Confluence Content entity, with optional comments.
Comments are optional, but if included there must be as many comments as there are files, and the comments must be in the same order as the files.
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
The name of the multipart/form-data parameter that contains attachments must be "file"
A simple example to attach a file called "myfile.txt" to the container with id "123", with a comment included: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "comment=This is my File" http://myhost/rest/api/content/123/child/attachment A example to attach a file called "myfile.txt" to the container with id "123", with a comment, and set the minorEdits flag to be true: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This is my File" http://myhost/rest/api/content/123/child/attachment An example to attach the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment
Optional callback: undefinedCreates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a new piece of content will be created and all metadata from the draft will be transferred into the newly created content.
Creates a new piece of Content or publishes the draft if the content id is present.For the case publishing draft, a new piece of content will be created and all metadata from the draft will be transferred into the newly created content.
Optional parameters: ServerParameters.CreateContentOptional callback: undefinedCreates a new content property.
Creates a new content property.
Optional callback: undefinedCreates a new content property.
Creates a new content property.
Optional callback: undefinedTrashes or purges a piece of Content, based on its ContentType and ContentStatus. There are three cases:
current, it will be trashed.trashed and the "status" query parameter in the request is "trashed",
the content will be purged from the trash and deleted permanently.Trashes or purges a piece of Content, based on its ContentType and ContentStatus. There are three cases:
current, it will be trashed.trashed and the "status" query parameter in the request is "trashed",
the content will be purged from the trash and deleted permanently.Optional callback: undefinedDeletes a content property.
Deletes a content property.
Optional callback: undefinedDeletes a labels to the specified content. When calling this method through REST the label parameter doesn't accept "/" characters in label names, because of security constraints. For this case please use the query parameter version of this method (/content/{id}/label?name={label}Responses
Deletes a labels to the specified content. When calling this method through REST the label parameter doesn't accept "/" characters in label names, because of security constraints. For this case please use the query parameter version of this method (/content/{id}/label?name={label}Responses
Optional callback: undefinedDeletes a labels to the specified content.
Deletes a labels to the specified content.
Optional callback: undefinedReturns a paginated list of attachment Content entities within a single container.
Returns a paginated list of attachment Content entities within a single container.
Optional callback: undefinedReturns a paginated list of Content.
Returns a paginated list of Content.
Optional parameters: ServerParameters.GetContentOptional callback: undefinedReturns a piece of Content.
Returns a piece of Content.
Optional callback: undefinedReturns a map of the direct children of a piece of Content. Content can have multiple types of children - for example a Page can have children that are also Pages, but it can also have Comments and Attachments.
The ContentType(s) of the children returned is specified by the "expand" query parameter in the request - this parameter can include expands for multiple child types.
If no types are included in the expand parameter, the map returned will just list the child types that are available to be expanded for the Content referenced by the "id" path parameter.
Returns a map of the direct children of a piece of Content. Content can have multiple types of children - for example a Page can have children that are also Pages, but it can also have Comments and Attachments.
The ContentType(s) of the children returned is specified by the "expand" query parameter in the request - this parameter can include expands for multiple child types.
If no types are included in the expand parameter, the map returned will just list the child types that are available to be expanded for the Content referenced by the "id" path parameter.
Optional callback: undefinedReturns the direct children of a piece of Content, limited to a single child type.
The ContentType(s) of the children returned is specified by the "type" path parameter in the request.
Returns the direct children of a piece of Content, limited to a single child type.
The ContentType(s) of the children returned is specified by the "type" path parameter in the request.
Optional callback: undefinedReturns the comments of a content
Returns the comments of a content
Optional callback: undefinedReturns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for example a Page can have descendants that are also Pages, but it can also have Comments and Attachments.
The ContentType(s) of the descendants returned is specified by the "expand" query parameter in the request - this parameter can include expands for multiple descendant types.
If no types are included in the expand parameter, the map returned will just list the descendant types that are available to be expanded for the Content referenced by the "id" path parameter.
Currently the only supported descendants are comment descendants of non-comment Content.
Returns a map of the descendants of a piece of Content. Content can have multiple types of descendants - for example a Page can have descendants that are also Pages, but it can also have Comments and Attachments.
The ContentType(s) of the descendants returned is specified by the "expand" query parameter in the request - this parameter can include expands for multiple descendant types.
If no types are included in the expand parameter, the map returned will just list the descendant types that are available to be expanded for the Content referenced by the "id" path parameter.
Currently the only supported descendants are comment descendants of non-comment Content.
Optional callback: undefinedReturns the direct descendants of a piece of Content, limited to a single descendant type.
The ContentType(s) of the descendants returned is specified by the "type" path parameter in the request.
Currently the only supported descendants are comment descendants of non-comment Content.
Returns the direct descendants of a piece of Content, limited to a single descendant type.
The ContentType(s) of the descendants returned is specified by the "type" path parameter in the request.
Currently the only supported descendants are comment descendants of non-comment Content.
Optional callback: undefinedReturns the list of labels on a piece of Content.
Returns the list of labels on a piece of Content.
Optional callback: undefinedReturns a paginated list of content properties.
Returns a paginated list of content properties.
Optional callback: undefinedReturns a content property.
Returns a content property.
Optional callback: undefinedReturns the history of a particular piece of content
Returns the history of a particular piece of content
Optional callback: undefinedReturns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect applications that require the body of macro to perform their work.
The hash is generated by connect during render time of the local macro holder and is usually only relevant during the scope of one request. For optimisation purposes, this hash will usually live for multiple requests.
Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with macroIds. This resource is currently only called from connect addons which will eventually all use the #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String) resource.
To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored macroId. This will allow add ons to work during the migration period.
Returns the body of a macro (in storage format) with the given hash. This resource is primarily used by connect applications that require the body of macro to perform their work.
The hash is generated by connect during render time of the local macro holder and is usually only relevant during the scope of one request. For optimisation purposes, this hash will usually live for multiple requests.
Collecting a macro by its hash should now be considered deprecated and will be replaced, transparently with macroIds. This resource is currently only called from connect addons which will eventually all use the #getContentById(com.atlassian.confluence.api.model.content.id.ContentId, java.util.List, Integer, String) resource.
To make the migration as seamless as possible, this resource will match macros against a generated hash or a stored macroId. This will allow add ons to work during the migration period.
Optional callback: undefinedReturns the body of a macro (in storage format) with the given id. This resource is primarily used by connect applications that require the body of macro to perform their work.
When content is created, if no macroId is specified, then Confluence will generate a random id. The id is persisted as the content is saved and only modified by Confluence if there are conflicting IDs.
To preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macroId is found. This check will become redundant as pages get macroId's generated for them and transparently propagate out to all instances.
Returns the body of a macro (in storage format) with the given id. This resource is primarily used by connect applications that require the body of macro to perform their work.
When content is created, if no macroId is specified, then Confluence will generate a random id. The id is persisted as the content is saved and only modified by Confluence if there are conflicting IDs.
To preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macroId is found. This check will become redundant as pages get macroId's generated for them and transparently propagate out to all instances.
Optional callback: undefinedReturns info about all restrictions by operation
Returns info about all restrictions by operation
Optional callback: undefinedReturns info about all restrictions of given operation
Returns info about all restrictions of given operation
Optional callback: undefinedPublishes a legacy draft of a Content created from a ContentBlueprint
Publishes a legacy draft of a Content created from a ContentBlueprint
Optional callback: undefinedPublishes a shared draft of a Content created from a ContentBlueprint
Publishes a shared draft of a Content created from a ContentBlueprint
Optional callback: undefinedFetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL
Fetch a list of content using the Confluence Query Language (CQL). See: Advanced searching using CQL
Optional parameters: SearchContentOptional callback: undefinedUpdate the binary data of an Attachment, and optionally the comment and the minor edit field. This adds a new version of the attachment, containing the new binary data, filename, and content-type.
When updating the binary data of an attachment, the comment related to it together with the field that specifies if it's a minor edit can be updated as well, but are not required. If an update is considered to be a minor edit, notifications will not be sent to the watchers of that content.
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
The name of the multipart/form-data parameter that contains attachments must be "file"
A simple example to upload a file called "myfile.txt" to the Attachment with id "456" in a container with id "123", with the comment updated, and minorEdit set to true: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This is my updated File" http://myhost/rest/api/content/123/child/attachment/456/data
An example to upload the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data
Update the binary data of an Attachment, and optionally the comment and the minor edit field. This adds a new version of the attachment, containing the new binary data, filename, and content-type.
When updating the binary data of an attachment, the comment related to it together with the field that specifies if it's a minor edit can be updated as well, but are not required. If an update is considered to be a minor edit, notifications will not be sent to the watchers of that content.
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
The name of the multipart/form-data parameter that contains attachments must be "file"
A simple example to upload a file called "myfile.txt" to the Attachment with id "456" in a container with id "123", with the comment updated, and minorEdit set to true: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" -F "minorEdit=true" -F "comment=This is my updated File" http://myhost/rest/api/content/123/child/attachment/456/data
An example to upload the same file, with no comment: curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F "file=@myfile.txt" http://myhost/rest/api/content/123/child/attachment/456/data
Optional callback: undefinedUpdate the non-binary data of an Attachment.
This resource can be used to update an attachment's filename, media-type, comment, and parent container.
Update the non-binary data of an Attachment.
This resource can be used to update an attachment's filename, media-type, comment, and parent container.
Optional callback: undefinedUpdates a piece of Content, including changes to content status To update a piece of content you must increment the version.number, supplying the number of the version you are creating. The title property can be updated on all content, body can be updated on all content that has a body (not attachments).
Updates a piece of Content, including changes to content status To update a piece of content you must increment the version.number, supplying the number of the version you are creating. The title property can be updated on all content, body can be updated on all content that has a body (not attachments).
Optional callback: undefinedUpdates a content property. The body contains the representation of the content property. Must include the property id, and the new version number. Attempts to create a new content property if the given version number is 1, just like #create(com.atlassian.confluence.api.model.content.id.ContentId, String, com.atlassian.confluence.api.model.content.JsonContentProperty).
Updates a content property. The body contains the representation of the content property. Must include the property id, and the new version number. Attempts to create a new content property if the given version number is 1, just like #create(com.atlassian.confluence.api.model.content.id.ContentId, String, com.atlassian.confluence.api.model.content.JsonContentProperty).
Optional callback: undefinedGenerated using TypeDoc v0.25.12
Adds a list of labels to the specified content. The body is the json representation of the list.