Retorna uma lista paginada dos componentes de negócio cadastrados no módulo Organização.
URL
{RMUrl}/api/Organization/businesscomponents[?[[&]$filter=<filtro>][[&]page=<Página>][[&]page_size=<Tamanhodapágina>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]
MÉTODO DE SOLICITAÇÃO
GET
PARÂMETROS DA URL
page: número de páginas a serem exibidas. Valores válidos: de 1 ao número máximo de páginas. Se omitido, o valor 1 é utilizado. Se o valor for maior que o número máximo de páginas, uma lista em branco será retornada.
page_size: número de itens exibidos por página. Valores válidos: de 1 a 1.000. Se omitido, o valor padrão de 10 itens por página é utilizado.
filter: consulta baseada na sintaxe do protocolo OData para configurar filtros. Os campos permitidos estão listados abaixo. Siga os exemplos para identificar as operações permitidas.
orderby: ordena os componentes de negócio listados na página por campo. Para ordenar por mais de um campo, utilize a vírgula entre os campos. Para utilizar a ordem decrescente, digite a palavra chave "desc" para cada campo desejado. Os campos permitidos estão listados abaixo.
CAMPOS SUPORTADOS PELO FILTRO
Guid Id;
string Name;
string Description;
string Level;
string Type;
double Criticality;
byte Relevance;
Guid ResponsibleId;
string ResponsibleName;
string ResponsiblePhone;
string ResponsibleEmail;
string AdditionalInformation;
boolean EnabledForContinuityModule;
Para informações detalhadas sobre os filtros, como os operadores suportados, quais filtros se aplicam a quais tipos de dados e mais exemplos, veja o Apêndice 3: Filtros.
EXEMPLOS DE SOLICITAÇÃO
Os 10 primeiros componentes de negócio (por padrão, 10 componentes são listados por vez):
{RMUrl}/api/Organization/businesscomponents
Os componentes de negócio de 11 a 20 (segunda página):
{RMUrl}/api/Organization/businesscomponents?page=2
Filtrar pelo campo "Relevance" com valor igual a 2:
{RMUrl}/api/Organization/businesscomponents?$filter=Relevance eq 2
Filtrar pelo campo "Level" igual a "Tactical":
{RMUrl}/api/Organization/businesscomponents?$filter=Level eq 'Tactical'
Filtrar por parte de uma string do campo "Name":
{RMUrl}/api/Organization/businesscomponents?$filter=substringof('Departamento', Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os componentes de negócio de acordo com os filtros e o tamanho da página especificados.
OrganizationBusinessComponent[].
O objeto OrganizationBusinessComponent está no seguinte formato:
OrganizationBusinessComponents
{
Guid Id;
string Name;
string Description;
string Level;
string Type;
double Criticality;
byte Relevance;
object Responsible;
string AdditionalInformation;
object CustomAttributes[];
boolean EnabledForContinuityModule;
}
Para mais informações sobre os atributos customizados, veja o tópico Apêndice 1: Tipos de atributo.
EXEMPLOS DE RESPOSTAS DE SUCESSO
[
{
"Id":"78395d3d-d7e6-4938-9682-b5bd3c5be422",
"Level":"Tático",
"Type":"Sistema Organizacional",
"Name":"Departamento de Marketing",
"Description":"Descrição",
"EnabledForContinuityModule":false,
"Responsible":{"Email":"marketing@exemplo.com.br",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Administrator",
"Phone":"+55 (21) 2235-0000"
},
"Relevance":"5",
"Criticality":"30",
"AdditionalInformation":"Informação Adicional",
},
{
"Id":"78395d3d-d7e6-4938-9682-b5bd3c5be422",
"Level":"Strategic",
"Type":"Macroprocesso",
"Name":"Sistema de Produção",
"Description":"Descrição",
"EnabledForContinuityModule":true,
"Responsible":{"Email":"producao@exemplo.com.br",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Administrator",
"Phone":"+55 (21) 2000-0000"
},
"CustomAttributes":{"link":"https:\/\/empresa.com.br",
"text":"Texto",
"email":"exemplo@abc.com.br",
"outline":["opção 1","opção 2","opção 3"],
"paragraph":"Parágrafo",
"time:null,
"attachment":[{"Description":"Planilha de orçamento",
"FileName":"Planilha.txt",
"Id":"9C1D80BA-9358-4A93-922F-3935897FAD2E"}],
"number":3.25,
"listofoptions":"1 - opcao1",
"atributo_relacionamentosimples_ativo":{
"Id":"90a849c8-eb27-46e7-9b23-13c6ac26a694",
"Caption":"perimetro do marketing > sala da diretoria"},
"atributo_relacionamentomultiplo_grupo":[{"Id":"ec3db67d-f2e1-11e1-a23f-001ec91f4b0a","Caption":"Diretoria"},{"Id":"f53181c7-f2e1-11e1-a23f-001ec91f4b0a","Caption":"Informatica"},{"Id":"05475a88-f5fc-11e1-bf14-001ec91f4b0a","Caption":"Financeiro"},{"Id":"05475a8b-f5fc-11e1-bf14-001ec91f4b0a","Caption":"Recursos Humanos"}]
}
"Relevance":"5",
"Criticality":"30",
"AdditionalInformation":"Informação Adicional",
}
]