Os exemplos abaixo ilustram vários casos de uso para atualizar uma única Action.
As chamadas de atualização da REST API para uma Action devem enviar via POST todos os campos no corpo do payload. As chamadas de atualização não são alterações DELTA.
O Fluid recomenda fortemente que você faça uma chamada GET, pegue o objeto de resposta JSON, faça apenas as alterações de atualização relevantes que deseja nas propriedades necessárias e envie de volta via POST como parte do payload de ATUALIZAÇÃO da REST API.
O número máximo de Actions que podem ser atualizadas em uma única chamada de REST API em massa é 50.
Atualizar uma única Action
cURL
curl --user username:patToken --location --request PUT 'http://organisation.fluid.work/rest/api/action/4413?fields=All&expand=All' \
--header 'Content-Type: application/json' \
--data ' {
"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": "Sample Update 1",
"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": "Sample Update 1"
},
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
}
}'
Resposta de Exemplo
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-16T18:19:46.0000000",
"description": "Sample Update 1",
"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": "Sample Update 1"
},
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
}Atualizar uma única Action e atribuir a vários usuários como responsáveis
Para atualizar uma Action e atribuir vários responsáveis, como parte do payload, inclua na propriedade assignee um array de objetos com propriedades definidas para username, id, guid ou email.
cURL
curl --user username:patToken --location --request PUT 'http://oganisation.fluid.work/rest/api/action/4413' \
--header 'Content-Type: application/json' \
--data ' {
"fields": {
"assignee": [
{
"userName": "adam.jones",
},
{
"userName": "bruce.banner",
}
],
"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 Update 1",
"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 Update 1"
},
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
}'Resposta de Exemplo
Código de status: 200
JSON
{
"fields": {
"assignee": [
{
"id": 595,
"guid": "b0a1e7e6-2389-4cdc-8d7e-5263eb512e0d",
"name": "Adam Jones",
"userName": "adam.jones",
"email": "dump7@fluidbsg.com"
},
{
"id": 598,
"guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
"name": "Bruce Banner",
"userName": "bruce.banner",
"email": "bruce.banner@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 Update 1",
"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 Update 1"
},
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
}Atualizar uma única Ação com Propriedades Personalizadas em um Quadro
Para atualizar uma ação com propriedades personalizadas específicas conforme definido pela configuração do quadro onde esta Ação será criada, você precisará definir 3 valores específicos para cada propriedade personalizada. Você precisa do tipo de dado da propriedade personalizada, da chave (nome único da propriedade personalizada) e do valor que deseja definir. Observe que todos os valores, independentemente do tipo de dado, são passados como valores de string no payload.
cURL
curl --user username:patToken --location --request PUT 'http://organisation.fluid.work/rest/api/action/4413?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data ' {
"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 Update 1",
"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 Update 1"
},
"customProperties": [
{
"dataType": "Text",
"key": "custom1",
"value": "Custom Update Sample 1"
},
{
"dataType": "MultiOption",
"key": "CustomMulti",
"value": "mult2"
},
{
"dataType": "Date",
"key": "CustomDate",
"value": "2023-10-17"
}
]
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
}'Resposta de Exemplo
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-16T18:19:46.0000000",
"description": "Bulk Update 1",
"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 Update 1"
},
"customProperties": [
{
"dataType": "Text",
"key": "custom1",
"value": "Custom Update Sample 1"
},
{
"dataType": "MultiOption",
"key": "CustomMulti",
"value": "mult2"
},
{
"dataType": "Date",
"key": "CustomDate",
"value": "2023-10-17"
}
]
"id": 4413,
"guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544",
"url": "https://organisation.fluid.work/rest/api/action/4413"
}