Esta guía explicará los pasos necesarios para crear una Acción o Acciones en un Tablero específico en Fluid.
En el contexto de este artículo, una Acción también puede denominarse Tarjeta o Tarea, y esta terminología puede utilizarse indistintamente.
Requisitos
Autenticación - token PAT
Necesitará un nombre de usuario válido y un token PAT como parte de la solicitud de la API REST. Puede encontrar más información sobre cómo generar un token PAT aquí Creación de un token de acceso personal.
Identificador de tablero - GUID
El GUID del Tablero es la clave que identifica de manera única a un Tablero.
Puede usar la API REST de Tableros aquí Listar tableros para encontrar el GUID del Tablero, o bien, el GUID de un Tablero se puede encontrar en la URL del navegador. Navegue hasta el Tablero para el que desea crear la acción, la URL debería verse como http://organisation.fluid.work/Process/Board/7505a102-93fc-4465-a23b-2eb6303f7f71 el valor 7505a102-93fc-4465-a23b-2eb6303f7f71 es el GUID del Tablero que debe pasar como parte del payload de creación de la Acción.
El GUID del Tablero se conoce como GUID principal en la terminología de Fluid. Un principal se considera un objeto de nivel 1 dentro del framework de Fluid y representa el contenedor al que pertenece esta Acción. Ejemplos de principales incluyen Usuarios, Reuniones, Proyectos, etc. En este artículo, la Acción se crea con su GUID principal definido como el GUID del Tablero.
Creación de una sola Acción en un Tablero
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"
}
}'
con parámetros opcionales
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"
}
}'
Respuesta
Código de estado: 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"
}
Creación de múltiples Acciones en un Tablero
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"
}
}
]'
con parámetros opcionales
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"
}
}
]'
Respuesta
Código de estado: 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"
}Definiciones
|
Nombre |
Descripción |
|
id |
El número entero Id identifica de manera única a esta Acción en particular; puede intercambiarse con guid, ver abajo |
|
guid |
La cadena guid identifica de manera única a esta Acción en particular; puede intercambiarse con id, ver arriba |
|
url |
La URL de REST GET de esta Acción |
|
fields |
Mapa de campos y valores de la Acción |
|
Describe una lista de usuarios a los que se ha asignado esta acción |
|
|
Describe al usuario que creó esta Acción |
|
|
Describe al usuario que modificó esta Acción por última vez |
|
|
Describe una lista de usuarios propietarios de esta acción |
|
|
Describe una lista de customProperties de esta Acción, si están configuradas. |
|
|
Describe las acciones relevantes que se pueden realizar sobre esta Acción, incluyendo información de la URL de REST y del payload |
Attachments[]
|
Nombre |
Descripción |
|
id |
El número entero Id identifica de manera única a este Usuario en particular; puede intercambiarse con guid, ver abajo |
|
guid |
La cadena guid identifica de manera única a este Usuario en particular; puede intercambiarse con id, ver arriba |
|
type |
El tipo de adjunto, Informe, etc. |
|
status |
Estado del adjunto |
|
fileName |
El nombre de archivo del adjunto |
|
title |
Título del adjunto |
|
modifiedDate |
La última fecha en que se modificó el adjunto |
|
modifiedBy |
El Usuario que realizó la última modificación al adjunto |
|
link |
El enlace URL para descargar el adjunto |
CustomProperties[]
|
Nombre |
Descripción |
|
guid |
La cadena guid identifica de manera única a esta propiedad personalizada en particular |
|
dataType |
El tipo de dato del valor de esta Propiedad personalizada. Por ejemplo, Texto, Fecha y hora, etc. |
|
isAdminLocked |
|
|
isCatalogType |
La Propiedad personalizada es un Tipo de catálogo y se usa como parte de la taxonomía |
|
isMultiple |
Puede contener múltiples valores |
|
isSubType |
|
|
key |
Clave de nombre única que identifica esta Propiedad personalizada por nombre |
|
required |
Indicador que señala que esta Propiedad personalizada requiere un valor válido |
|
reportable |
Indicador que señala que esta Propiedad personalizada puede incluirse en informes |
|
readOnly |
Indicador que señala que el valor es de solo lectura y no se puede modificar |
|
value |
El valor de esta Propiedad personalizada |
Assignee[]
|
Nombre |
Descripción |
|
id |
El número entero Id identifica de manera única a este Usuario en particular; puede intercambiarse con guid, ver abajo |
|
guid |
La cadena guid identifica de manera única a este Usuario en particular; puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
Author
|
Nombre |
Descripción |
|
id |
El número entero Id identifica de manera única a este Usuario en particular; puede intercambiarse con guid, ver abajo |
|
guid |
La cadena guid identifica de manera única a este Usuario en particular; puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
ModifiedBy
|
Nombre |
Descripción |
|
id |
El número entero Id identifica de manera única a este Usuario en particular; puede intercambiarse con guid, ver abajo |
|
guid |
La cadena guid identifica de manera única a este Usuario en particular; puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
Owners[]
|
Nombre |
Descripción |
|
id |
El número entero Id identifica de manera única a este Usuario en particular; puede intercambiarse con guid, ver abajo |
|
guid |
La cadena guid identifica de manera única a este Usuario en particular; puede intercambiarse con id, ver arriba |
|
name |
El nombre completo de este Usuario |
|
username |
El nombre de usuario asociado a este Usuario |
|
|
Correo electrónico único asociado a este Usuario |
Methods[]
|
Nombre |
Descripción |
|
type |
El tipo de acción que realiza este método |
|
httpMethod |
Verbo del método de solicitud HTTP |
|
url |
La URL de REST que se puede usar con el verbo del método HTTP |
|
description |
Descripción de lo que realiza este método |
|
payload |
Payload de ejemplo relacionado con el verbo del método HTTP. Este payload suele ser el mínimo necesario para realizar el método del verbo. |