Criar Ação

Dan Justin 26 de ago de 2026

Cria uma única Action. Pode ser uma ação do usuário ou uma ação vinculada a um quadro ou outra entidade Fluid.

Se estiver criando uma Action para um quadro ou outra entidade Fluid, o usuário da conta da REST API precisa ter a permissão de gerenciamento correta para o quadro ou entidade Fluid

Se a conta não tiver permissões de gerenciamento, uma resposta Http Code 403 Forbidden será retornada.

A documentação OpenAPI pode ser encontrada em https://organisation.fluid.work/docs onde organisation é o nome da sua organização.

Criar uma Action de Usuário

HTTP

POST https://organisation.fluid.work/rest/api/action

cURL

curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action' \
--header 'Content-Type: application/json' \
--data '	{
    "fields": {
        "title": "Sample Title",
        "description": "Sample Description",
        "status": "Not Started",
        "taskType": "Task"
    }
}'

com parâmetros opcionais

HTTP

POST https://organisation.fluid.work/rest/api/action/?fields={fields}&$expand={$expand}&version=3.0

cURL

curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data '	{
    "fields": {
        "title": "Sample Title",
        "description": "Sample Description",
        "status": "Not Started",
        "taskType": "Task"
    }
}'

Resposta

Código de status: 200

JSON

{
    "fields": {
        "assignee": [
            {
                "id": 603,
                "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                "name": "David Burt",
                "userName": "david.burt",
                "email": "dump18@fluidbsg.com"
            }
        ],
        "attachmentCount": 0,
        "author": {
            "id": 603,
            "guid": "f1cb6467-0262-4539-9148-7b869defd817",
            "name": "David Burt",
            "userName": "david.burt",
            "email": "dump18@fluidbsg.com"
        },
        "businessValue": 0,
        "chatCount": 0,
        "createDate": "2024-02-16T14:45:22.0000000",
        "description": "Sample Description",
        "dueDate": null,
        "endDate": null,
        "impediment": 0,
        "isOwner": true,
        "modifiedBy": {
            "id": 603,
            "guid": "f1cb6467-0262-4539-9148-7b869defd817",
            "name": "David Burt",
            "userName": "david.burt",
            "email": "dump18@fluidbsg.com"
        },
        "modifiedDate": "2024-02-16T14:45:22.0000000",
        "owners": [
            {
                "id": 603,
                "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                "name": "David Burt",
                "userName": "david.burt",
                "email": "dump18@fluidbsg.com"
            }
        ],
        "priority": "Medium",
        "principalGuid": "f1cb6467-0262-4539-9148-7b869defd817",
        "ragStatus": "Green",
        "startDate": null,
        "status": "Not Started",
        "statusCode": 4,
        "taskType": "Task",
        "title": "Sample Title"
    },
    "id": 4360,
    "guid": "46522a95-7668-482a-a484-2952174b2430",
    "url": "https://organisation.fluid.work/rest/api/action/4360"
}

Parâmetros de URL

Nome	Em	Obrigatório	Tipo	Descrição
fields	query	false	string	Lista separada por vírgulas dos campos solicitados a serem retornados na resposta
expand	query	false	string	Parâmetro de expansão para atributos de Action. As opções possíveis são {"none" "all" "method" "related" "chat" "customAll" "customReportable" "customReadOnly" "subtask" "attachment" "state"}
version	query	false	string	Versão da API a ser utilizada. Se não definida, a versão mais recente padrão será utilizada.

Resposta

Nome	Tipo	Descrição
200 OK	Action	operação bem-sucedida
400	string	Requisição Inválida
401	string	Usuário não autorizado, nome de usuário ou token é inválido
403	string	Proibido, o usuário não tem permissão para realizar a operação neste contexto específico
422	string	Argumentos inválidos, os argumentos de requisição, query ou body são inválidos
429	string	"Muitas Requisições" veja os cabeçalhos de resposta RateLimit-Limit (capacidade atual do limite de taxa), RateLimit-Remaining (tokens restantes), RateLimit-Reset (tempo até a próxima recarga)

Cabeçalhos de Resposta

Nome	Tipo	Descrição
RateLimit-Limit	string	Limite máximo de taxa de requisições permitidas
RateLimit-Remaining	string	Capacidade restante de requisições permitidas
RateLimit-Reset	string	Próxima data e hora para renovação da capacidade

Criar uma Action em um workspace de quadro

Cria uma única Action em um workspace de quadro especificado. Mais informações sobre workspaces de quadro podem ser encontradas aqui.

Para criar uma Action em um quadro e backlog específicos, uma propriedade adicional principalGuid é necessária no payload do POST. O principalGuid é a chave única que identifica diretamente o quadro.

Você pode usar a Board REST API para obter o principalGuid de um quadro. Endpoint da Rest API para Quadros.

Um método alternativo para localizar o guid de um quadro é navegar até o quadro em um navegador e verificar a URL. Ela deve aparecer como http://organisation.fluid.work/Process/Board/7505a102-93fc-4465-a23b-2eb6303f7f71 o valor 7505a102-93fc-4465-a23b-2eb6303f7f71 é o GUID principal que você deve passar como parte do payload.

Actions em um quadro contêm um valor para a propriedade boardGuid, ao fazer uma chamada de API para obter uma Action, definindo o parâmetro de query fields=all. Esta propriedade boardGuid pode ser usada como o principalGuid do quadro.

HTTP

POST https://organisation.fluid.work/rest/api/action

cURL

curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action' \
--header 'Content-Type: application/json' \
--data '	{
    "fields": {
        "principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
        "title": "Sample Title",
        "description": "Sample Description"
        "status": "Not Started",
        "taskType": "Task"
    }
}'

com parâmetros opcionais

HTTP

POST https://organisation.fluid.work/rest/api/action/?fields={fields}&$expand={$expand}&version=3.0

cURL

curl --user username:patToken --location 'http://localhost:55648/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data '	{
    "fields": {
        "principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
        "title": "Sample Title",
        "description": "Sample Description"
        "status": "Not Started",
        "taskType": "Task"
    }
}'

Resposta

Código de status: 200

JSON

{
    "fields": {
        "assignee": [
            {
                "id": 603,
                "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                "name": "David Burt",
                "userName": "david.burt",
                "email": "dump18@fluidbsg.com"
            }
        ],
        "attachmentCount": 0,
        "author": {
            "id": 603,
            "guid": "f1cb6467-0262-4539-9148-7b869defd817",
            "name": "David Burt",
            "userName": "david.burt",
            "email": "dump18@fluidbsg.com"
        },
        "boardCategory": 0,
        "boardId": 0,
        "boardGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
        "boardTitle": "Bulk edit",
        "businessValue": 0,
        "chatCount": 0,
        "contentType": "Process",
        "createDate": "2024-02-16T19:20:41.0000000",
        "description": "Sample Description - Create Action on a Board",
        "descriptionHtml": "Sample Description - Create Action on a Board",
        "dueDate": null,
        "endDate": null,
        "isClosed": false,
        "isCalculated": false,
        "isOwner": true,
        "modifiedBy": {
            "id": 603,
            "guid": "f1cb6467-0262-4539-9148-7b869defd817",
            "name": "David Burt",
            "userName": "david.burt",
            "email": "dump18@fluidbsg.com"
        },
        "modifiedDate": "2024-02-16T19:20:41.0000000",
        "principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
        "shortCode": "BE-105",
        "startDate": null,
        "status": "Not Started",
        "statusCode": 1,
        "taskType": "Task",
        "title": "Sample Title - Create Action on a Board",
        "titleRichText": "Sample Title - Create Action on a Board",
        "titleHtml": "Sample Title - Create Action on a Board"
    },
    "id": 4433,
    "methods": [
        {
            "type": "PermaLink",
            "httpMethod": "GET",
            "url": "https://organisation.fluid.work/Action/EditFull/12c2e661-270c-43e1-8d05-1218b5842b6c"
        },
        {
            "type": "Update",
            "httpMethod": "PUT",
            "url": "https://organisation.fluid.work/rest/api/action/4433",
            "description": "Update Action",
            "payload": {
                "fields": {
                    "description": "<Description>",
                    "title": "<Title>"
                },
                "customProperties": []
            }
        },
        {
            "type": "Delete",
            "httpMethod": "DELETE",
            "url": "https://organisation.fluid.work/rest/api/action/4433"
        }
    ],
    "guid": "12c2e661-270c-43e1-8d05-1218b5842b6c",
    "url": "https://organisation.fluid.work/rest/api/action/4433"
}

Criar uma Ação em um espaço de trabalho de quadro (Sub Quadro)

Cria uma única Ação em um espaço de trabalho de quadro e em um Sub Quadro específico. Um espaço de trabalho de quadro pode conter múltiplos Sub Quadros. Cada Sub Quadro possui seu próprio guid exclusivo que o identifica, referido como ParentGuid.

Dois guids adicionais são necessários, o principalGuid guid do espaço de trabalho do quadro, e o parentGuid do próprio Sub Quadro.

Você pode usar a API REST de Quadros para obter o principalGuid de um quadro. Endpoint da API REST para Quadros.

Um método alternativo para localizar o guid de um quadro é navegar até o Sub Quadro em um navegador e verificar a URL. Ela deve ser exibida como https://organisation.fluid.work/Process/Board/c07hed88-10h0-4hc4-hec5-h57073b8e036/19ef7803-8e9e-4037-a613-0761336e0bcb/58c0kk41-2ekf-41k9-9kc3-27dke10bkadd/

c07hed88-10h0-4hc4-hec5-h57073b8e036 é o principalGuid

58c0kk41-2ekf-41k9-9kc3-27dke10bkadd é o parentGuid

Se você não especificar um parentGuid, a Ação será criada no backlog do espaço de trabalho do quadro

HTTP

POST https://organisation.fluid.work/rest/api/action

cURL

curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action' \
--header 'Content-Type: application/json' \
--data '	{
    "fields": {
        "principalGuid": "c07hed88-10h0-4hc4-hec5-h57073b8e036",
        "parentGuid": "58c0kk41-2ekf-41k9-9kc3-27dke10bkadd",
        "title": "Sample Title",
        "description": "Sample Description"
        "status": "Not Started",
        "taskType": "Task"
    }
}'

com parâmetros opcionais

HTTP

POST https://organisation.fluid.work/rest/api/action/?fields={fields}&$expand={$expand}&version=3.0

cURL

curl --user username:patToken --location 'http://localhost:55648/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data '	{
    "fields": {
        "principalGuid": "c07hed88-10h0-4hc4-hec5-h57073b8e036",
        "parentGuid": "58c0kk41-2ekf-41k9-9kc3-27dke10bkadd",
        "title": "Sample Title",
        "description": "Sample Description"
        "status": "Not Started",
        "taskType": "Task"
    }
}'

Resposta

Código de status: 200

JSON

{
    "fields": {
        "assignee": [
            {
                "id": 603,
                "guid": "f1cb6467-0262-4539-9148-7b869defd817",
                "name": "David Burt",
                "userName": "david.burt",
                "email": "dump18@fluidbsg.com"
            }
        ],
        "attachmentCount": 0,
        "author": {
            "id": 603,
            "guid": "f1cb6467-0262-4539-9148-7b869defd817",
            "name": "David Burt",
            "userName": "david.burt",
            "email": "dump18@fluidbsg.com"
        },
        "boardCategory": 0,
        "boardId": 0,
        "boardGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
        "boardTitle": "Bulk edit",
        "businessValue": 0,
        "chatCount": 0,
        "contentType": "Process",
        "createDate": "2024-02-16T19:20:41.0000000",
        "description": "Sample Description - Create Action on a Board",
        "descriptionHtml": "Sample Description - Create Action on a Board",
        "dueDate": null,
        "endDate": null,
        "isClosed": false,
        "isCalculated": false,
        "isOwner": true,
        "modifiedBy": {
            "id": 603,
            "guid": "f1cb6467-0262-4539-9148-7b869defd817",
            "name": "David Burt",
            "userName": "david.burt",
            "email": "dump18@fluidbsg.com"
        },
        "modifiedDate": "2024-02-16T19:20:41.0000000",
        "principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
        "shortCode": "BE-105",
        "startDate": null,
        "status": "Not Started",
        "statusCode": 1,
        "taskType": "Task",
        "title": "Sample Title - Create Action on a Board",
        "titleRichText": "Sample Title - Create Action on a Board",
        "titleHtml": "Sample Title - Create Action on a Board"
    },
    "id": 4433,
    "methods": [
        {
            "type": "PermaLink",
            "httpMethod": "GET",
            "url": "https://organisation.fluid.work/Action/EditFull/12c2e661-270c-43e1-8d05-1218b5842b6c"
        },
        {
            "type": "Update",
            "httpMethod": "PUT",
            "url": "https://organisation.fluid.work/rest/api/action/4433",
            "description": "Update Action",
            "payload": {
                "fields": {
                    "description": "<Description>",
                    "title": "<Title>"
                },
                "customProperties": []
            }
        },
        {
            "type": "Delete",
            "httpMethod": "DELETE",
            "url": "https://organisation.fluid.work/rest/api/action/4433"
        }
    ],
    "guid": "12c2e661-270c-43e1-8d05-1218b5842b6c",
    "url": "https://organisation.fluid.work/rest/api/action/4433"
}

Definições

Nome	Descrição
id	O inteiro Id, identifica exclusivamente esta Ação específica, pode ser intercambiável com guid, veja abaixo
guid	A string guid, identifica exclusivamente esta Ação específica, pode ser intercambiável com id, veja acima
url	A URL REST GET para esta Ação
fields	Mapa de campos e valores para a Ação
assignee[]	Descreve uma lista de usuários aos quais esta ação foi atribuída
author	Descreve o usuário que criou esta Ação
modifiedBy	Descreve o usuário que modificou esta Ação por último
owners[]	Descreve uma lista de usuários que são proprietários desta ação

Expandir

O parâmetro de consulta "expand=all" expandirá todas as propriedades de resposta possíveis listadas abaixo que estão associadas a esta entidade. "expand=none" para ocultar todas as propriedades de resposta.

CustomProperties[]

Nome	Descrição
guid	A string guid, identifica exclusivamente esta propriedade personalizada específica
dataType	O tipo de dado do valor para esta Propriedade Personalizada. ex.: string, datetime etc
isAdminLocked
isCatalogType	A Propriedade Personalizada é um Tipo de Catálogo e é usada como parte da taxonomia
isMultiple	Pode conter múltiplos valores
isSubType
key	Chave de nome exclusiva que identifica esta Propriedade Personalizada pelo nome
required	Sinalizador para indicar que esta Propriedade Personalizada requer um valor válido
reportable	Sinalizador para indicar que esta Propriedade Personalizada pode ser reportada
readOnly	Sinalizador para indicar que o valor é somente leitura e não pode ser alterado
value	O valor desta Propriedade Personalizada

Methods[]

Propriedades retornadas para o valor expandido solicitado definido no parâmetro de consulta "expand=method"; os métodos são propriedades auxiliares para outros endpoints de API REST com verbos que podem ser usados diretamente.

Nome	Descrição
type	O tipo de ação que este método executa
httpMethod	Verbo do Método de Requisição HTTP
url	A URL REST que pode ser usada com o verbo do Método HTTP
description	Descrição do que este método executa
payload	Payload de exemplo relacionado ao verbo do Método HTTP. Este payload é tipicamente o payload mínimo necessário para executar o método do verbo.

Attachment[]

Propriedades retornadas para o valor expandido solicitado definido no parâmetro de consulta "expand=attachment". Propriedades de lista de verificação que são definidas como parte desta entidade.

Nome	Descrição
Id	O inteiro Id identifica exclusivamente este Anexo específico
Guid	A string guid identifica exclusivamente este Anexo específico
Title	Título deste Anexo
ModifiedDate	Timestamp da última modificação deste Anexo
Type	Tipo deste Anexo
Status	Status deste Anexo
Filename	Nome do arquivo do anexo
Url	Url para abrir/visualizar ou baixar este Anexo
ModifiedBy	Usuário que modificou este Anexo por último

Chat[]

Propriedades retornadas para o conjunto de valores expandidos solicitado no parâmetro de consulta "expand=chat"; chat são comentários/conversas de chat associados a esta entidade

Nome	Descrição
Id	Id único que representa esta mensagem de chat
Content	Representação somente em texto do conteúdo da mensagem de chat
TopicId	O Id do tópico/sala de chat para o qual esta mensagem de chat foi publicada
Display	Versão HTML do conteúdo exibido ao usuário
Initiator	O usuário que publicou esta mensagem de chat
Timestamp	O timestamp de quando esta mensagem de chat foi publicada
Title	O título da sala de chat para a qual esta mensagem de chat foi publicada

Leitura Adicional

Exemplos de Criação de Ação