Retorna a lista de atributos de eventos.
URL
{WSUrl}/api/info/attributes
MÉTODO DE SOLICITAÇÃO
GET
PARÂMETROS DA URL
Essa funcionalidade não possui parâmetros.
EXEMPLO DE SOLICITAÇÃO
{WSUrl}/api/info/attributes
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os atributos de eventos nos seguintes formatos:
CustomAttributes
{
string EventTypeName;
string VariableName;
string Description;
string Name;
string TypeName;
int DecimalPlaces;
bool ApplyAlphabeticalOrder;
string ReturnType;
int? MinLength;
int? MaxLength;
string FieldMask;
int? MinValue;
int? MaxValue;
IEnumerable<string> AllowedValues;
Dictionary<string,guid> AllowedItems;
bool Required;
}
Abaixo podem ser vistos detalhes sobre cada um dos campos da lista "CustomAttributes":
EventTypeName: tipo de evento em que o atributo pode ser aplicado. Valores válidos: Evento de Compliance, Evento de Riscos, Evento Padrão e null. O valor null indica que o atributo é aplicável a todos os tipos de evento. Caso o Módulo Risk Manager tenha outros tipos de evento cadastrados, eles também serão considerados valores válidos.
VariableName: nome da variável.
Description: descrição do atributo.
Name: nome do atributo.
TypeName: tipo do atributo. Valores válidos: Formula, Email, Link, Paragraph, Text, DateOnly, TimeOnly, DateTime, Number, SingleSelect e MultiSelect.
DecimalPlaces: número de casas decimais para o atributo. Este campo é aplicável apenas ao tipo Number.
ApplyAlphabeticalOrder: aplicar ordem alfabética na lista de valores permitidos.
ReturnType: informa a saída da fórmula, ou seja, o formato do valor a ser calculado. Este campo é aplicável apenas ao tipo Formula. Valores possíveis: "Text", "Number" ou "DateTime".
MinLength: número mínimo de caracteres para o atributo. Este campo é aplicável apenas ao tipo Text.
MaxLength: número máximo de caracteres para o atributo. Este campo é aplicável apenas ao tipo Text.
FieldMask: máscara de expressão regular para o atributo. Este campo é aplicável apenas ao tipo Text.
MinValue: valor mínimo para o atributo. Este campo é aplicável apenas ao tipo Number.
MaxValue: valor máximo para o atributo. Este campo é aplicável apenas ao tipo Number.
AllowedValues: lista de valores permitidos para o atributo. Este campo é aplicável aos tipos SingleSelect e MultiSelect.
AllowedItems: lista de valores permitidos para o atributo e os respectivos IDs de cada opção. Este campo é aplicável aos tipos SingleSelect e MultiSelect.
Required: informa se o atributo é de preenchimento obrigatório.
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"EventTypeName": "Atendimento ao Cliente",
"VariableName": "areas_envolvidas_no_atendime",
"Description": "Este campo lista as áreas que precisam ser envolvidas no atendimento ao cliente.",
"Name": "Áreas Envolvidas no Atendimento",
"TypeName": "MultiSelect",
"DecimalPlaces": 0,
"ApplyAlphabeticalOrder": false,
"AllowedValues": [
"Distribuição",
"Financeiro",
"RH",
"Marketing",
"Suporte",
"Fornecedores",
"Suporte Interno"
],
"AllowedItems": [
{
"Caption": "Distribuição",
"Value": "0b491186-52da-4acc-b2a0-1d1e5ab4fca5"
},
{
"Caption": "Financeiro",
"Value": "799b31e0-6fc1-44aa-82a7-20ddbc5f2cdd"
},
{
"Caption": "RH",
"Value": "edc6a5df-e9a2-4a0e-9cca-2de3480d234b"
},
{
"Caption": "Marketing",
"Value": "47eb63c4-9cc1-49b4-985a-80d842822042"
},
{
"Caption": "Suporte",
"Value": "078cc4d8-7280-4738-ac37-afeba0917398"
},
{
"Caption": "Fornecedores",
"Value": "553afcf0-315b-43b1-a90e-c044c1c11ec6"
},
{
"Caption": "Suporte Interno",
"Value": "9b6e693b-bc71-4a9c-8e7b-cdb608fe9008"
}
],
"Required": false,
"IsEditable": true,
"IsDeletable": true
},
{
"EventTypeName": "Atendimento ao Cliente;Auditoria;E-learning",
"VariableName": "data_esperada_de_entrega",
"Description": "Campo que lista a data estimada de entrega ao cliente no momento da compra.",
"Name": "Data Esperada de Entrega",
"TypeName": "DateOnly",
"DecimalPlaces": 0,
"ApplyAlphabeticalOrder": false,
"AllowedValues": [],
"AllowedItems": [],
"Required": false,
"IsEditable": true,
"IsDeletable": true
},
{
"EventTypeName": "Contratos;Atendimento ao Cliente",
"VariableName": "nome_do_cliente",
"Description": "Nome do cliente conforme exibido no contrato.",
"Name": "Nome do Cliente",
"TypeName": "Text",
"FieldMask": "",
"DecimalPlaces": 0,
"ApplyAlphabeticalOrder": false,
"AllowedValues": [],
"AllowedItems": [],
"Required": false,
"IsEditable": true,
"IsDeletable": true
},
]