Crea un conjunto masivo de Acciones. El Payload es una colección de objetos Acción que se van a crear.
El número máximo de Acciones que se pueden crear en una única llamada masiva a la API REST es 50.
Crea una colección de Acciones
HTTP
POST https://organisation.fluid.work/rest/api/action/bulk
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action/bulk?fields=All' \
--header 'Content-Type: application/json' \
--data '[
{
"Fields": {
"Title": "BULK Create 1",
"Description": "Bulk Create 1 - Description",
"Status": "Not Started",
"TaskType": "Task"
}
},
{
"fields": {
"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.0cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data '[
{
"Fields": {
"Title": "BULK Create 1",
"Description": "Bulk Create 1 - Description",
"Status": "Not Started",
"TaskType": "Task"
}
},
{
"fields": {
"Title": "BULK Create 2",
"Description": "Bulk Create 2 - Description",
"status": "Not Started",
"taskType": "Task"
}
}
]'Parámetros de URL
|
Nombre |
En |
Requerido |
Tipo |
Descripción |
|
fields |
query |
false |
texto |
Lista de campos solicitados separados por comas |
|
expand |
query |
false |
texto |
Parámetro expand 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 |
texto |
Versión de la API que se debe utilizar. Si no se establece, se utilizará la última versión de forma predeterminada. |
Respuesta
|
Nombre |
Tipo |
Descripción |
|
200 OK |
Acción |
operación exitosa |
|
400 |
texto |
Solicitud incorrecta |
|
401 |
texto |
El usuario no está autorizado; el nombre de usuario o el token no son válidos |
|
403 |
texto |
Prohibido: el usuario no tiene permisos para realizar la operación en este contexto en particular |
|
422 |
texto |
Argumentos no válidos: los argumentos de la solicitud, la consulta o el cuerpo no son válidos |
|
429 |
texto |
"Demasiadas solicitudes", consulte los encabezados de respuesta RateLimit-Limit (capacidad actual del límite de solicitudes), RateLimit-Remaining (tokens restantes) y RateLimit-Reset (tiempo hasta la siguiente recarga) |
Encabezados de respuesta
|
Nombre |
Tipo |
Descripción |
|
RateLimit-Limit |
texto |
Límite máximo de solicitudes permitidas |
|
RateLimit-Remaining |
texto |
Capacidad restante de solicitudes permitidas |
|
RateLimit-Reset |
texto |
Próxima fecha y hora de actualización de la capacidad |
Solicitud de ejemplo POST
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action/bulk' \
--header 'Content-Type: application/json' \
--data '[
{
"Fields": {
"Title": "BULK Create 1",
"Description": "Bulk Create 1 - Description",
"Status": "Not Started",
"TaskType": "Task"
}
},
{
"fields": {
"Title": "BULK Create 2",
"Description": "Bulk Create 2 - Description",
"status": "Not Started",
"taskType": "Task"
}
}
]'
Respuesta de ejemplo
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-16T18:19:46.0000000",
"description": "Bulk Create 1 - Descrption",
"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-16T18:19:46.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": "BULK Create 1"
},
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
},
{
"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-16T18:19:56.0000000",
"description": "Bulk Create 2 - Descrption",
"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-16T18:19:56.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": "BULK Create 2"
},
"id": 4414,
"guid": "93f8a220-098d-4894-ba98-b7c2dec27342",
"url": "https://organisation.fluid.work/rest/api/action/4414"
}
Solicitud de ejemplo POST con las opciones fields=all y expand=all
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": {
"Title": "BULK Create 1",
"Description": "Bulk Create 1 - Descrption",
"Status": "Not Started",
"TaskType": "Task"
}
},
{
"fields": {
"Title": "BULK Create 2",
"Description": "Bulk Create 2 - Descrption",
"status": "Not Started",
"taskType": "Task"
}
}
]'Respuesta de ejemplo
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 entero id identifica de forma única esta Acción en particular; se puede usar indistintamente con guid, ver a continuación |
|
guid |
La cadena guid identifica de forma única esta Acción en particular; se puede usar indistintamente con id, ver arriba |
|
url |
La Url GET de REST para esta Acción |
|
fields |
Mapa de campo y valores de la Acción |
|
Describe una lista de usuarios a los que se ha asignado esta Acción |
|
|
Describe al usuario autor de esta Acción |
|
|
Describe al usuario que modificó esta Acción por última vez |
|
|
Describe una lista de usuarios propietarios de esta Acción |
Expandir
Query parameter "expand=all" will expand all the possible response properties listed below that are associated with this entity. "expand=none" to hide all response properties.
CustomProperties[]
|
Nombre |
Descripción |
|
guid |
La cadena guid identifica de forma única esta propiedad personalizada en particular |
|
dataType |
El tipo de datos del valor de esta propiedad personalizada. P. ej., string, datetime, etc. |
|
isAdminLocked |
|
|
isCatalogType |
La propiedad personalizada es un tipo de catálogo y se usa como parte de la taxonomía |
|
isMultiple |
Puede contener varios valores |
|
isSubType |
|
|
key |
Clave de nombre única que identifica 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 se puede incluir 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 |
Methods[]
Propiedades devueltas para el valor de expansión solicitado en el parámetro de consulta "expand=method"; methods son propiedades auxiliares hacia otros endpoints de la API REST de verbos 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 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 payload mínimo necesario para ejecutar el método del verbo. |
Attachment[]
Propiedades devueltas para el valor de expansión solicitado 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 este Adjunto en particular |
|
Guid |
La cadena guid identifica de forma única este Adjunto en particular |
|
Title |
Título de este Adjunto |
|
ModifiedDate |
Marca de tiempo de la última modificación de este Adjunto |
|
Type |
Tipo de este Adjunto |
|
Status |
Estado de este Adjunto |
|
Filename |
Nombre de archivo del adjunto |
|
Url |
URL para abrir, ver o descargar este Adjunto |
|
ModifiedBy |
Usuario que modificó este Adjunto por última vez |
Checklist[]
Propiedades devueltas para el valor de expansión solicitado en el parámetro de consulta "expand=checklist". Propiedades de la lista de verificación que se definen como parte de esta entidad.
|
Nombre |
Descripción |
|
Title |
El título del elemento de la lista de verificación |
|
Status |
El estado del elemento de la lista de verificación (true/false) es (marcado/sin marcar) |