Cria um conjunto em massa de Actions. O Payload é uma coleção de Objetos Action a serem criados.
O número máximo de Actions que podem ser criadas em uma única chamada de API REST em massa é 50.
Cria uma coleção de Actions
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"
}
}
]'
com parâmetros opcionais
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
Nome | Em | Obrigatório | Tipo | Descrição |
fields | query | false | string | Lista separada por vírgulas dos campos solicitados |
expand | query | false | string | Parâmetro de expansão para atributos de Action. As opções possíveis são {"none" "all" "method" "related" "chat" "customAll" "customReportable" "customReadOnly" "subtask" "attachment" "state"} |
version | query | false | string | Versão da API a ser utilizada. Se não definida, a versão mais recente padrão será usada. |
Resposta
Nome | Tipo | Descrição |
200 OK | Action | operação bem-sucedida |
400 | string | Requisição Inválida |
401 | string | Usuário não autorizado, nome de usuário ou token é inválido |
403 | string | Proibido, o usuário não tem permissão para realizar a operação neste contexto específico |
422 | string | Argumentos inválidos, os argumentos de requisição, query ou body são inválidos |
429 | string | "Muitas Requisições" veja os cabeçalhos de resposta RateLimit-Limit (capacidade atual do limite de taxa), RateLimit-Remaining (tokens restantes), RateLimit-Reset (tempo até o próximo reabastecimento) |
Cabeçalhos de Resposta
Nome | Tipo | Descrição |
RateLimit-Limit | string | Limite máximo de taxa de requisições permitidas |
RateLimit-Remaining | string | Capacidade restante de requisições permitidas |
RateLimit-Reset | string | Próxima data e hora para renovação da capacidade |
Exemplo de Requisição 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"
}
}
]'Exemplo de 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"
},
"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"
}Solicitação de Exemplo POST com as opções fields=all e 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"
}
}
]'Exemplo de 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 |
Expand
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[]
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 |
Methods[]
Propriedades retornadas para o valor expandido solicitado no parâmetro de consulta "expand=method"; os métodos são propriedades auxiliares para outros endpoints de API com verbos REST que podem ser usados diretamente.
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. |
Attachment[]
Propriedades retornadas para o valor expandido solicitado no parâmetro de consulta "expand=attachment". Propriedades de checklist definidas como parte desta entidade.
Nome | Descrição |
Id | O inteiro Id identifica exclusivamente este Anexo específico |
Guid | A string guid identifica exclusivamente este Anexo específico |
Title | Título deste Anexo |
ModifiedDate | Timestamp da última modificação deste Anexo |
Type | Tipo deste Anexo |
Status | Status deste Anexo |
Filename | Nome do arquivo do anexo |
Url | URL para abrir/visualizar ou baixar este Anexo |
ModifiedBy | Usuário que modificou este Anexo pela última vez |
Checklist[]
Propriedades retornadas para o valor expandido solicitado no parâmetro de consulta "expand=checklist". Propriedades de checklist definidas como parte desta entidade.
Nome | Descrição |
Title | O título do item do checklist |
Status | O status do item do checklist (true/false) é (marcado/não marcado) |