Retorna uma lista paginada dos projetos de riscos cadastrados no sistema.
URL
{RMUrl}/api/risk/projects[?[[&]$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 da página a ser exibida. 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 projetos 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
string Code;
string Name;
string Description;
string AdditionalInformation;
int StatusCode;
datetime CreatedOn;
datetime UpdatedOn;
datetime ClosedOn;
datetime AnalysisStart;
datetime AnalysisEnd;
guid LeaderId;
string LeaderName;
string LeaderPhone;
string LeaderEmail;
string SubstituteLeaderId;
string SubstituteLeaderName;
string SubstituteLeaderEmail;
guid AuthorId;
string AuthorName;
string AuthorPhone;
string AuthorEmail;
datetime StartDate;
datetime EndDate;
datetime ExpectedStartDate;
datetime ExpectedEndDate;
O campo StatusCode exibe uma informação sobre o estado do projeto e pode conter um dos seguintes valores numéricos: 0 (Aberto), 1 (Fechado) ou 2 (Cancelado).
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 projetos de riscos (por padrão, somente 10 são listados por vez):
{RMUrl}/api/risk/projects
Os projetos de 11 a 20 (segunda página):
{RMUrl}/api/risk/projects?page=2
Filtrar por "Risco" no campo "Name":
{RMUrl}/api/risk/projects?$filter=substringof('risco',Name)
RESPOSTA DE SUCESSO
Lista de objetos com informações sobre os projetos de acordo com os filtros e o tamanho da página especificados.
RiskProject[].
O objeto RiskProject está no seguinte formato:
RiskProject
{
string Code;
string Name;
string Description;
string AdditionalInformation;
string Status;
int StatusCode;
datetime CreatedOn;
datetime UpdatedOn;
datetime ClosedOn;
datetime AnalysisStart;
datetime AnalysisEnd;
object Author;
object Leader;
object SubstituteLeader;
datetime StartDate;
datetime EndDate;
datetime ExpectedStartDate;
datetime ExpectedEndDate;
}
EXEMPLO DE RESPOSTAS DE SUCESSO
[{
"Name":"Riscos em ativos 2012",
"Leader":{
"Id":"212bbac0-08e3-11e2-bcfd-22ddd55f8100",
"Name":"Alexandre Ferreira",
"Phone":"+55 (21) 2000-0000",
"Email":"alexandre@exemplo.com"
},
"Author":{
"Id":"fe1f4bb6-1f90-11e1-a18c-001ec920c21f",
"Name":"Administrator",
"Phone":"+55 (21) 2000-1000",
"Email":"admin@exemplo.com.br"
},
"SubstituteLeader":{
"Id":"1841653f-08e3-11e2-bcfd-22ddd55f8100",
"Name":"Jose da Silva",
"Type":"Person"
},
"Description":"Este projeto foi criado para avaliar os riscos presentes nos ativos da organização no ano de 2012.",
"AdditionalInformation":"Projeto iniciado pelo gerente Carlos Romero.",
"ExpectedStartDate":"\/Date(1486346400000-0200)\/",
"ExpectedEndDate":"\/Date(1486432800000-0200)\/",
"StartDate":"\/Date(1486346400000-0200)\/",
"EndDate":"\/Date(1486432800000-0200)\/"},
"Status":"Aberto",
"StatusCode":0,
"Code":"PRJR12002",
"UpdatedOn":"\/Date(1348778430937-0300)\/",
"CreatedOn":"\/Date(1348778430917-0300)\/",
"AnalysisStart":"\/Date(-62135589600000-0200)\/",
"AnalysisEnd":"\/Date(-62135589600000-0200)\/"
},
{
"Name":"Riscos em ativos 2011",
"Leader":{
"Id":"fe1f4bb6-1f90-11e1-a18c-001ec920c21f",
"Name":"Administrator",
"Phone":"+55 (21) 2100-0000",
"Email":"admin@exemplo.com.br"
},
"Author":{
"Id":"fe1f4bb6-1f90-11e1-a18c-001ec920c21f",
"Name":"Administrator",
"Phone":"+55 (21) 2100-0000",
"Email":"admin@exemplo.com.br"
},
"Description":" Este projeto foi criado para avaliar os riscos presentes nos ativos da organização no ano de 2011.",
"AdditionalInformation":"Projeto cancelado pelo gerente Carlos Romero.",
"ExpectedStartDate":"\/Date(1486346400000-0200)\/",
"ExpectedEndDate":"\/Date(1486432800000-0200)\/",
"StartDate":"\/Date(1486346400000-0200)\/",
"EndDate":"\/Date(1486432800000-0200)\/"},
"Status":"Cancelado",
"StatusCode":2,
"Code":"PRJR12008",
"UpdatedOn":"\/Date(1349185548033-0300)\/",
"CreatedOn":"\/Date(1349185539577-0300)\/",
"ClosedOn":"\/Date(1349185548030-0300)\/",
"AnalysisStart":"\/Date(-62135589600000-0200)\/",
"AnalysisEnd":"\/Date(-62135589600000-0200)\/"
}
]