Crea una única Acción. Puede ser una acción de usuario o una acción vinculada a un tablero u otra entidad de Fluid.
Si está creando una Acción para un tablero u otra entidad de Fluid, el usuario de la cuenta de la REST API debe tener el permiso correcto de Gestionar para el tablero o la entidad de Fluid
Si la cuenta no tiene permisos de Gestionar, se devuelve una respuesta Http Code 403 Forbidden.
La documentación de OpenAPI se puede encontrar en https://organisation.fluid.work/docs, donde organisation es el nombre de su organización.
Crear una Acción de usuario
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"
}
}'
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": {
"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"
},
"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
|
Nombre |
En |
Requerido |
Tipo |
Descripción |
|
fields |
query |
false |
string |
Lista de campos solicitados, separados por comas, que se devolverán en la respuesta |
|
expand |
query |
false |
string |
Parámetro de expansión para los atributos de la Acción. Las opciones posibles son{"none" "all" "method" "related" "chat" "customAll" "customReportable" "customReadOnly" "subtask" "attachment" "state"} |
|
version |
query |
false |
string |
Versión de la API a utilizar. Si no se especifica, se utilizará la última versión predeterminada. |
Respuesta
|
Nombre |
Tipo |
Descripción |
|
200 OK |
Acción |
operación exitosa |
|
400 |
string |
Solicitud incorrecta |
|
401 |
string |
Usuario no autorizado, el nombre de usuario o el token no es válido |
|
403 |
string |
Prohibido, el usuario no tiene permisos para realizar la operación en este contexto en particular |
|
422 |
string |
Argumentos no válidos, los argumentos de la solicitud, consulta o cuerpo no son válidos |
|
429 |
string |
"Too many Requests", consulte los encabezados de respuesta RateLimit-Limit (capacidad actual del límite de tasa), RateLimit-Remaining (tokens restantes), RateLimit-Reset (tiempo hasta el próximo reabastecimiento) |
Encabezados de respuesta
|
Nombre |
Tipo |
Descripción |
|
RateLimit-Limit |
string |
Límite máximo de solicitudes permitidas |
|
RateLimit-Remaining |
string |
Capacidad restante de solicitudes permitidas |
|
RateLimit-Reset |
string |
Próxima fecha y hora de actualización de la capacidad |
Crear una Acción en un espacio de trabajo del tablero
Crea una única Acción en un espacio de trabajo del tablero especificado. Puede encontrar más información sobre los espacios de trabajo del tablero aquí.
Para crear una Acción en un tablero y backlog específicos, se requiere una propiedad adicional principalGuid en el payload del POST. El principalGuid es la clave única que identifica directamente al tablero.
Puede usar la Board REST API para obtener el principalGuid de un tablero. Endpoint de la Rest API para Tableros.
Un método alternativo para ubicar el guid de un tablero es navegando hasta el tablero en un navegador y observando 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 principal que debe incluir como parte del payload.
Las Acciones en un tablero contienen un valor para la propiedad boardGuid; al realizar una llamada a la API para obtener una Acción, configurando el parámetro de consulta fields=all. Esta propiedad boardGuid puede usarse como el principalGuid del 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://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"
}
}'
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"
}
Crear una Acción en un espacio de trabajo del tablero (Sub Board)
Crea una única Acción en un espacio de trabajo del tablero y en un Sub Board específico. Un espacio de trabajo del tablero puede contener múltiples Sub Boards. Cada Sub Board tiene su propio guid único que lo identifica; a esto se le conoce como el ParentGuid.
Se requieren dos guids adicionales, el principalGuid guid del espacio de trabajo del tablero, y el parentGuid del propio Sub Board.
Puede usar la Board REST API para obtener el principalGuid de un tablero. Endpoint de la Rest API para Tableros.
Un método alternativo para ubicar el guid de un tablero es navegando hasta el Sub Board en un navegador y observando la URL. Debería verse 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 es el principalGuid
58c0kk41-2ekf-41k9-9kc3-27dke10bkadd es el parentGuid
Si no especifica un parentGuid, la Acción se creará en el backlog del espacio de trabajo del 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": "c07hed88-10h0-4hc4-hec5-h57073b8e036",
"parentGuid": "58c0kk41-2ekf-41k9-9kc3-27dke10bkadd",
"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://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"
}
}'
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"
}
Definiciones
|
Nombre |
Descripción |
|
id |
El entero Id identifica de forma única a esta Acción en particular; puede usarse indistintamente con guid, ver más abajo |
|
guid |
La cadena guid, identifica de forma única a esta Acción en particular; puede usarse indistintamente con id, ver más arriba |
|
url |
La URL REST GET para esta Acción |
|
fields |
Mapa de campos y valores para la Acción |
|
assignee[] |
Describe una lista de usuarios a quienes se ha asignado esta acción |
|
author |
Describe al usuario que creó esta Acción |
|
modifiedBy |
Describe al usuario que modificó esta Acción por última vez |
|
owners[] |
Describe una lista de usuarios propietarios de esta acción |
Expandir
El parámetro de consulta "expand=all" expandirá todas las propiedades de respuesta posibles enumeradas a continuación que están asociadas a esta entidad. "expand=none" para ocultar todas las propiedades de respuesta.
CustomProperties[]
|
Nombre |
Descripción |
|
guid |
La cadena guid, identifica de forma única a esta propiedad personalizada en particular |
|
dataType |
El tipo de dato del valor de esta propiedad personalizada. Por ejemplo, string, datetime, etc. |
|
isAdminLocked |
|
|
isCatalogType |
La propiedad personalizada es un tipo de catálogo y se utiliza como parte de la taxonomía |
|
isMultiple |
Puede contener múltiples valores |
|
isSubType |
|
|
key |
Clave de nombre única que identifica a esta propiedad personalizada por su nombre |
|
required |
Indicador que señala que esta propiedad personalizada requiere un valor válido |
|
reportable |
Indicador que señala que esta propiedad personalizada es reportable |
|
readOnly |
Indicador que señala que el valor es de solo lectura y no se puede modificar |
|
value |
El valor de esta propiedad personalizada |
Methods[]
Propiedades devueltas cuando se solicita el valor de expansión mediante el parámetro de consulta "expand=method"; methods son propiedades auxiliares que enlazan con otros endpoints de verbos de la API REST y que se pueden usar directamente.
|
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 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. |
Attachment[]
Propiedades devueltas para el valor de expansión solicitado, establecido en el parámetro de consulta "expand=attachment". Propiedades de la lista de verificación que se definen como parte de esta entidad.
|
Nombre |
Descripción |
|
Id |
El entero Id identifica de forma única a este archivo adjunto en particular |
|
Guid |
La cadena guid, identifica de forma única a este archivo adjunto en particular |
|
Title |
Título de este archivo adjunto |
|
ModifiedDate |
Marca de tiempo de la última modificación de este archivo adjunto |
|
Type |
Tipo de este archivo adjunto |
|
Status |
Estado de este archivo adjunto |
|
Filename |
Nombre de archivo del adjunto |
|
Url |
URL para abrir/ver o descargar este archivo adjunto |
|
ModifiedBy |
Usuario que modificó este archivo adjunto por última vez |
Chat[]
Propiedades devueltas para el valor de expansión solicitado, establecido en el parámetro de consulta "expand=chat"; chat son comentarios/conversaciones de chat asociados a esta entidad
|
Nombre |
Descripción |
|
Id |
Id único que representa este mensaje de chat |
|
Content |
Representación de solo texto del contenido del mensaje de chat |
|
TopicId |
El Id de tema/sala de chat a la que se publicó este mensaje de chat |
|
Display |
Versión Html del contenido que se muestra al usuario |
|
Initiator |
El usuario que publicó este mensaje de chat |
|
Timestamp |
La marca de tiempo en que se publicó este mensaje de chat |
|
Title |
El título de la sala de chat a la que se publicó este mensaje de chat |