Pular para o conteúdo

Confluence

Confluence

Confluence é a plataforma de colaboração e gestão do conhecimento da Atlassian, utilizada por equipes para criar, organizar e compartilhar documentação, wikis e planos de projeto em um único espaço. Com a integração Confluence no SquadOS, seus agentes podem criar e atualizar páginas, publicar blog posts, pesquisar conteúdo com CQL, gerenciar tarefas e monitorar mudanças em tempo real — tudo de forma programática.

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar. Também são suportados S2S_OAUTH2 (OAuth 2.0 server-to-server) e API_KEY (chave de API).

Você vai precisar autorizar o acesso à sua conta Atlassian pela página de conexão segura da Composio. Para configurar credenciais OAuth próprias, consulte o guia da Composio.

Para OAuth 2.0 (padrão), nenhuma credencial manual é necessária — o acesso é autorizado via fluxo OAuth na página da Composio.

Para API Key, siga os passos:

  1. Acesse id.atlassian.com/manage-profile/security/api-tokens e faça login na sua conta Atlassian.
  2. Clique em Create API token.
  3. Dê um nome descritivo ao token (ex.: “SquadOS”) e clique em Create.
  4. Copie o token gerado — ele não será exibido novamente.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Confluence.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso à sua conta Atlassian (OAuth 2.0).
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Como configurar credenciais OAuth personalizadas para o Confluence?

Seção intitulada “Como configurar credenciais OAuth personalizadas para o Confluence?”

Para um guia passo a passo sobre como criar e configurar suas próprias credenciais OAuth do Confluence na Composio, consulte Como criar credenciais OAuth para o Confluence.

CONFLUENCE_ADD_CONTENT_LABEL

Adiciona rótulos a um conteúdo do Confluence. Use após obter o ID do conteúdo para marcar páginas ou blog posts com metadados.

NomeTipoObrigatórioDescrição
idstringSimIdentificador do conteúdo Confluence (página ou blog post) a rotular.
labelsarraySimLista de rótulos a adicionar ao conteúdo. Cada elemento deve ser um objeto com prefix (um de global, team ou my) e name (string alfanumérica com hífens em minúsculas). Passar strings simples ou omitir prefix causa erros de validação de schema.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CQL_SEARCH

Pesquisa conteúdo no Confluence usando a Confluence Query Language (CQL). CQL é uma linguagem de consulta poderosa que permite pesquisar em todo o conteúdo do Confluence com recursos avançados de filtragem: busca de texto completo (text ~ "termo"), busca por título (title ~ "notas de reunião"), filtragem por rótulo (label = "importante"), filtragem por espaço (space = DEV), filtragem por tipo (type = page ou type = blogpost), filtragem por criador (creator = currentUser()), filtragem por data (lastModified > now("-7d")) e consultas combinadas (text ~ "api" AND space = DOCS AND type = page). Esta ação usa o endpoint de pesquisa v1 da API REST do Confluence, que suporta CQL completamente.

NomeTipoObrigatórioDescrição
cqlstringSimConsulta CQL (Confluence Query Language) para pesquisar conteúdo. Exemplos: text ~ "termo" (busca de texto completo), label = "importante" (busca por rótulo), type = page AND space = DEV (páginas no espaço DEV), creator = currentUser() (conteúdo do usuário atual).
limitintegerNãoNúmero máximo de resultados a retornar (máx. 250; pode ser limitado a 25–50 ao usar expansões de corpo).
startintegerNãoÍndice inicial para paginação (base 0).
expandstringNãoLista separada por vírgulas de propriedades a expandir na resposta. Valores comuns: content.space, content.version, content.body.storage.
excerptstringNãoTipo de trecho a retornar. Padrão: highlight. Valores aceitos: highlight, indexed, none.
includeArchivedSpacesbooleanNãoSe deve incluir resultados de espaços arquivados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_BLOGPOST

Cria um novo blog post no Confluence. Use quando precisar publicar conteúdo em um espaço específico. A resposta inclui data.id para o ID do post e data._links.base + data._links.webui para a URL.

NomeTipoObrigatórioDescrição
bodyobjectSimCorpo do conteúdo do blog post. Deve ser um objeto com representation definido como storage e value contendo marcação válida no formato de armazenamento do Confluence (baseado em XML). Markdown ou strings simples causam erros de validação.
titlestringSimTítulo do novo blog post.
statusstringSimStatus do blog post. Use current para publicar imediatamente ou draft para salvar como rascunho privado.
spaceIdstringSimID do espaço onde o blog post será criado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_BLOGPOST_PROPERTY

Cria uma propriedade em um blog post especificado. Use quando precisar adicionar metadados personalizados a um blog post. Cria um novo par chave-valor no blog post do Confluence especificado.

NomeTipoObrigatórioDescrição
idstringSimIdentificador do blog post do Confluence ao qual adicionar a propriedade.
keystringSimChave única para a propriedade do blog post.
valuestringSimString JSON representando o valor da propriedade do blog post.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_CONTENT_PROPERTY_FOR_WHITEBOARD

Cria uma nova propriedade de conteúdo em um quadro branco. Use quando precisar anexar metadados personalizados a um quadro branco do Confluence.

NomeTipoObrigatórioDescrição
keystringSimChave/nome da propriedade a criar.
valuestringSimString JSON representando o valor da propriedade de conteúdo.
whiteboard_idstringSimID do quadro branco ao qual adicionar a propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_FOOTER_COMMENT

Cria um comentário de rodapé em uma página, blog post, anexo ou conteúdo personalizado do Confluence. Use quando precisar adicionar um comentário sem editar o corpo da página.

NomeTipoObrigatórioDescrição
bodyobjectSimConteúdo do corpo do comentário com formato de representação e valor.
pageIdstringNãoID da página a comentar. Forneça um dos campos: pageId, blogPostId, attachmentId ou customContentId.
blogPostIdstringNãoID do blog post a comentar. Forneça um dos campos: pageId, blogPostId, attachmentId ou customContentId.
attachmentIdstringNãoID do anexo a comentar. Forneça um dos campos: pageId, blogPostId, attachmentId ou customContentId.
customContentIdstringNãoID do conteúdo personalizado a comentar. Forneça um dos campos: pageId, blogPostId, attachmentId ou customContentId.
parentCommentIdstringNãoID do comentário pai. Forneça este campo para criar uma resposta a um comentário existente.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_INLINE_COMMENT

Cria um comentário inline em uma página ou blog post do Confluence, destacando um texto específico. Comentários inline permitem comentar em partes específicas do conteúdo sem editar a página. Para comentários de nível superior, especifique o texto a destacar usando inlineCommentProperties. Para respostas a comentários inline existentes, forneça apenas parentCommentId.

NomeTipoObrigatórioDescrição
bodyobjectSimConteúdo do corpo do comentário com formato de representação e valor.
pageIdstringNãoID da página para criar o comentário inline. Forneça um dos campos: pageId, blogPostId ou parentCommentId.
blogPostIdstringNãoID do blog post para criar o comentário inline. Forneça um dos campos: pageId, blogPostId ou parentCommentId.
parentCommentIdstringNãoID do comentário pai para responder. Forneça este campo para criar uma resposta a um comentário inline existente.
inlineCommentPropertiesobjectNãoPropriedades que determinam a qual texto o comentário inline está anexado. Obrigatório para comentários inline de nível superior (não respostas).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_PAGE

Cria uma nova página do Confluence em um espaço especificado. Use quando precisar criar nova documentação ou conteúdo.

NomeTipoObrigatórioDescrição
bodyobjectNãoWrapper para o conteúdo do corpo da página.
titlestringSimTítulo da nova página. A unicidade do título é restrita ao mesmo pai: duplicatas são permitidas sob pais diferentes, mas não sob o mesmo pai.
spaceIdstringSimID ou chave do espaço onde a página será criada. Pode ser um ID numérico (ex.: 12345678) ou uma chave de espaço (ex.: DOCS, TEAM). Chaves de espaço são automaticamente convertidas em IDs.
parentIdstringNãoID da página pai. Se omitido, a API do Confluence colocará a página automaticamente sob a página inicial do espaço. Forneça este campo para criar a página como filha de uma página específica. Deve ser apenas um ID numérico de página.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_PAGE_PROPERTY

Cria uma propriedade em uma página do Confluence. Use quando precisar adicionar metadados personalizados ou configurações a uma página.

NomeTipoObrigatórioDescrição
keystringSimChave/nome da propriedade a criar.
valuestringSimValor da propriedade como string JSON. Pode representar qualquer tipo JSON (string, number, object, array).
page_idstringSimID da página para a qual criar a propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_PRIVATE_SPACE

Cria um espaço privado no Confluence. Use quando precisar de um espaço de trabalho isolado, visível apenas pelo criador.

NomeTipoObrigatórioDescrição
keystringSimChave única para o espaço privado; deve ser única e ter no máximo 255 caracteres. Apenas alfanumérico (sem hífens, underscores ou espaços).
namestringSimNome do espaço privado, visível apenas pelo criador.
descriptionobjectNãoContainer para a descrição em texto simples.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_SPACE

Cria um novo espaço no Confluence. Use ao configurar uma nova área de conhecimento para a organização. Deve incluir o campo plain.representation, ex.: {"plain": {"representation": "plain", "value": "texto aqui"}}. Omitir este campo causa erro 400.

NomeTipoObrigatórioDescrição
keystringSimChave única para o espaço. Deve conter apenas caracteres alfanuméricos (letras e números), até 255 caracteres. Underscores e hífens não são permitidos.
namestringSimNome legível por humanos para o espaço.
typestringNãoTipo do espaço: global ou personal.
metadatastringNãoMetadados opcionais para o espaço como string JSON.
descriptionobjectNãoObjeto de descrição para o espaço do Confluence.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_SPACE_PROPERTY

Cria uma nova propriedade em um espaço do Confluence. Use após confirmar o ID do espaço ao adicionar metadados personalizados.

NomeTipoObrigatórioDescrição
keystringSimChave única para a propriedade do espaço.
valuestringSimString JSON representando o valor da propriedade do espaço.
spaceIdstringSimID do espaço ao qual adicionar a propriedade.
versionobjectNãoMetadados de versão opcionais para a nova propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_CREATE_WHITEBOARD

Cria um novo quadro branco no Confluence. Use quando precisar iniciar uma sessão colaborativa de quadro branco.

NomeTipoObrigatórioDescrição
titlestringNãoTítulo do quadro branco.
spaceIdstringSimID do espaço onde o quadro branco será criado.
parentIdstringNãoID do conteúdo pai sob o qual o quadro branco será criado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DELETE_BLOGPOST_PROPERTY

Exclui uma propriedade de blog post. Use quando precisar remover metadados personalizados de um blog post especificado.

NomeTipoObrigatórioDescrição
idstringSimID do blog post do Confluence que contém a propriedade.
propertyIdstringSimID da propriedade do blog post a excluir. Pode ser um ID numérico ou uma string de chave de propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DELETE_CONTENT_PROPERTY_FOR_PAGE_BY_ID

Exclui uma propriedade de conteúdo de uma página pelo ID da propriedade. Use quando precisar remover metadados personalizados de uma página para limpeza ou auditoria.

NomeTipoObrigatórioDescrição
pageIdstringSimID da página do Confluence da qual excluir a propriedade.
propertyIdstringSimID da propriedade de conteúdo a excluir da página. Pode ser um ID numérico ou uma string de chave de propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DELETE_CONTENT_PROPERTY_FOR_WHITEBOARD_BY_ID

Exclui uma propriedade de conteúdo de um quadro branco pelo ID da propriedade. Use quando precisar remover metadados personalizados de um quadro branco.

NomeTipoObrigatórioDescrição
propertyIdstringSimID da propriedade a excluir do quadro branco. Pode ser um ID numérico ou uma string de chave de propriedade.
whiteboardIdstringSimID do quadro branco do qual excluir a propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DELETE_PAGE

Exclui uma página do Confluence. Use com cautela, pois remove permanentemente a página e seu conteúdo sem opção de recuperação. Em fluxos de migração, confirme que todas as páginas de destino foram criadas com sucesso antes de excluir as páginas de origem — falhas parciais na criação combinadas com exclusão resultam em perda irrecuperável de dados.

NomeTipoObrigatórioDescrição
idstringSimID da página a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DELETE_SPACE

Exclui um espaço do Confluence pela sua chave. Use quando precisar remover permanentemente um espaço.

NomeTipoObrigatórioDescrição
space_keystringSimChave do espaço a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DELETE_SPACE_PROPERTY

Exclui uma propriedade de espaço. Use quando precisar remover uma propriedade de um espaço do Confluence após revisão.

NomeTipoObrigatórioDescrição
propertyIdstringSimID da propriedade do espaço a excluir. Pode ser um ID numérico ou uma string de chave de propriedade.
spaceIdOrKeyintegerSimID numérico Long do espaço que contém a propriedade. Deve ser um ID numérico de espaço, não uma chave de espaço ou UUID.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_DOWNLOAD_ATTACHMENT

Baixa um anexo de uma página do Confluence e retorna uma URL pública acessível no S3. Use quando precisar compartilhar o anexo com usuários que não têm acesso ao Confluence. Primeiro use CONFLUENCE_GET_ATTACHMENTS para listar os anexos e obter o ID do anexo.

NomeTipoObrigatórioDescrição
pageIdstringSimID da página do Confluence que contém o anexo.
attachmentIdstringSimID do anexo a baixar (ex.: att65825).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_ATTACHMENT_LABELS

Lista rótulos de um anexo. Use após confirmar o ID do anexo para buscar seus rótulos.

NomeTipoObrigatórioDescrição
idstringSimIdentificador do anexo do Confluence para recuperar os rótulos.
sortstringNãoOrdenar o resultado por um campo específico.
limitintegerNãoNúmero máximo de rótulos a retornar por página (1–250).
cursorstringNãoCursor opaco para paginação. Retornado no cabeçalho de resposta Link para buscar a próxima página.
prefixstringNãoFiltrar rótulos pelo prefixo. Valores: my, team, global, system.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_ATTACHMENTS

Recupera os anexos de uma página do Confluence. Use após confirmar o ID da página para listar seus anexos (suporta paginação).

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de anexos a retornar por página. O Confluence limita a 200.
startintegerNãoÍndice base zero do primeiro item a retornar (offset de paginação).
pageIdstringSimID da página do Confluence cujos anexos serão recuperados.
mediaTypestringNãoFiltrar anexos por tipo MIME (ex.: image/png, application/pdf).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_AUDIT_LOGS

Recupera registros de auditoria do Confluence. Use quando precisar buscar e filtrar logs de auditoria para conformidade ou resolução de problemas.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de registros de auditoria a retornar por página.
startintegerNãoÍndice base zero do primeiro registro de auditoria a retornar (offset de paginação).
endDateintegerNãoFim do intervalo de timestamp dos registros de auditoria (época em milissegundos).
startDateintegerNãoInício do intervalo de timestamp dos registros de auditoria (época em milissegundos).
searchStringstringNãoBusca de texto livre para filtrar registros de auditoria por resumo ou categoria.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOGPOST_BY_ID

Recupera um blog post específico do Confluence pelo seu ID. Use quando tiver um ID de blog post e precisar de metadados detalhados e conteúdo.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único do blog post do Confluence a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOGPOST_LABELS

Recupera rótulos de um blog post específico do Confluence pelo ID. Use após obter o ID do blog post para listar seus rótulos.

NomeTipoObrigatórioDescrição
idstringSimIdentificador do blog post do Confluence para recuperar os rótulos.
limitintegerNãoNúmero máximo de rótulos a retornar por página.
startintegerNãoÍndice base zero do primeiro rótulo a retornar (offset de paginação).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOGPOST_LIKE_COUNT

Obtém a contagem de curtidas de um blog post do Confluence. Use após confirmar o ID do blog post para recuperar o total de curtidas.

NomeTipoObrigatórioDescrição
idstringSimIdentificador do blog post do Confluence para recuperar a contagem de curtidas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOGPOST_OPERATIONS

Recupera as operações permitidas para um blog post do Confluence. Use após confirmar o ID do blog post para ver as ações permitidas.

NomeTipoObrigatórioDescrição
idstringSimIdentificador do blog post do Confluence para consultar as operações.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOG_POSTS

Recupera uma lista de blog posts. Use quando precisar de uma lista paginada de blog posts do Confluence.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de itens a retornar por página.
cursorstringNãoCursor de paginação opaco para buscar a próxima página de resultados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOG_POSTS_FOR_LABEL

Lista todos os blog posts associados a um rótulo específico. Use quando tiver um ID de rótulo e precisar recuperar os blog posts associados.

NomeTipoObrigatórioDescrição
idstringSimID do rótulo para recuperar os blog posts.
limitintegerNãoNúmero máximo de itens a retornar por página.
cursorstringNãoCursor de paginação opaco para buscar a próxima página de resultados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOGPOST_VERSION_DETAILS

Recupera detalhes de uma versão específica de um blog post. Use quando tiver blogpostId e versionNumber e precisar de metadados detalhados para aquela versão.

NomeTipoObrigatórioDescrição
blogpostIdstringSimIdentificador único do blog post do Confluence.
versionNumberintegerSimNúmero da versão do blog post a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_BLOGPOST_VERSIONS

Recupera todas as versões de um blog post específico. Use quando tiver um blogpostId e precisar listar os números de versão.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de itens de versão a retornar por página.
cursorstringNãoCursor para paginação. Use o valor da resposta anterior para buscar a próxima página.
blogpostIdstringSimIdentificador único do blog post do Confluence.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_CHILD_PAGES

Lista todas as páginas filhas diretas de uma página do Confluence. Use quando tiver um ID de página pai e precisar descobrir seus descendentes diretos. A resposta aninha os dados das páginas filhas em data.data.results; desempacote antes de iterar. Pagine usando o cursor de _links.next até não haver mais resultados para evitar perder filhos.

NomeTipoObrigatórioDescrição
idstringSimID da página do Confluence para recuperar as páginas filhas. Os IDs retornados podem ser strings não-numéricas; não assuma formato inteiro ao armazenar ou passar para chamadas subsequentes.
sortstringNãoOpções de ordenação para páginas filhas: id, -id, created-date, -created-date, modified-date, -modified-date, child-position, -child-position.
limitintegerNãoNúmero máximo de itens a retornar por página. Limite máximo: 100. Pagine até que _links.next esteja ausente para garantir que todos os filhos sejam recuperados.
cursorstringNãoCursor para paginação. Use o cursor de _links.next da resposta anterior para obter a próxima página de resultados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_CONTENT_PROPERTIES_FOR_BLOG_POST

Recupera todas as propriedades de conteúdo de um blog post. Use quando precisar listar propriedades de metadados definidas em um blog post específico do Confluence.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de propriedades a retornar por página.
startintegerNãoÍndice base zero da primeira propriedade a retornar (offset de paginação).
blogpost_idstringSimIdentificador do blog post do Confluence para recuperar as propriedades.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_CONTENT_PROPERTIES_FOR_PAGE

Recupera todas as propriedades de conteúdo de uma página. Use quando precisar listar propriedades de metadados definidas em uma página específica do Confluence.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de propriedades a retornar por página (máx. 200).
cursorstringNãoCursor de paginação opaco para buscar a próxima página de resultados.
page_idstringSimIdentificador da página do Confluence para recuperar as propriedades.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_CONTENT_RESTRICTIONS

Recupera restrições de um item de conteúdo do Confluence. Use quando precisar ver quem pode visualizar ou editar uma página ou blog post.

NomeTipoObrigatórioDescrição
idstringSimID do conteúdo para recuperar as restrições.
expandarrayNãoPropriedades separadas por vírgula para expandir na resposta, ex.: restrictables.operation, user.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_CURRENT_USER

Obtém informações sobre o usuário atualmente autenticado — sempre vinculado à conta associada à conexão configurada, não a usuários arbitrários. Use CONFLUENCE_SEARCH_USERS para consultar outros usuários. A resposta contém metadados aninhados; campos principais incluem accountId, displayName e email.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_INLINE_COMMENTS_FOR_BLOG_POST

Recupera comentários inline de um blog post do Confluence. Use quando precisar de detalhes de comentários inline pelo ID do blog post.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único do blog post para recuperar os comentários inline.
sortstringNãoOrdem dos resultados. Use prefixo - para ordem decrescente. Valores: created-date, -created-date, modified-date, -modified-date.
limitintegerNãoNúmero máximo de comentários inline a retornar por página (padrão 25, máx. 250).
cursorstringNãoCursor para paginação. Use o cursor de _links.next da resposta anterior.
body_formatstringNãoFormato de conteúdo para o corpo do comentário. Valores: storage, atlas_doc_format.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_LABELS

Recupera todos os rótulos de um site do Confluence; use para descoberta de rótulos quando precisar listar ou paginar por rótulos. Para filtragem baseada em rótulos, use CONFLUENCE_GET_LABELS_FOR_PAGE ou CONFLUENCE_GET_LABELS_FOR_SPACE_CONTENT.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de rótulos a retornar por página.
startintegerNãoÍndice base zero do primeiro rótulo a retornar (offset de paginação).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_LABELS_FOR_PAGE

Recupera rótulos de uma página específica do Confluence pelo ID. Os rótulos são retornados em data.results[*].name e não estão disponíveis nas respostas de CONFLUENCE_GET_PAGES. Use após obter o ID da página para listar seus rótulos. Pagine usando start e limit para evitar perder rótulos quando a contagem exceder 25.

NomeTipoObrigatórioDescrição
idstringSimIdentificador da página do Confluence para recuperar os rótulos.
limitintegerNãoNúmero máximo de rótulos a retornar por página.
startintegerNãoÍndice base zero do primeiro rótulo a retornar (offset de paginação). Incremente pelo valor de limit iterativamente para paginar por todos os rótulos.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_LABELS_FOR_SPACE

Lista rótulos de um espaço. Use quando precisar recuperar rótulos de um espaço específico.

NomeTipoObrigatórioDescrição
idstringSimID do espaço para recuperar os rótulos (ID numérico do espaço).
sortstringNãoOrdem dos resultados. Use prefixo - para ordem decrescente. Valores: created-date, -created-date, id, -id, name, -name.
limitintegerNãoNúmero máximo de rótulos a retornar por página (padrão 25, máx. 250).
cursorstringNãoCursor para paginação. Use o cursor da resposta anterior para obter a próxima página.
prefixstringNãoFiltrar rótulos por prefixo. Valores: my, team, global, system.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_LABELS_FOR_SPACE_CONTENT

Lista rótulos de todo o conteúdo de um espaço. Use quando precisar recuperar ou filtrar rótulos de conteúdo por espaço, com paginação e filtragem opcional por prefixo. Para descoberta de rótulos em um espaço antes da filtragem por página, use esta ação primeiro e depois CONFLUENCE_GET_LABELS_FOR_PAGE.

NomeTipoObrigatórioDescrição
idstringSimID do espaço para listar os rótulos de conteúdo.
limitintegerNãoNúmero máximo de rótulos a retornar por página.
startintegerNãoÍndice base zero do primeiro rótulo a retornar (offset de paginação).
prefixstringNãoFiltrar rótulos por este prefixo (ex.: global, page-).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGE_ANCESTORS

Recupera todos os ancestrais de uma página do Confluence pelo seu ID. Use quando precisar da hierarquia completa de páginas.

NomeTipoObrigatórioDescrição
idstringSimID da página do Confluence para recuperar os ancestrais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGE_BY_ID

Recupera uma página do Confluence pelo seu ID. Use quando tiver um ID de página e precisar de metadados detalhados e conteúdo. O corpo da resposta está em body.storage.value no formato de armazenamento do Confluence (HTML); remova as tags antes de usar como texto simples. Antes de chamar CONFLUENCE_UPDATE_PAGE, busque a versão mais recente aqui — aquela ação requer version.number = atual + 1, caso contrário ocorre um conflito 409.

NomeTipoObrigatórioDescrição
idstringSimID numérico Long da página do Confluence a recuperar. Deve ser um valor numérico long, não um UUID ou identificador string.
draftbooleanNãoSe deve retornar a versão de rascunho (padrão: false).
versionintegerNãoVersão específica da página a recuperar (padrão: mais recente).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGE_FOOTER_COMMENTS

Recupera comentários de rodapé (não-inline) de uma página do Confluence. Use quando precisar coletar feedback de revisão deixado como comentários padrão de página.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único da página para recuperar os comentários de rodapé.
sortstringNãoOrdem dos resultados. Use prefixo - para ordem decrescente. Valores: created-date, -created-date, modified-date, -modified-date.
limitintegerNãoNúmero máximo de comentários de rodapé a retornar por página (padrão 50, máx. 250).
cursorstringNãoCursor para paginação. Use o cursor de _links.next da resposta anterior.
statusarrayNãoFiltrar comentários por status. Pode incluir múltiplos status.
body_formatstringNãoFormato de conteúdo para o corpo do comentário. Valores: storage, atlas_doc_format.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGE_INLINE_COMMENTS

Recupera comentários inline de uma página do Confluence. Use quando precisar de detalhes de comentários inline pelo ID da página.

NomeTipoObrigatórioDescrição
idintegerSimID numérico da página para recuperar os comentários inline.
sortstringNãoOrdem dos resultados. Use prefixo - para ordem decrescente. Valores: created-date, -created-date, modified-date, -modified-date.
limitintegerNãoNúmero máximo de comentários inline a retornar por página (padrão 25, máx. 250).
cursorstringNãoCursor para paginação. Use o cursor de _links.next da resposta anterior.
statusarrayNãoFiltrar comentários por status. Passe um array de valores de status.
body_formatstringNãoFormato de conteúdo para o corpo do comentário. Valores: storage, atlas_doc_format.
resolution_statusarrayNãoFiltrar comentários por status de resolução. Passe um array de valores (ex.: open, resolved).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGE_LIKE_COUNT

Obtém a contagem de curtidas de uma página do Confluence. Use após confirmar o ID da página para recuperar o total de curtidas.

NomeTipoObrigatórioDescrição
idstringSimIdentificador da página do Confluence para recuperar a contagem de curtidas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGES

Recupera uma lista paginada de páginas do Confluence. Os resultados são limitados ao escopo de permissões do usuário autenticado; resultados vazios podem refletir restrições de acesso. Omitir filtros como spaceId ou status pode retornar conjuntos de resultados inesperadamente amplos. Rótulos não estão incluídos nos resultados; use CONFLUENCE_GET_LABELS_FOR_PAGE para dados de rótulos. Timestamps são strings ISO 8601 UTC.

NomeTipoObrigatórioDescrição
sortstringNãoOrdem dos resultados. Valores: id, -id, created-date, -created-date, modified-date, -modified-date, title, -title.
limitintegerNãoNúmero máximo de páginas a retornar por página. O Confluence limita a 250.
titlestringNãoFiltrar por título de página (correspondência exata).
cursorstringNãoCursor de paginação opaco. Use o link next de uma resposta anterior para continuar. Itere até que nenhum link next seja retornado.
statusstringNãoFiltrar por status de página. Valores: current, archived, deleted, trashed.
subtypestringNãoFiltrar por subtipo de página. Valores: live, page.
space_idstringNãoFiltrar por ID(s) de espaço. Forneça um único ID ou uma lista de IDs.
body_formatstringNãoRepresentação de corpo a incluir nos resultados. Valores: storage ou atlas_doc_format.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_PAGE_VERSIONS

Recupera todas as versões de uma página específica do Confluence. Use para auditar o histórico de edições ou para obter o version.number mais recente antes de chamar CONFLUENCE_UPDATE_PAGE — usar um version.number desatualizado causa um erro 409 Conflict.

NomeTipoObrigatórioDescrição
idstringSimIdentificador único da página do Confluence. Formato string; difere do long numérico esperado por CONFLUENCE_GET_PAGE_BY_ID.
limitintegerNãoNúmero máximo de versões a retornar por página. Versões antigas são omitidas silenciosamente se a paginação não for seguida.
startintegerNãoÍndice base zero da primeira versão a retornar (offset de paginação).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_SPACE_BY_ID

Recupera um espaço do Confluence pelo seu ID. Use quando precisar de metadados detalhados de um espaço específico. Nomes de espaço não são únicos; use o spaceId numérico ou spaceKey da resposta para identificação estável em operações subsequentes.

NomeTipoObrigatórioDescrição
idstringSimID numérico do espaço (ex.: 557060). NÃO é a chave do espaço (ex.: GTS). Use CONFLUENCE_GET_SPACES para encontrar o ID numérico de um espaço a partir da sua chave.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_SPACE_CONTENTS

Recupera conteúdo de um espaço do Confluence. Use quando precisar listar páginas, blog posts ou anexos de uma chave de espaço específica. Os resultados estão em data.results (não data.page.results). Pagine via start/limit (máx. 200/requisição); siga response._links.next até ausente para evitar perder conteúdo. Retorna apenas conteúdo acessível ao usuário autenticado. O Atlassian Cloud aplica limites de taxa HTTP 429; limite a ~1–2 requisições/segundo e respeite os cabeçalhos Retry-After.

NomeTipoObrigatórioDescrição
typestringNãoTipo de conteúdo a retornar: page, blogpost, attachment.
limitintegerNãoNúmero máximo de itens a retornar por página. O Confluence limita a 200.
startintegerNãoÍndice base zero do primeiro item a retornar (offset de paginação).
statusstringNãoStatus do conteúdo a retornar: current, trashed, draft, historical.
spaceKeystringSimChave do espaço do qual recuperar o conteúdo.
postingDaystringNãoPara blog posts, filtrar por data de publicação (data ISO, yyyy-MM-dd).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_SPACE_PROPERTIES

Obtém propriedades de um espaço do Confluence. Use quando precisar recuperar metadados personalizados ou configurações armazenadas como propriedades de espaço.

NomeTipoObrigatórioDescrição
idstringSimID do espaço para obter as propriedades.
keyarrayNãoFiltrar por chave(s) de propriedade. Se não fornecido, retorna todas as propriedades.
limitintegerNãoNúmero máximo de propriedades a retornar por página. O Confluence limita a 200.
startintegerNãoÍndice base zero do primeiro item a retornar (offset de paginação).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_SPACES

Recupera uma lista paginada de espaços do Confluence com filtragem opcional. Pagine incrementando start em passos de limit até que menos resultados que limit sejam retornados. Os resultados são limitados aos espaços visíveis pelo usuário autenticado. Use spaceKey ou ID numérico de espaço (não nome de exibição) para identificação estável em chamadas subsequentes. Filtros combinados aplicam lógica AND — relaxe os filtros antes de concluir que um espaço está ausente.

NomeTipoObrigatórioDescrição
typestringNãoTipo de espaço: global ou personal.
labelarrayNãoFiltrar por rótulos; espaços devem ter pelo menos um desses rótulos.
limitintegerNãoNúmero máximo de espaços a retornar por página. O Confluence limita a 200.
startintegerNãoÍndice base zero do primeiro item a retornar (offset de paginação).
expandarrayNãoPropriedades a expandir na resposta (ex.: description, icon, metadata).
statusstringNãoStatus do espaço: current (ativo) ou archived.
spaceKeyarrayNãoFiltrar por chave(s) de espaço; aceita uma ou mais chaves canônicas de espaço.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_TASKS

Lista tarefas (itens de ação) do Confluence com filtragem por responsável, criador, espaço, página, blog post, status e datas. Use quando precisar recuperar itens de ação de usuários sem pesquisa não confiável por palavra-chave “TODO”.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de tarefas a retornar por página. O Confluence limita a 250.
cursorstringNãoCursor de paginação opaco. Use o link next da resposta anterior para continuar.
statusstringNãoFiltrar tarefas por status (ex.: complete, incomplete).
page_idstringNãoFiltrar por ID(s) de página. Forneça um único ID ou uma lista de IDs.
task_idstringNãoFiltrar por ID(s) de tarefa específico(s). Forneça um único ID ou uma lista de IDs.
space_idstringNãoFiltrar por ID(s) de espaço. Forneça um único ID ou uma lista de IDs.
created_bystringNãoFiltrar pelo(s) criador(es) da tarefa. Forneça ID(s) de conta Atlassian.
assigned_tostringNãoFiltrar pelo(s) responsável(eis) da tarefa. Forneça ID(s) de conta Atlassian.
blogpost_idstringNãoFiltrar por ID(s) de blog post. Forneça um único ID ou uma lista de IDs.
body_formatstringNãoRepresentação de corpo a incluir nos resultados de tarefas. Valores: storage ou atlas_doc_format.
completed_bystringNãoFiltrar por quem concluiu a(s) tarefa(s). Forneça ID(s) de conta Atlassian.
include_blank_tasksbooleanNãoSe deve incluir tarefas sem conteúdo ou em branco.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_GET_USER_ANONYMOUS

Recupera informações sobre o usuário anônimo. Use quando precisar obter detalhes de usuário convidado antes de interações não autenticadas.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_SEARCH_CONTENT

Pesquisa conteúdo filtrando páginas da API v2 do Confluence com classificação inteligente. Como o endpoint de pesquisa nativo foi descontinuado, esta ação: (1) busca páginas do endpoint v2 com paginação (até 300 páginas), (2) aplica filtragem inteligente no lado do cliente com pontuação de relevância, (3) retorna resultados classificados por qualidade de correspondência (frase exata > todas as palavras > correspondências parciais). NOTA: Apenas títulos de páginas são pesquisados — consultas que correspondem apenas ao corpo do conteúdo não retornam resultados.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de resultados a retornar.
querystringSimConsulta de pesquisa para encontrar páginas correspondentes. A pesquisa procura este texto nos títulos de páginas com correspondência inteligente: (1) correspondências de frase exata (maior prioridade), (2) todas as palavras presentes no título (prioridade média), (3) correspondências parciais de palavras (menor prioridade). Sem distinção de maiúsculas/minúsculas e suporta múltiplas palavras.
startintegerNãoÍndice inicial para paginação.
expandstringNãoLista separada por vírgulas de propriedades a expandir na resposta.
spaceKeystringNãoLimitar pesquisa a um espaço específico pela chave do espaço. Os resultados não estão estritamente limitados a este espaço; inspecione spaceId nos resultados retornados para confirmar o escopo.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_SEARCH_USERS

Pesquisa usuários usando consultas específicas de usuário da Confluence Query Language (CQL).

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de usuários por resultado a retornar.
cursorstringNãoUsado para paginação. O cursor para a próxima página de resultados.
accountIdstringNãoFiltrar por ID de conta de usuário.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_UPDATE_BLOGPOST

Atualiza o título ou conteúdo de um blog post do Confluence. Use quando precisar modificar um blog post existente. Certifique-se de ter o número de versão mais recente antes de chamar.

NomeTipoObrigatórioDescrição
idstringSimID do blog post a atualizar.
bodyobjectSimNovo conteúdo para o corpo do blog post. Forneça o corpo no formato de armazenamento.
titlestringSimNovo título para o blog post.
statusstringNãoStatus do blog post. Padrão: current se não fornecido. Valores: current, draft.
spaceIdstringSimID do espaço que contém o blog post.
versionobjectSimObjeto de versão contendo o novo número de versão e metadados opcionais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_UPDATE_BLOGPOST_PROPERTY

Atualiza uma propriedade de um blog post especificado. Use quando precisar modificar metadados personalizados em um blog post.

NomeTipoObrigatórioDescrição
idstringSimID do blog post do Confluence a atualizar.
valuestringSimNova string JSON de valor para a propriedade especificada.
propertyIdstringSimID da propriedade do blog post a atualizar. Pode ser um ID numérico ou uma string de chave de propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_UPDATE_CONTENT_PROPERTY_FOR_PAGE_BY_ID

Atualiza uma propriedade de conteúdo em uma página do Confluence. Use quando precisar modificar uma propriedade de metadados existente pelo seu ID.

NomeTipoObrigatórioDescrição
valuestringSimNova string JSON de valor para a propriedade especificada.
pageIdstringSimID da página do Confluence para atualizar a propriedade.
propertyIdstringSimID da propriedade de conteúdo a atualizar na página. Pode ser um ID numérico ou uma string de chave de propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Atualizar propriedade de conteúdo de quadro branco

Seção intitulada “Atualizar propriedade de conteúdo de quadro branco”

CONFLUENCE_UPDATE_CONTENT_PROPERTY_FOR_WHITEBOARD_BY_ID

Atualiza uma propriedade de conteúdo em um quadro branco. Use quando precisar modificar metadados em um quadro branco do Confluence.

NomeTipoObrigatórioDescrição
valuestringSimNova string JSON de valor para a propriedade de conteúdo especificada.
propertyIdstringSimID da propriedade de conteúdo a atualizar no quadro branco. Pode ser um ID numérico ou uma string de chave de propriedade.
whiteboardIdstringSimID do quadro branco do Confluence que contém a propriedade a atualizar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_UPDATE_PAGE

Atualiza uma página existente do Confluence, substituindo todo o conteúdo da página. Use quando precisar modificar documentação ou conteúdo existente.

NomeTipoObrigatórioDescrição
idstringSimID da página a atualizar. Deve ser uma string; converta de IDs numéricos retornados por CONFLUENCE_GET_PAGE_BY_ID antes de passar.
bodyobjectSimCorpo do conteúdo atualizado da página. Requer value (o conteúdo no formato especificado) e representation (storage para formato de armazenamento/XHTML do Confluence, ou atlas_doc_format para Atlassian Document Format/ADF). Substitui todo o conteúdo da página — sempre envie o conteúdo completo desejado. Forneça exatamente uma chave de representação (storage, atlas_doc_format ou wiki) cujo valor corresponda ao campo representation; chaves incompatíveis ou múltiplas causam erros de validação.
titlestringSimTítulo atualizado da página. IMPORTANTE: O Confluence exige títulos únicos por espaço. Se alterar o título para um que já existe no mesmo espaço, a atualização falhará.
spaceIdstringNãoID do espaço que contém a página. Opcional se o espaço da página não precisar ser alterado.
versionobjectSimInformações de versão para a atualização. Deve incluir number definido como exatamente versão_atual + 1. Busque a versão atual via CONFLUENCE_GET_PAGE_BY_ID antes de atualizar. Em caso de conflito 409, rebusque a versão mais recente e tente novamente.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_UPDATE_SPACE_PROPERTY

Atualiza uma propriedade de espaço. Use quando precisar modificar metadados personalizados armazenados em um espaço do Confluence (requer buscar a versão atual da propriedade primeiro).

NomeTipoObrigatórioDescrição
valuestringSimNova string JSON de valor para a propriedade de espaço especificada.
spaceIdintegerSimID do espaço ao qual a propriedade pertence.
propertyIdstringSimID da propriedade de espaço a atualizar. Pode ser um ID numérico ou uma string de chave de propriedade.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CONFLUENCE_UPDATE_TASK

Atualiza o status de uma tarefa do Confluence. Use quando precisar marcar tarefas como concluídas ou pendentes em fluxos de trabalho ou painéis.

NomeTipoObrigatórioDescrição
idstringSimID da tarefa a atualizar.
statusstringSimStatus da tarefa. Valores: complete, incomplete.
body_formatstringNãoFormato de corpo opcional para a resposta. Valores: storage, atlas_doc_format.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.