Retorna informações sobre as abas do layout de evento para um tipo de evento.
URL
{RMUrl}/api/administration/eventlayouts/<IDdoTipodeEvento>
MÉTODO DE SOLICITAÇÃO
GET
PARÂMETRO DA URL
EventLayoutId: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.
EXEMPLO DE SOLICITAÇÃO
{RMUrl}/api/admininistration/eventlayouts/8ec7c744-e843-40a6-a2fb-0a9231aec293
RESPOSTA DE SUCESSO
Retorna um objeto EventLayout com informações sobre o layout do tipo de evento especificado, o que inclui informações sobre cada uma de suas abas. O objeto está no seguinte formato:
EventLayout
{
Guid EventTypeId;
string EventTypeName;
string CreatedBy;
string UpdatedBy;
datetime CreatedOn;
datetime UpdatedOn;
datetime? PublishedOn;
object[] Tabs[];
}
O campo "Tabs" é um array com a seguinte estrutura:
{
Guid Id;
string Name;
string PageHelp;
bool IsDefault;
int VisibleIndex;
int RenderMode;
string Url;
bool CanCreateEvent;
object[ ] Fields[];
}
O campo "Fields" é um array com a seguinte estrutura:
{
int Row;
int Column;
int FieldType;
string FieldName;
string ToolTip;
}
Instruções dos campos do objeto Tabs
O campo "IsDefault" indica se é uma aba que vem por padrão no evento, como por exemplo a aba Progresso e aba Propriedades. Este campo aceita os seguintes valores: "true" e "false".
O campo "VisibleIndex" exibe a ordem de apresentação das abas, da esquerda para a direita dentro do layout.
O campo "RenderMode" indica a forma em que a aba é exibida e pode assumir os seguintes valores:
•ExternalPage = 0;
•OneColumn = 1;
•TwoEqualSizeColumns = 2;
•ThreeEqualSizeColumns = 3.
O campo "Url" só será preenchido quando o campo "RenderMode" tiver o valor "0".
O campo "CanCreateEvent" indica se o usuário pode criar eventos dentro de uma aba e retorna os seguintes valores: "true" e "false".
Instruções dos campos do objeto Fields
O campo "FieldType" indica se o campo é uma propriedade padrão ou se é um atributo customizado criado no módulo Administração. Este campo aceita os seguintes valores:
•Property = 0;
•Attribute = 1.
O campo "ToolTip" representa o help de campo.
EXEMPLO DE RESPOSTA DE SUCESSO
{
"EventTypeId":"27fe8c57-edb3-46ed-b6ec-9be356ce5b87",
"EventTypeName":"7.5 Gestão de Transferências Internacionais",
"CreatedBy":"fdoe@exemplo.com",
"UpdatedBy":"rodrigo.doe@exemplo.com",
"CreatedOn":"\/Date(1599669374133-0300)\/",
"UpdatedOn":"\/Date(1619643873530-0300)\/",
"PublishedOn":"\/Date(1619643873530-0300)\/",
"Tabs":[
{
"Id":"52b115cc-5e7e-415d-8d80-e8bc4a746e25",
"Name":"Controlador / Ãrea",
"IsDefault":false,
"VisibleIndex":0,
"RenderMode":"ThreeEqualSizeColumns",
"CanCreateEvent":false,
"Fields":[
{
"Row":0,
"Column":1,
"FieldType":"Property",
"FieldName":"CoordinatorId"
},
{
"Row":0,
"Column":2,
"FieldType":"Attribute",
"FieldName":"nome_controlador"
},
{
"Row":0,
"Column":3,
"FieldType":"Attribute",
"FieldName":"nome_do_dpo"
},
{
"Row":1,
"Column":1,
"FieldType":"Property",
"FieldName":"ResponsibleId"
},
{
"Row":1,
"Column":2,
"FieldType":"Attribute",
"FieldName":"controlador_telefone"
},
{
"Row":1,
"Column":3,
"FieldType":"Attribute",
"FieldName":"contato_do_dpo"
},
{
"Row":2,
"Column":1,
"FieldType":"Attribute",
"FieldName":"documentacao_anexo"
},
{
"Row":2,
"Column":2,
"FieldType":"Attribute",
"FieldName":"controlador_email"
},
{
"Row":2,
"Column":3,
"FieldType":"Attribute",
"FieldName":"pr04art41_email_do_dpo"
},
{
"Row":3,
"Column":1,
"FieldType":"Property",
"FieldName":"Created"
},
{
"Row":3,
"Column":2,
"FieldType":"Attribute",
"FieldName":"area_responsavel"
},
{
"Row":4,
"Column":1,
"FieldType":"Property",
"FieldName":"AuthorUserName"
},
{
"Row":4,
"Column":2,
"FieldType":"Attribute",
"FieldName":"area_responsavel_tel"
},
{
"Row":5,
"Column":2,
"FieldType":"Attribute",
"FieldName":"area_responsavel_email"
}
]
},
{
"Id":"e7538bf9-c05c-4f87-b4f7-8d8d05f94b14",
"Name":"Operador",
"IsDefault":false,
"VisibleIndex":1,
"RenderMode":"OneColumn",
"CanCreateEvent":false,
"Fields":[
{
"Row":0,
"Column":1,
"FieldType":"Attribute",
"FieldName":"nome_operador"
},
{
"Row":1,
"Column":1,
"FieldType":"Attribute",
"FieldName":"operador_telefone"
},
{
"Row":2,
"Column":1,
"FieldType":"Attribute",
"FieldName":"operador_email"
}
]
},
{
"Id":"fcbee60d-c0f0-4dea-b48d-00e3ee1bd3dc",
"Name":"Identific/Finalidade",
"IsDefault":false,
"VisibleIndex":2,
"RenderMode":"OneColumn",
"CanCreateEvent":false,
"Fields":[
{
"Row":0,
"Column":1,
"FieldType":"Attribute",
"FieldName":"identificacao_dp_e_dps"
},
{
"Row":1,
"Column":1,
"FieldType":"Attribute",
"FieldName":"qualis_as_finalidades_do_tra"
},
{
"Row":2,
"Column":1,
"FieldType":"Attribute",
"FieldName":"outras_informacoes"
},
{
"Row":3,
"Column":1,
"FieldType":"Property",
"FieldName":"Severity"
}
]
},
{
"Id":"2cc1d606-e280-4077-ad1b-0d4d6d84012b",
"Name":"Base Legal",
"IsDefault":false,
"VisibleIndex":3,
"RenderMode":"OneColumn",
"CanCreateEvent":false,
"Fields":[
{
"Row":0,
"Column":1,
"FieldType":"Attribute",
"FieldName":"base_legal_art_7ip"
}
]
},
{
"Id":"d0872443-f474-4045-9bbe-35fd0d3b94d7",
"Name":"ADM",
"IsDefault":false,
"VisibleIndex":10,
"RenderMode":"ThreeEqualSizeColumns",
"CanCreateEvent":false,
"Fields":[
{
"Row":0,
"Column":1,
"FieldType":"Attribute",
"FieldName":"instancia"
}
]
}
]
}