Este apêndice lista as informações sobre os atributos customizados criados para objetos próprios e customizados. Os atributos podem ser dos seguintes tipos:
string Link;
string E-mail;
string Text;
string Paragraph;
DateTime Date/Time;
double Number;
string Outline[];
IEnumerable<string> List of Options[];
object Attachment[];
object Image[]
object Relationship;
object Georeference;
object Formula;
Os atributos dos tipos Attachment (Anexo) e Image (Imagem) permitem que arquivos sejam anexados e possuem chamadas exclusivas para adicionar, listar e remover itens.
O atributo GeoReference (Georeferência) possui as informações de uma coordenada geográfica (Point) ou de uma rota (LineString). Esse atributo só está disponível para objetos customizados. O formato de preenchimento segue a ordem Longitude, Latitude. Valores válidos para Longitude: -180 a 180. Valores válidos para Latitude: -90 a 90.
O atributo do tipo Relationship (Relacionamento) relaciona uma entidade do sistema (pessoas, grupos de pessoas, ativos, perímetros, componentes de negócio e objetos customizados) a outra entidade do sistema. Para informações sobre o preenchimento desse atributo veja o tópico Apêndice 2: Formato de preenchimento dos atributos.
O atributo do tipo Formula (Fórmula) possui valores que representam sua situação atual. Esses valores são retornados pela API ao fazer uma chamada para um objeto que possua um atributo Formula publicado. Os valores possíveis são:
0 = OK
1 = Error
2 = NotEvaluated
3 = DivisionByZero
4 = InvalidFormula
5 = UndefinedValue
6 = AttributeNotFound
Na chamada de metadados dos atributos, eles podem possuir os seguintes campos:
Attributes[]
{
string Name;
string Description;
string TypeName;
string VariableName;
string Format;
string AllowedValues[];
int? DecimalPlaces;
string FieldMask;
string FileTypes;
int? MaxFileSize;
int? MaxFiles;
int? MaxLength;
int? MaxValue;
int? MinLength;
int? MinValue;
object RelatedObjectInfo;
string AssetTypes;
string BusinessComponentTypes;
string Types[];
string ReturnType;
}
Abaixo estão descritas as aplicações para cada um dos campos:
Name: nome do atributo.
Description: descrição do atributo.
TypeName: tipo do atributo. Valores válidos: Attachment, BulletList, Email, Formula, Georeference, Image, Link, MultipleRelationships, Number, NumberedList, Paragraph, Text, DateOnly, TimeOnly, DateTime, SingleSelect e MultiSelect.
VariableName: nome da variável do atributo.
Format: formato de dados suportado pelos atributos.
AllowedValues: valores permitidos para os atributos do tipo Lista de Opções.
DecimalPlaces: número de casas decimais para atributos do tipo Número.
MaxValue: valor máximo suportado pelos atributos do tipo Número.
MinValue: valor mínimo suportado pelos atributos do tipo Número.
FieldMask: máscara de expressão regular para o atributo. Este campo é aplicável apenas ao tipo Texto.
MaxLength: número máximo de caracteres suportado pelos atributos do tipo Texto.
MinLength: número mínimo de caracteres suportado pelos atributos do tipo Texto.
FileTypes: tipos de arquivo suportados pelos atributos do tipo Anexo.
MaxFileSize: tamanho máximo de arquivo suportado pelos atributos do tipo Anexo.
MaxFiles: número máximo de arquivos suportado pelos atributos do tipo Anexo.
RelatedObjectInfo: informa o tipo do objeto que está relacionado.
AssetTypes: lista de tipos de ativo para os quais o atributo é aplicável. Presente somente na lista de atributos de ativos.
BusinessComponentTypes: lista de tipos de componente de negócio para os quais o atributo é aplicável. Presente somente na lista de atributos de componentes de negócio.
Types: lista de tipos de objeto para os quais o atributo é aplicável. Disponível somente para objetos customizados, riscos corporativos e controles corporativos.
ReturnType: informa a saída da fórmula, ou seja, o formato do valor a ser calculado. Valores possíveis: "Text", "Number" ou "DateTime".