Retorna uma lista paginada dos ativos cadastrados no módulo Organização.
URL
{RMUrl}/api/Organization/assets[?[[&]$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 ativos 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 Description;
string AssetType;
byte AnalysisFrequency;
double Criticality;
byte Relevance;
DateTime? CreatedOn;
DateTime? UpdatedOn;
double? Latitude;
double? Longitude;
string GeolocationDescription;
int ZoomLevel;
string CreatedBy;
string UpdatedBy;
Guid ResponsibleId;
string ResponsibleName;
string ResponsiblePhone;
string ResponsibleEmail;
string Path;
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.
ATRIBUTOS CUSTOMIZADOS SUPORTADOS PELO FILTRO
Ativos podem ser filtrados por seus atributos customizados.
Nota: 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 ativos (por padrão, 10 ativos são listados por vez):
{RMUrl}/api/Organization/assets
Os ativos de 11 a 20 (segunda página):
{RMUrl}/api/Organization/assets?page=2
Filtrar pelo campo "Relevance" com valor igual a 2:
{RMUrl}/api/Organization/assets?$filter=Relevance eq 2
Filtrar pelo campo "AssetType" igual a 'Pessoa':
{RMUrl}/api/Organization/assets?$filter=AssetType eq 'Pessoa'
Filtrar por parte de uma string do campo "Name":
{RMUrl}/api/Organization/assets?$filter=substringof('Departamento Financeiro', Name)
Filtrar pelo campo "ResponsibleName" igual a 'Alexandre Ferreira':
{RMUrl}/api/Organization/assets?$filter=ResponsibleName eq 'Alexandre Ferreira'
Filtrar por "Departamento de Marketing" no campo "Path":
{RMUrl}/api/organization/assets?$filter=startswith(Path,'Departamento de Marketing')
Filtrar por um atributo customizado do tipo Texto:
{RMUrl}/api/organization/assets/?$filter={nomeatributotexto} eq '{atributotexto}'
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os ativos de acordo com os filtros e o tamanho da página especificados.
OrganizationAsset[].
O objeto OrganizationAsset está no seguinte formato:
OrganizationAsset
{
Guid Id;
string Name;
string Description;
string AssetType;
byte AnalysisFrequency;
double Criticality;
byte Relevance;
object BusinessComponents;
DateTime? CreatedOn;
DateTime? UpdatedOn;
double? Latitude;
double? Longitude;
string GeolocationDescription;
int ZoomLevel;
string CreatedBy;
string UpdatedBy;
object Responsible;
string Path;
object Components[];
object CustomAttributes[];
object CollectionParameters;
object MappingCriteria;
object ParentPerimeter;
}
O CollectionParameters tem o seguinte formato:
HostAddress (opcional): endereço do ativo que será coletado.
Credentials (opcional): credenciais utilizadas para acessar a máquina alvo.
CollectorServer (opcional): servidor de coleta utilizado para gerenciar a coleta.
Para obter mais informações sobre os atributos customizados, veja o tópico Apêndice 1: Tipos de atributo.
EXEMPLO DE RESPOSTAS DE SUCESSO
[
{
"AnalysisFrequency":60,
"AssetType":"Processo",
"BusinessComponents":["Tático > Sistema Organizacional > Marketing","Tático > Sistema Organizacional > Finanças"], "CreatedBy":"aferreira",
"CreatedOn":"\/Date(1320683702593-0200)\/",
"Criticality":2,
"Description":"Processo COBIT do departamento financeiro",
"GeolocationDescription":"Rio de Janeiro",
"ZoomLevel":0,
"Id":"c09faa67-1b21-4ed9-9cc2-f4a3487965d1",
"Latitude":40.712062,
"Longitude":-74.013174,
"Name":"Processo COBIT",
"Relevance":4,
"Responsible":{"Id":"cc45b704-b3d5-11e0-8b69-001ec91f4b0a","Name":"Alexandre Ferreira","Email": "aferreira@abc.com.br","Phone":null},
"UpdatedBy":"aferreira",
"UpdatedOn":"\/Date(1321621109510-0200)\/",
"Path":"Auditoria > Processos Internos > Processos COBIT",
"Components":[
{"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6","Name":"Notebook do Diretor - MS Office 2007 POR","Description":"descricao 1"},
{"Id":"cb2dd770-1cdc-11e1-af79-0800270094a6","Name":"Notebook do Diretor - Skype ","Description":"descricao 2"},
{"Id":"005cd280-1cde-11e1-af79-0800270094b9","Name":"Notebook do Diretor - MS Windows 7 Ultimate","Description":"descricao 3"}
],
"CustomAttributes":{"link":"https:\/\/empresa.com.br",
"text":"Texto",
"email":"exemplo@email.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_ameaca":{
"Id":"ddf5c6ec-9f93-11e1-ba75-001ec91f4b0a",
"Caption":"Ação de código malicioso"},
"atributo_relacionamentosimples_ativo":{
"Id":"90a849c8-eb27-46e7-9b23-13c6ac26a694",
"Caption":"perimetro do marketing > sala da diretoria"},
"atributo_relacionamentosimples_compativo":{
"Id":"fe7b94f3-a054-11e1-ba75-001ec91f4b0a",
"Caption":"Ambiente de Processamento - Data Center"},
"atributo_relacionamentosimples_vulnerabilidade":{
"Id":"19b1a37e-82ef-4895-922f-eaa2130b7277",
"Caption":"Time of Last System Startup"},
"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"}]
},
{
"AnalysisFrequency":0,
"AssetType":"Tecnologia",
"CreatedOn":"\/Date(1314713444800-0300)\/",
"Criticality":0,
"ZoomLevel":10,
"Id":"24819ff8-eebb-4ffa-9977-04aba8a496f5",
"Name":"Servidor Windows",
"Relevance":3,
"Responsible":{"Id":"29432a40-a295-11e0-8796-001ec91f4b0a",
"Name":"Alexandre Ferreira","Email":"exemplo@email.com.br","Phone":"+55 (21) 5555-1234"},
"UpdatedBy":"aferreira",
"UpdatedOn":"\/Date(1321543661253-0200)\/",
"Path":"Departamento de Marketing > Servidor Windows",
"Components":[
{"Id":"55d6dccf-1a9c-11e1-b470-0800270094a6","Name":"Servidor Windows - MS IIS7","Description":"descricao de exemplo"},
{"Id":"ee5cd280-1cde-11e1-af79-0800270094b9","Name":"Servidor Windows - MS Windows 2008 Server","Description":"descricao de exemplo"}
],
"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,
"listofoptions":"2 – opcao2",
"date":"\/Date(1323216000000-0200)\/",
"datetime":"\/Date(1323212826177-0200)\/"
},
"MappingCriteria":{
"DnsName":{"Type":"AssetName"},
"IpAddress":{"Type":"HostAddress"},
"NetbiosName":{"Type":"Inherited"}
},
"CollectAddress":"10.1.0.1",
"CollectCredential":"Credenciais de acesso",
"CollectServer":"Nome do servidor de coleta"
}
]