Listando informações do projeto.
Para listar informações do projeto, como nome, quantidades de usuários, etc….
Método de Requisição: GET
Caminho: /api/projects/accountextract?appKey="Token da conta (mostrado abaixo)"
Caminho: /api/projects/accountextract?appKey="Token da conta (mostrado abaixo)"
Listando os campos da estrutura
Para os campos existentes na estrutura.
Método de Requisição: GET
Caminho: /api/query/execute/
Resposta: Código 200 e lista as informações
Caminho: /api/query/execute/
Resposta: Código 200 e lista as informações
Parâmetros:
| Nome | Descrição |
|---|---|
| projectName OR projectId | Escolha o nome "real" do projeto ou o id dele |
| dataSource | Nome "real" da estrutura do projeto |
| query | Coloque a consulta do MDX para trazer as informações, você pode pegar na paleta de componentes do Dashboard no "Inline El" |
*Exemplo:
{
"result": {
"context": {
"filter": {
"tuples": [
{
"elements": [
{
"id": "[Usuario].[1]",
"caption": "1"
}
]
}
]
}
},
"data": {
"columns": {
"tuples": [
{
"elements": [
{
"id": "[Measures].[Quantidade]",
"caption": "Quantidade"
}
]
},
{
"elements": [
{
"id": "[Usuario].[Todos Usuarios]",
"caption": "Todos Usuarios"
}
]
}
]
},
"rows": {
"tuples": []
},
"cells": [
{
"ordinal": 1,
"value": 5456.0,
"formattedValue": "5.456"
}
]
}
}
}
Listagem de Projetos via Chave de Aplicação
Caminho: /api/project/list
Método de Requisição: GET
Método de Requisição: GET
Parâmetros:
| Nome | Descrição | Tipo |
|---|---|---|
| appkey | chave da aplicação | string |
Respostas:
| Código | Descrição | Tipo |
|---|---|---|
| 200 | Lista de Objetos |
Para gerar a lista de projetos via API faça as seguintes aplicações:
Passo 1 :
Utilizando o método de requisição GET faça a chamada REST para "url": https://support.bimachine.com/evolucao-historica/api/project/list?appKey={chave de aplicação}.
Ex: https://support.bimachine.com/evolucao-historica/api/projects/list?appKey=12345abcd
Chave de Aplicação: 12345abcd
Passo 2:
Resultados esperados ao executar a chamada:
Código 200: Retorno de um objeto de autenticação criado no BIMachine.
Conteúdo de Resposta:
{
"projects": [
{
"displayName": "fgiordani",
"availableOnMobile": false,
"projectIcon": "/projects/fgiordani/images/logo.png",
"name": "fgiordani",
"lastActivity": 1444228978986,
"id": 87,
"userRole": {
"id": 1,
"name": "Administrator",
"icon": "icon-key",
"administrator": true,
"viewer": false
}
},
{
"displayName": "Estatistica2",
"availableOnMobile": true,
"projectIcon": "/projects/estatistica/images/content-5356689293779017573.jpg",
"name": "estatistica",
"lastActivity": null,
"id": 99,
"userRole": {
"id": 1,
"name": "Administrator",
"icon": "icon-key",
"administrator": true,
"viewer": false
}
} ], "links": [ { "type": "user.profile", "rel": "User profile", "href": "/api/users/85" } ]}