Retorna a lista paginada de perímetros cadastrados na estrutura organizacional.
URL
{RMUrl}/api/Organization/perimeters[?[[&]$filter=<filtro>][[&]page=<Página>][[&]page_size=<Tamanhodapágina>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]
{RMUrl}/api/Organization/perimeters/<CódigodoPerímetro>/children[?[[&]$filter=<filtro>][[&]page=<Página>][[&]page_size=<Tamanhodapágina>][[&]$orderby=<campo1[desc],campo2[desc]…campoN[desc]>]]
{RMUrl}/api/Organization/perimeters/root/children[?[[&]$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
PerimeterCode: esse parâmetro é fornecido na URL e não precisa ser enviado através do GET.
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 perímetros 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 POR FILTRO
Guid Id;
string Name;
string Path;
string Description;
double? Longitude;
double? Latitude;
string GeolocationDescription;
string AdditionalInformation;
Guid ResponsibleId;
string ResponsibleName;
string ResponsibleEmail;
string ResponsiblePhone;
Para informações detalhadas sobre os filtros, como os operadores suportados, quais filtros se aplicam a quais tipos de dados e mais exemplos, consulte o Apêndice 3: Filtros.
Atualmente, os filtros não são aplicáveis aos campos "CustomAttributes", "Managers" e "MappingCriteria".
EXEMPLOS DE SOLICITAÇÃO
Os 10 primeiros perímetros (por padrão, 10 perímetros são listados por vez):
{RMUrl}/api/Organization/perimeters
Os perímetros de 11 a 20 (segunda página):
{RMUrl}/api/Organization/perimeters?page=2
Filtrar pelas coordenadas de longitude e latitude:
{RMUrl}/api/Organization/perimeters?$filter=(Latitude eq -21.82219) and (Longitude eq -41.658223)
Filtrar pelo campo "ResponsibleName" igual a 'Alexandre Ferreira':
{RMUrl}/api/Organization/perimeters?$filter=ResponsibleName eq 'Alexandre Ferreira'
Filtrar por "Departamento de Marketing" no campo "Path", retornando toda a subárvore:
{RMUrl}/api/organization/ perimeters?$filter=startswith(Path,'Departamento de Marketing')
Listar os perímetros filho contidos no perímetro identificado que inicie por 'Departamento':
{RMUrl}/api/organization/perimeters/c7adb930-4215-4d94-a6ae-dd9642739d4e/children?$filter=startswith(Name,'Departamento')
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os perímetros de acordo com os filtros e o tamanho da página especificados.
Perimeter[].
O objeto OrganizationPerimeter está no seguinte formato:
Perimeter
{
Guid Id;
string Name;
string Path;
string Description;
double? Longitude;
double? Latitude;
string GeolocationDescription;
int ZoomLevel;
string AdditionalInformation;
object Responsible;
object[] Managers;
object[] MappingCriteria;
object CustomAttributes[];
object ParentPerimeter;
}
Para mais informações sobre os atributos customizados, veja o tópico Apêndice 1: Tipos de atributo.
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{"CustomAttributes":{"link":"http:\/\/empresa.com.br",
"text":"Site corporativo",
"email":"exemplo@abc.com.br",
"outline":["opção 1","opção 2","opção 3"],
"paragraph":"Parágrafo",
"time":"\/Date(-62135550000000-0200)\/",
"attachment":[{
"Description":null,
"FileName":"Planilha.txt",
"Id":"9C1D80BA-9358-4A93-922F-3935897FAD2E"
}],
"number":3.255,
"relationship":{"81899a03-1086-4409-a80c-2bca56199a4c"},
"listofoptions":"2 – opcao2",
"date":"\/Date(1323216000000-0200)\/",
"datetime":"\/Date(1323212826177-0200)\/",
"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"}]
},
"Id":"de3b9b70-136f-49f9-adf9-34ff8d9c0311",
"Latitude":-21.82219,
"GeolocationDescription":"",
"Longitude":-41.658223,
"ZoomLevel":8,
"Managers":[{"Id":"bf0461df-1f48-11e1-af79-0800270094a6",
"Name":"Pedro da Silva",
"Type":"Person"
},
{"Id":"16e72a05-2195-11e1-af79-0800270094a6",
"Name":"Renata Ferreira",
"Type":"Person"
}],
"MappingCriteria":{"DnsName":{"Type":"AssetName"
},
"IpAddress":{"AttributeVariableName":"Ameaça",
"Type":"Attribute"
},
"NetbiosName":{"Type":"Disabled"
}
},
"Name":"Propaganda",
"Path":"Departamento de Marketing > Propaganda ",
"Responsible":{"Email":"admin@email.com.br",
"Id":"ab1e812f-990a-11e0-a3df-001ec920c21f",
"Name":"Administrator",
"Phone":"5555-5555"
},
"CreatedBy":"administrator",
"CreatedOn":"\/Date(1328528989817-0200)\/",
"UpdatedBy":"administrator",
"UpdatedOn":"\/Date(1328529417543-0200)\/"
}
]