Lista de informaciones del proyecto.
Para hacer una lista informaciones del proyecto, como nombre, cantidad de usuarios, etc.
Método de Requisición: GET
Camino: /api/projects/accountextract?appKey="Token de la cuenta (mostrado abajo)"
Camino: /api/projects/accountextract?appKey="Token de la cuenta (mostrado abajo)"
Lista de los campos de la estructura
Para los campos existentes en la estructura.
Método de Requisición: GET
Camino: /api/query/execute/
Respuesta: Código 200 y lista las informaciones
Camino: /api/query/execute/
Respuesta: Código 200 y lista las informaciones
Parámetros:
|
Nombre
|
Descripción
|
|---|---|
|
projectName OR projectId
|
Escoja el nombre "real" del proyecto o el id de él
|
|
dataSource
|
Nombre "real" de la estructura del proyecto
|
|
query
|
Coloque la consulta del MDX para traer las informaciones, usted puede pegar en la paleta de los componentes del Dashboard en "Inline El"
|
*Ejemplo:
{
"result": {
"context": {
"filter": {
"tuples": [
{
"elements": [
{
"id": "[Usuario].[1]",
"caption": "1"
}
]
}
]
}
},
"data": {
"columns": {
"tuples": [
{
"elements": [
{
"id": "[Measures].[Cantidad]",
"caption": "Cantidad"
}
]
},
{
"elements": [
{
"id": "[Usuario].[Todos Usuarios]",
"caption": "Todos Usuarios"
}
]
}
]
},
"rows": {
"tuples": []
},
"cells": [
{
"ordinal": 1,
"value": 5456.0,
"formattedValue": "5.456"
}
]
}
}
}
Lista de Proyectos vía Clave de Aplicación
Camino: /api/project/list
Método de Requisición: GET
Método de Requisición: GET
Parámetros:
|
Nombre
|
Descripción
|
Tipo
|
|---|---|---|
|
appkey
|
clave de la aplicación
|
string
|
Respuestas:
|
Código
|
Descripción
|
Tipo
|
|---|---|---|
|
200
|
Lista de Objetos
|
|
Para generar la lista de proyectos vía API haga las siguientes aplicaciones:
Paso 1 :
Utilizando el método de requisición GET haga la llamada REST para "url": http://app.bimachine.com.br/api/project/list?appKey={clave de aplicación}.
Ej: http://app.bimachine.com.br/api/projects/list?appKey=12345abcd
Clave de Aplicación: 12345abcd
Paso 2:
Resultados esperados al ejecutar la llamada:
Código 200: Retorno de un objeto de autenticación creado en BIMachine.
Contenido de Respuesta:
{
"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": "Estadistica2",
"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" } ]}