Permite editar vários eventos do módulo Workflow e seus atributos customizados em lote, sem a obrigatoriedade de informar atributos customizados obrigatórios.
URL
{WSUrl}/api/v2/events
MÉTODO DE SOLICITAÇÃO
PUT
PARÂMETRO DA URL
Essa funcionalidade não possui parâmetros.
CONTEÚDO DO FORMULÁRIO
Title (opcional): nome do evento que será atualizado no módulo Workflow. O limite é de 2.500 caracteres.
Description (opcional): descrição do evento que será atualizado no módulo Workflow. O limite é de 5.500 caracteres.
Progress (opcional): percentual de progresso alcançado no evento. Valores válidos: de 0 a 100. Observe que o progresso só pode ser editado em eventos abertos.
Urgency (opcional): urgência do evento que será atualizado no módulo Workflow. Valores válidos: números inteiros entre 1 e 5, com 1 (Muito Baixa), 2 (Baixa), 3 (Média), 4 (Alta) e 5 (Muito Alta).
Relevance (opcional): relevância do evento que será atualizado no módulo Workflow. Valores válidos: números inteiros entre 1 e 5, com 1 (Muito Baixa), 2 (Baixa), 3 (Média), 4 (Alta) e 5 (Muito Alta).
Severity (opcional): severidade do evento que será atualizado no módulo Workflow. Valores válidos: números inteiros entre 1 e 5, com 1 (Muito Baixa), 2 (Baixa), 3 (Média), 4 (Alta) e 5 (Muito Alta).
Status (opcional): permite a mudança da situação do evento. Valores válidos:
•0 – Cancela o evento (uma vez cancelado o evento, seu estado ou progresso não pode mais ser alterado).
•1 – Reabre um evento fechado.
•2 – Fecha um evento (uma vez fechado, o progresso do evento não pode ser alterado, mas o evento pode ser reaberto).
Latitude (opcional; obrigatório caso o campo "Longitude" esteja preenchido): latitude da localização do evento do módulo Workflow. Valores válidos: de -90.0 a +90.0.
Longitude (opcional; obrigatório caso o campo "Latitude" esteja preenchido): longitude da localização do evento do módulo Workflow. Valores válidos: de -180.0 a +180.0.
GeolocationDescription (opcional): descrição da localização geográfica do evento do Workflow. O limite é de 1.000 caracteres.
ExpectedStartDate (opcional): data prevista para o início do evento. Formatos válidos: veja o tópico Orientações técnicas -> Formato válido para os campos Data e Hora.
ExpectedEndDate (opcional): data prevista para o término do evento. Formatos válidos: veja o tópico Orientações técnicas -> Formato válido para os campos Data e Hora.
StartDate (opcional): data real do início do evento. Formatos válidos: veja o tópico Orientações técnicas -> Formato válido para os campos Data e Hora.
EndDate (opcional): data real do término do evento. Formatos válidos: veja o tópico Orientações técnicas -> Formato válido para os campos Data e Hora.
Deadline (opcional): prazo definido para o evento. Formatos válidos: veja o tópico Orientações técnicas -> Formato válido para os campos Data e Hora.
Value (opcional): valor monetário para o evento. Valores válidos: números reais positivos.
Notify (opcional): notificações enviadas aos usuários por e-mail quando o evento é atualizado. Valores válidos: "true" ou "false".
ParentEvent (opcional): código do evento pai. Valores válidos: códigos de eventos existentes.
Coordinator (opcional): coordenador alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
Responsible (opcional): pessoa ou grupo alocado como responsável pelo evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
FirstReviewer (opcional): primeiro revisor alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
SecondReviewer (opcional): segundo revisor alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
ThirdReviewer (opcional): terceiro revisor alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
FourthReviewer (opcional): quarto revisor alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
FifthReviewer (opcional): quinto revisor alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
SixthReviewer (opcional): sexto revisor alocado para o evento. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
Comment (opcional; obrigatório caso o campo "Progress" esteja preenchido): comentário com a justificativa para a atualização do evento.
CustomAttributes (opcional): lista de objetos com informações sobre os atributos de eventos. Cada atributo é referenciado através do nome da variável.
EventType (opcional): permite a edição do tipo de evento. Observe que os eventos de riscos e de compliance não podem ter o seu tipo alterado, e os eventos padrão ou próprios não podem ser alterados para eventos de riscos ou compliance.
Id (obrigatório): identificador do evento.
Nota 1: o envio do valor "null" nos campos significa que os valores inseridos serão ignorados.
Nota 2: os atributos do tipo Fórmula são somente leitura, ou seja, são ignorados caso sejam enviados pela API.
Nota 3: apenas os atributos customizados opcionais podem ser editados no campo CustomAttributes. Atributos obrigatórios não são atualizados nesta requisição.
EXEMPLO DE SOLICITAÇÃO
{WSUrl}/api/v2/events
EXEMPLO DO CONTEÚDO DO FORMULÁRIO
Cancela um evento e altera o tipo de outro evento:
{
"Id": "768E2B8D-9768-42AE-8EBG-B1FE5EE87YUF",
"Status" : 0,
"Comment" : "Evento cancelado por falta de recursos."
},
{
"Id": "C528F32B-D657-4896-9D18-B8E74AF08A25",
"EventType" : "Generic Event"
}
Altera a descrição de dois eventos:
[
{
"Id": "223E2B8D-9488-42AE-8EDB-B1FE5EE8A9AF",
"Description": "evento EVTD202302229124 alterado via endpoint"
},
{
"Id": "C528F32B-D657-4896-9D18-B8E74AF08A25",
"Description": "evento EVTD202302229124 alterado via endpoint"
}
]
RESPOSTA DE SUCESSO
Retorna os códigos dos eventos que foram atualizados.
{
"Successfull": [
"EVTD202302229124",
"EVTR202407281008"
],
"Fails": []
}