Exclui uma única Action existente.
Exclusões no Fluid são não permanentes. Actions que são excluídas são internamente marcadas como arquivadas e normalmente não são mais incluídas como parte do conjunto de dados ativos utilizado no Fluid.
Exclui uma Action
HTTP
DELETE https://organisation.fluid.work/rest/api/action/{id}
cURL
curl --user username:patToken --location --request DELETE 'http://organisation.fluid.work/rest/api/action/4360' \
--header 'Content-Type: application/json' \
}'
com parâmetros opcionais
HTTP
DELETE https://organisation.fluid.work/rest/api/action/?fields={fields}&$expand={$expand}&version=3.0
cURL
curl --user username:patToken --location --request PUT 'http://organisation.fluid.work/rest/api/action/4360?fields=all&expand=all' \
--header 'Content-Type: application/json' \
}'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-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
Nome | Em | Obrigatório | Tipo | Descrição |
fields | query | false | string | Lista separada por vírgulas dos campos solicitados a serem retornados na resposta |
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á utilizada. |
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é a próxima recarga) |
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 recarga da capacidade |
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 |
Assignee[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Author
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
ModifiedBy
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Owners[]
Nome | Descrição |
id | O inteiro Id identifica exclusivamente este Usuário específico, pode ser intercambiável com guid, veja abaixo |
guid | A string guid identifica exclusivamente este Usuário específico, pode ser intercambiável com id, veja acima |
name | O nome completo deste Usuário |
username | O nome de usuário associado a este Usuário |
E-mail único associado a este Usuário |
Expand
O parâmetro de consulta "expand=all" expandirá todas as propriedades de resposta possíveis listadas abaixo que estão associadas a esta entidade. "expand=none" para ocultar todas as propriedades de resposta.
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 é reportável |
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 conjunto de valores expandidos solicitado no parâmetro de consulta "expand=method"; os métodos são propriedades auxiliares para outros endpoints de API de 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. |
Related[]
Propriedades retornadas para o valor expandido solicitado definido no parâmetro de consulta "expand=related"; relacionados são outras entidades que compartilham um relacionamento com esta entidade, podendo ser um relacionamento pai, irmão ou filho
Nome | Descrição |
Parent | Item pai relacionado a esta Ação |
From | Esta Ação foi relacionada a partir desta Entidade |
FollowOn[] | Array de entidades FollowOn relacionadas a esta Ação |
Children[] | Array de entidades filhas relacionadas a esta Ação |
Project[] | Array de entidades de Projeto relacionadas a esta Ação |
Catalog[] | Array de entidades de Catálogo relacionadas a esta Ação |
FollowOn[]
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 |
Title | Título desta Ação |
Name | Nome desta Ação |
CreatedDate | Timestamp de criação desta Ação |
ModifiedDate | Timestamp da última modificação desta Ação |
Type | Tipo desta Ação |
Status | Status desta Ação |
Description | Descrição desta Ação |
PercentageComplete | Qual percentual desta Ação foi concluído |
Methods[] | Array de métodos da API REST que esta Ação pode executar |
ExternalReference | Se esta Ação possui uma referência a uma integração ou sistema externo, o id de referência externa é exibido aqui |
ReferenceId | Identificador de referência interno do Fluid |
Principal | O contêiner principal desta Ação |
AssignedTo | Usuário ao qual esta Ação foi atribuída |
RagStatus | Status RAG desta Ação, se aplicável |
StartDate | Timestamp de início desta Ação |
DueDate | Timestamp de vencimento desta Ação |
Owner | Proprietário desta Ação |
Priority | Prioridade desta Ação |
ModifiedBy | Usuário que modificou esta Ação por último |
ParentGuid | Identificador guid pai desta Ação |
AttachmentCount | Número de anexos associados a esta Ação |
ContentType | O tipo de conteúdo desta Ação |
Children[]
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 |
Title | Título desta Ação |
Name | Nome desta Ação |
CreatedDate | Timestamp de criação desta Ação |
ModifiedDate | Timestamp da última modificação desta Ação |
Type | Tipo desta Ação |
Status | Status desta Ação |
Description | Descrição desta Ação |
PercentageComplete | Qual percentual desta Ação foi concluído |
Methods[] | Array de Métodos da API REST que esta Ação pode executar |
ExternalReference | Se esta Ação possui uma referência a uma integração ou sistema externo, o id de referência externo é exibido aqui |
ReferenceId | Identificador de referência interno do Fluid |
Principal | O contêiner principal desta Ação |
AssignedTo | Usuário ao qual esta Ação foi atribuída |
RagStatus | Status RAG desta Ação, se aplicável |
StartDate | Timestamp de início desta Ação |
DueDate | Timestamp de vencimento desta Ação |
Owner | Proprietário desta Ação |
Priority | Prioridade desta Ação |
ModifiedBy | Usuário que modificou esta Ação pela última vez |
ParentGuid | Identificador guid pai desta Ação |
AttachmentCount | Número de anexos associados a esta Ação |
ContentType | O tipo de conteúdo desta Ação |
Project[]
Nome | Descrição |
Id | O inteiro Id identifica exclusivamente este Projeto específico, pode ser intercambiável com guid, veja abaixo |
Guid | A string guid identifica exclusivamente este Projeto específico, pode ser intercambiável com id, veja acima |
Category | A Categoria à qual este Projeto está alinhado |
ProjectManager | O usuário designado como Gerente de Projeto para este Projeto |
Description | Descrição deste Projeto |
ExternalReference | Identificador de Referência Externa para este Projeto |
Name | Nome deste Projeto |
Type | Tipo deste Projeto |
Status | Status deste Projeto |
Owner | Proprietário deste Projeto |
ParentGuid | Identificador guid pai desta Ação |
Catalog[]
Nome | Descrição |
Id | O inteiro Id identifica exclusivamente este Catálogo específico, 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 |
Name | Nome deste Catálogo |
ReferenceId | Id de referência deste Catálogo |
CatalogTypeGuid | Guid único que representa o tipo ao qual este Catálogo pertence |
Attachment[]
Propriedades retornadas para o valor expandido solicitado definido 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 |
Integration[]
Propriedades retornadas para o valor expandido solicitado definido no parâmetro de consulta "expand=integration" ou "expand=integration,related" ou "expand=integration,related,subtask". Detalhes de integração conforme definidos para esta entidade, podem ser usados com "related" e/ou "subtask", para exibir detalhes de itens integrados relacionados e/ou subtarefas no aplicativo de terceiros
Nome | Descrição |
Id | O inteiro Id identifica exclusivamente este item Integrado específico, pode ser intercambiável com guid, veja abaixo |
Guid | A string guid identifica exclusivamente este item Integrado específico, pode ser intercambiável com id, veja acima |
Title | Título deste item Integrado |
Name | Nome deste item Integrado |
CreatedDate | Timestamp de quando este item Integrado foi criado |
ModifiedDate | Timestamp de quando este item Integrado foi modificado pela última vez |
Type | Tipo deste item Integrado |
Status | Nome do status deste item Integrado |
StatusCode | Código de status conforme resolvido nos Status do Fluid |
Description | Descrição deste item Integrado |
PercentageComplete | Qual percentual deste item Integrado foi concluído |
ExternalReference | O id de referência externa exclusivo do sistema externo |
ReferenceId | Identificador de referência interno do Fluid |
Principal | O contêiner principal deste item Integrado |
AssignedTo | Usuário ao qual este item Integrado foi atribuído |
StartDate | Timestamp de início deste item Integrado, se mapeado e existente |
DueDate | Timestamp de vencimento deste item Integrado, se mapeado e existente |
EndDate | Timestamp de término deste item Integrado, se mapeado e existente |
Owner | Proprietário deste item Integrado |
Priority | Prioridade deste item Integrado, se mapeada e existente |
ModifiedBy | Usuário que modificou este item Integrado pela última vez |
ParentGuid | Identificador guid pai deste item Integrado |
AttachmentCount | Número de anexos associados a este item Integrado |
NotStartedCount | Número total de subtarefas deste item Integrado que estão com status Não Iniciado (os status Não Iniciado são definidos conforme a configuração integrada) |
InProgressCount | Número total de subtarefas deste item Integrado que estão com status Em Andamento |
CompletedCount | Número total de subtarefas deste item Integrado que estão com status Concluído |
NotStartedPercentage | Não iniciado como percentual (%) |
InProgressPercentage | Em Andamento como percentual (%) |
CompletedPercentage | Concluído como percentual (%) |
Points | Pontos alocados a este item, se mapeados e existentes |
BusinessValue | Valor de negócio alocado a este item, se mapeado e existente |
LastSync | Timestamp de quando este item foi sincronizado pela última vez no Fluid |
ExternalStatus | O status da sincronização/sistema externo. (Válido / Inválido / Ausente / Confidencial) |
SubTasks[] | Lista de Subtarefas definidas para este item de integração externa (relacionamento descendente filho) |
Linked[] | Lista de itens externos vinculados definidos para este item de integração (relacionamento de irmão) |
CustomProperties[] | Propriedades Personalizadas que foram mapeadas e definidas por configuração de integração |
IsCompleted | Verdadeiro se este item de integração estiver em estado Concluído, Falso caso contrário |
IsInProgress | Verdadeiro se este item de integração estiver em estado Em Andamento, Falso caso contrário |
IsNotStarted | Verdadeiro se este item de integração estiver em estado Não Iniciado, Falso caso contrário |
SubTasks[]
Os itens de integração de SubTarefas são itens que possuem um relacionamento pai-filho com o item Integrado atual. Eles são descendentes diretos deste item de Integração.
Nome | Descrição |
Id | O inteiro Id identifica exclusivamente este item de subtarefa externa específico no sistema externo |
Title | Título do item de subtarefa externa |
Status | Nome do status do item de subtarefa externa |
StatusCode | Código de status conforme resolvido nos Status do Fluid |
Description | Descrição do item de subtarefa externa |
PercentageComplete | Qual percentual do item de subtarefa externa foi concluído |
StartDate | Timestamp de início do item de subtarefa externa, se mapeado e houver algum |
DueDate | Timestamp de vencimento do item de subtarefa externa, se mapeado e houver algum |
EndDate | Timestamp de término do item de subtarefa externa, se mapeado e houver algum |
Priority | Prioridade do item de subtarefa externa, se mapeado e houver algum |
NotStartedCount | Número total de subtarefas do item de subtarefa externa que estão com status NotStarted (os status NotStarted são definidos conforme a configuração integrada) |
InProgressCount | Número total de subtarefas do item de subtarefa externa que estão com status Em Andamento |
CompletedCount | Número total de subtarefas do item de subtarefa externa que estão com status Concluído |
NotStartedPercentage | Não iniciado como percentual (%) |
InProgressPercentage | Em Andamento como percentual (%) |
CompletedPercentage | Concluído como percentual (%) |
Points | Pontos alocados a este item de subtarefa externa, se mapeado e houver algum |
BusinessValue | BusinessValue alocado a este item de subtarefa externa, se mapeado e houver algum |
LastSync | Timestamp da última sincronização deste item de subtarefa externa no Fluid |
ExternalStatus | O status da sincronização/sistema externo. ( Válido / Inválido / Ausente / Confidencial) |
IsCompleted | Verdadeiro se este item de integração estiver no estado Concluído, Falso caso contrário |
IsInProgress | Verdadeiro se este item de integração estiver no estado Em Andamento, Falso caso contrário |
IsNotStarted | Verdadeiro se este item de integração estiver no estado Não Iniciado, Falso caso contrário |
Linked[]
Itens de integração vinculados são itens que possuem um relacionamento de irmão com o item Integrado atual. Eles estão relacionados por meio de um vínculo, não por um relacionamento pai-filho.
Nome | Descrição |
Id | O inteiro Id identifica exclusivamente este item vinculado externo específico no sistema externo |
Title | Título do item vinculado externo |
Status | Nome do status do item vinculado externo |
StatusCode | Código de status conforme resolvido nos Status do Fluid |
Description | Descrição do item vinculado externo |
PercentageComplete | Qual percentual do item vinculado externo foi concluído |
StartDate | Timestamp de início do item vinculado externo, se mapeado e houver algum |
DueDate | Timestamp de vencimento do item vinculado externo, se mapeado e houver algum |
EndDate | Timestamp de término do item vinculado externo, se mapeado e houver algum |
Priority | Prioridade do item vinculado externo, se mapeado e houver algum |
NotStartedCount | Número total de subtarefas do item vinculado externo que estão com status NotStarted (os status NotStarted são definidos conforme a configuração integrada) |
InProgressCount | Número total de subtarefas do item vinculado externo que estão com status Em Andamento |
CompletedCount | Número total de subtarefas do item vinculado externo que estão com status Concluído |
NotStartedPercentage | Não iniciado como percentual (%) |
InProgressPercentage | Em Andamento como percentual (%) |
CompletedPercentage | Concluído como percentual (%) |
Points | Pontos alocados a este item de subtarefa externa, se mapeado e houver algum |
BusinessValue | BusinessValue alocado a este item de subtarefa externa, se mapeado e houver algum |
LastSync | Timestamp da última sincronização deste item de subtarefa externa no Fluid |
ExternalStatus | O status da sincronização/sistema externo. ( Válido / Inválido / Ausente / Confidencial) |
IsCompleted | Verdadeiro se este item de integração estiver no estado Concluído, Falso caso contrário |
IsInProgress | Verdadeiro se este item de integração estiver no estado Em Andamento, Falso caso contrário |
IsNotStarted | Verdadeiro se este item de integração estiver no estado Não Iniciado, Falso caso contrário |
CustomProperties[]
Nome | Descrição |
Name | Nome da Propriedade Personalizada conforme mapeado na configuração de integração |
Value[] | Lista de valor(es) para esta Propriedade Personalizada |
SyncMode | O modo de sincronização desta Propriedade Personalizada por configuração de integração |
Checklist[]
Propriedades retornadas para o valor expandido solicitado no parâmetro de consulta "expand=checklist". Propriedades de checklist que são 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) |
Chat[]
Propriedades retornadas para o valor expandido solicitado no parâmetro de consulta "expand=chat"; chat são comentários/conversas de chat associados a esta entidade
Nome | Descrição |
Id | Id único que representa esta mensagem de chat |
Content | Representação somente em texto do conteúdo da mensagem de chat |
TopicId | O Id do tópico/sala de chat para o qual esta mensagem de chat foi publicada |
Display | Versão HTML do conteúdo exibido ao usuário |
Initiator | O usuário que publicou esta mensagem de chat |
Timestamp | O timestamp de quando esta mensagem de chat foi publicada |
Title | O título da sala de chat para a qual esta mensagem de chat foi publicada |