Class ConfluenceRestClientTemplateConsumerApi

java.lang.Object
io.github.primelib.confluence4j.rest.v1.client.ConfluenceRestClientTemplateConsumerApi
@Generated("io.github.primelib.primecodegen") public class ConfluenceRestClientTemplateConsumerApi extends Object
ConfluenceRestClientTemplateConsumerApi

  • Constructor Details

  • Method Details

    • PutTemplateV1

      public ContentTemplate PutTemplateV1(Consumer<PutTemplateV1OperationSpec> spec)
      PutTemplateV1 Update content template Updates a content template. Note, blueprint templates cannot be updated via the REST API. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to update a space template or 'Confluence Administrator' global permission to update a global template.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • payload: The updated content template.

    • PostTemplateV1

      public ContentTemplate PostTemplateV1(Consumer<PostTemplateV1OperationSpec> spec)
      PostTemplateV1 Create content template Creates a new content template. Note, blueprint templates cannot be created via the REST API. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to create a space template or 'Confluence Administrator' global permission to create a global template.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • payload: The content template to be created. The content body must be in 'storage' format.

    • GetTemplateBlueprintV1

      public BlueprintTemplateArray GetTemplateBlueprintV1(Consumer<GetTemplateBlueprintV1OperationSpec> spec)
      GetTemplateBlueprintV1 Get blueprint templates Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space. Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the global blueprints. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global blueprints.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceKey: The key of the space to be queried for templates. If the `spaceKey` is not specified, global blueprint templates will be returned.
      • start: The starting index of the returned templates.
      • limit: The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.
      • expand: A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

    • GetTemplatePageV1

      public ContentTemplateArray GetTemplatePageV1(Consumer<GetTemplatePageV1OperationSpec> spec)
      GetTemplatePageV1 Get content templates Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceKey: The key of the space to be queried for templates. If the `spaceKey` is not specified, global templates will be returned.
      • start: The starting index of the returned templates.
      • limit: The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.
      • expand: A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

    • GetTemplateByContentTemplateIDV1

      public ContentTemplate GetTemplateByContentTemplateIDV1(Consumer<GetTemplateByContentTemplateIDV1OperationSpec> spec)
      GetTemplateByContentTemplateIDV1 Get content template Returns a content template. This includes information about template, like the name, the space or blueprint that the template is in, the body of the template, and more. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view space templates and permission to access the Confluence site ('Can use' global permission) to view global templates.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • contentTemplateId: The ID of the content template to be returned.
      • expand: A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

    • DeleteTemplateByContentTemplateIDV1

      public void DeleteTemplateByContentTemplateIDV1(Consumer<DeleteTemplateByContentTemplateIDV1OperationSpec> spec)
      DeleteTemplateByContentTemplateIDV1 Remove template Deletes a template. This results in different actions depending on the type of template: - If the template is a content template, it is deleted. - If the template is a modified space-level blueprint template, it reverts to the template inherited from the global-level blueprint template. - If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template. Note, unmodified blueprint templates cannot be deleted. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space to delete a space template or 'Confluence Administrator' global permission to delete a global template.
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • contentTemplateId: The ID of the template to be deleted.