Cria um evento com atributos customizados no módulo Workflow.
URL
{WSUrl}/api/v2/events
MÉTODO DE SOLICITAÇÃO
POST
PARÂMETROS DA URL
Essa funcionalidade não possui parâmetros.
CONTEÚDO DO FORMULÁRIO
Title (obrigatório): nome do evento que será criado no módulo Workflow. O limite é de 2.500 caracteres.
Description (obrigatório): descrição do evento que será criado no módulo Workflow. O limite é de 5.500 caracteres.
Progress (opcional): percentual de progresso do evento. Valores válidos: de 0 a 100.
Urgency (obrigatório): urgência do evento que será criado 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á criado 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). Se não for informado, será criado um evento com a relevância especificada ao cadastrar o aplicativo na seção Aplicações Autorizadas do módulo Administração.
Severity (opcional): severidade do evento que será criado 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). Se não for informado, será criado um evento com a severidade especificada ao cadastrar o aplicativo na seção Aplicações Autorizadas do módulo Administração.
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. A marcação decimal deve ser representada por um ponto e não por uma vírgula.
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. A marcação decimal deve ser representada por um ponto e não por uma vírgula.
GeolocationDescription (opcional): descrição da localização geográfica do evento do módulo 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 de 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 de 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. Se não for informado, será criado um evento com a opção de notificação especificada ao cadastrar o aplicativo na seção Aplicações Autorizadas do módulo Administração.
ParentEvent (opcional): código do evento pai. Valores válidos: códigos de eventos existentes.
Coordinator (opcional): coordenador alocado para o evento criado. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}. Se não for informado, será criado um evento com o coordenador especificado ao cadastrar o aplicativo na seção Aplicações Autorizadas do módulo Administração.
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"}. Se não for informado, será criado um evento com o responsável especificado ao cadastrar o aplicativo na seção Aplicações Autorizadas do módulo Administração.
Involved (opcional): pessoas ou grupos envolvidos no evento criado. Formato válido: [{"Name" : "Nome da pessoa", "Type" : "Person"},{"Name" : "Nome do grupo", "Type" : "Group"},...].
FirstReviewer (opcional): primeiro revisor alocado para o evento criado. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
SecondReviewer (opcional): segundo revisor alocado para o evento criado. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
ThirdReviewer (opcional): terceiro revisor alocado para o evento criado. Formato válido: {"Name" : "Nome da pessoa", "Type" : "Person"} ou {"Name" : "Nome do grupo", "Type" : "Group"}.
Data (opcional): arquivo que será anexado ao evento. O tamanho máximo do arquivo é de 10 MB. Os bytes do arquivo devem ser convertidos para uma string de base64 antes do envio.
FileName (opcional; obrigatório caso o campo "Data" esteja preenchido): nome utilizado para anexar o arquivo ao evento. Esse nome pode ser utilizado posteriormente para recuperar o arquivo.
Comment (opcional; obrigatório caso o campo "Progress" OU o campo "Data" estejam preenchidos): 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): tipo de evento. Se não for informado, será criado um evento do tipo especificado ao cadastrar o aplicativo na seção Aplicações Autorizadas do módulo Administração. Este campo suporta todos os tipos de eventos, exceto os tipos Evento de Compliance e Evento de Risco.
Nota 1: o envio do valor "null" nos campos dos CustomAttributes significa que os valores inseridos serão apagados. Já nos outros campos, o envio do valor "null" 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.
EXEMPLO DO CONTEÚDO DO FORMULÁRIO
{
"Title" : "Evento 01",
"Description" : "Descrição do evento",
"Urgency" : 2,
"Relevance" : 4,
"Severity" : 3,
"Latitude" :
-23.5463,
"Longitude" : -42.5664,
"GeolocationDescription" : "Rio de
Janeiro."
"Progress" : 30,
"Comment" : "Evento criado com 30% já
completo."
"EventType" : "Generic Event"
"CustomAttributes": {
"custom_text":"conteúdo do atributo",
"custom_number":3.45,
"custom_singleselect":"opção 1",
"custom_multiselect":["a","c"],
"custom_datetime":"\/Date(1320334621000-0200)\/",
}
}
RESPOSTA DE SUCESSO
Código do novo evento gerado. Retorna uma string.