Este guia irá percorrer as etapas necessárias para criar uma Ação ou Ações em um Board específico no Fluid.
No contexto deste artigo, uma Ação também pode ser chamada de Card ou Tarefa, e essa terminologia pode ser usada de forma intercambiável.
Requisitos
Autenticação - Token PAT
Você precisará de um nome de usuário válido e de um token PAT como parte da solicitação da API REST. Você pode encontrar mais informações sobre como gerar um token PAT aqui Criando um Token de Acesso Pessoal.
Identificador do Board - GUID
O GUID do board é a chave que identifica exclusivamente um board.
Você pode usar a API REST de Board aqui Listar Boards para encontrar o GUID do board ou, alternativamente, o GUID de um board pode ser encontrado na URL do navegador. Navegue até o board para o qual deseja criar a ação; a URL deve aparecer como http://organisation.fluid.work/Process/Board/7505a102-93fc-4465-a23b-2eb6303f7f71, sendo que o valor 7505a102-93fc-4465-a23b-2eb6303f7f71 é o GUID do board que você deve passar como parte do payload de criação da Ação.
O GUID do board é referido como GUID Principal na terminologia do Fluid. Um principal é considerado um objeto de nível 1 dentro do framework Fluid e representa o contêiner ao qual esta Ação pertence. Exemplos de principais incluem Usuários, Reuniões, Projetos etc. Neste artigo, a Ação é criada com seu GUID principal definido como o GUID do board.
Criando uma única Ação em um Board
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://organisation.fluid.work/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"
}Criando múltiplas Ações em um Board
HTTP
POST https://organisation.fluid.work/rest/api/action/bulk
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action/bulk' \
--header 'Content-Type: application/json' \
--data '[
{
"Fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "BULK Create 1",
"description": "Bulk Create 1 - Description",
"status": "Not Started",
"taskType": "Task"
}
},
{
"fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "BULK Create 2",
"description": "Bulk Create 2 - Description",
"status": "Not Started",
"taskType": "Task"
}
}
]'com parâmetros opcionais
HTTP
POST https://organisation.fluid.work/rest/api/action/bulk?fields={fields}&$expand={$expand}&version=3.0
cURL
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action/bulk?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data '[
{
"Fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "BULK Create 1",
"description": "Bulk Create 1 - Description",
"status": "Not Started",
"taskType": "Task"
}
},
{
"fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "BULK Create 2",
"description": "Bulk Create 2 - 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,
"businessValue": 0,
"chatCount": 0,
"contentType": "Task",
"createDate": "2024-02-16T18:22:18.0000000",
"description": "Bulk Create 1 - Descrption",
"descriptionHtml": "Bulk Create 1 - Descrption",
"dueDate": null,
"endDate": null,
"impediment": 0,
"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-16T18:22:18.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",
"shortCode": "DB-117",
"startDate": null,
"status": "Not Started",
"statusCode": 4,
"taskType": "Task",
"title": "BULK Create 1",
"titleRichText": "BULK Create 1",
"titleHtml": "BULK Create 1"
},
"id": 4415,
"methods": [
{
"type": "PermaLink",
"httpMethod": "GET",
"url": "https://organisation.fluid.work/Action/EditFull/90d486aa-11e9-461d-85a0-f72df83a5e5f"
},
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/action/4415",
"description": "Update Action",
"payload": {
"fields": {
"description": "<Description>",
"title": "<Title>"
},
"customProperties": []
}
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/action/4415"
}
],
"guid": "90d486aa-11e9-461d-85a0-f72df83a5e5f",
"url": "https://organisation.fluid.work/rest/api/action/4415"
},
{
"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,
"businessValue": 0,
"chatCount": 0,
"contentType": "Task",
"createDate": "2024-02-16T18:22:18.0000000",
"description": "Bulk Create 2 - Descrption",
"descriptionHtml": "Bulk Create 2 - Descrption",
"dueDate": null,
"endDate": null,
"impediment": 0,
"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-16T18:22:18.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",
"shortCode": "DB-118",
"startDate": null,
"status": "Not Started",
"statusCode": 4,
"taskType": "Task",
"title": "BULK Create 2",
"titleRichText": "BULK Create 2",
"titleHtml": "BULK Create 2"
},
"id": 4416,
"methods": [
{
"type": "PermaLink",
"httpMethod": "GET",
"url": "https://organisation.fluid.work/Action/EditFull/778f7f08-fe2b-4b4f-9e52-49ea2c9319e8"
},
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/action/4416",
"description": "Update Action",
"payload": {
"fields": {
"description": "<Description>",
"title": "<Title>"
},
"customProperties": []
}
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/action/4416"
}
],
"guid": "778f7f08-fe2b-4b4f-9e52-49ea2c9319e8",
"url": "https://organisation.fluid.work/rest/api/action/4416"
}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 |
Descreve uma lista de usuários aos quais esta ação foi atribuída | |
Descreve o usuário que criou esta Ação | |
Descreve o usuário que modificou esta Ação pela última vez | |
Descreve uma lista de usuários que são proprietários desta ação | |
Descreve uma lista de propriedades personalizadas para esta Ação, se configuradas. | |
Descreve as ações relevantes que podem ser realizadas nesta Ação, incluindo informações de URL REST e payload |
Attachments[]
Nome | Descrição |
id | O inteiro Id, identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid, identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
type | O tipo de anexo, Relatório etc. |
status | Status do anexo |
fileName | O nome do arquivo do anexo |
title | Título do anexo |
modifiedDate | A última data em que o anexo foi modificado |
modifiedBy | O Usuário que fez a última modificação no anexo |
link | O link URL para baixar o anexo |
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 único 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 |
Assignee[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Author
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
ModifiedBy
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Owners[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Methods[]
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. |