LUCA-BDS API REST (1.1.0)

Download OpenAPI specification:Download

Official documentation of Luca-BDS API

Authentication

OAuth 2.0 with 'password' flow is used to secure the API REST.

oAuthSample

This API uses OAuth 2.0 with the password flow

Security scheme type: OAuth2
password OAuth Flow
Token URL: http://luca-bds.com/luca-web/oauth/token
Scopes:

    Applications

    Return the info about your LUCA Applications

    Find user applications

    Authorizations:

    Responses

    200

    Successful response

    401

    Unauthorized

    get /applications
    Default server
    https://luca-bds.com/luca-web/api/applications

    Response samples

    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    Find application menus

    Authorizations:
    path Parameters
    applicationId
    required
    integer <int64>

    ID of the application

    Responses

    200

    Successful response

    401

    Unauthorized

    get /menus/{applicationId}
    Default server
    https://luca-bds.com/luca-web/api/menus/{applicationId}

    Response samples

    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    CustomQueries

    Run your queries from API REST

    Find user queries

    Authorizations:
    query Parameters
    groupId
    integer

    Group id to filter

    interactionSystemId
    integer

    Interaction system id to filter

    Responses

    200

    Successful response

    401

    Unauthorized

    get /customQueries
    Default server
    https://luca-bds.com/luca-web/api/customQueries

    Response samples

    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    Find custom query info

    Authorizations:
    path Parameters
    queryId
    required
    integer <int64>

    CustomQuery id

    Responses

    200

    Successful response

    401

    Unauthorized

    404

    Custom query not found

    get /customQueries/{queryId}/info
    Default server
    https://luca-bds.com/luca-web/api/customQueries/{queryId}/info

    Response samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "id": 0,
    • "name": "string",
    • "description": "string",
    • "modificationDate": "string",
    • "type": "normal",
    • "paginationType": "Paginated",
    • "creationUser":
      {
      },
    • "queryState":
      {
      },
    • "interactionSystem":
      {
      },
    • "group":
      {
      },
    • "environments":
      [
      ],
    • "inputVariables":
      [
      ]
    }

    Execute custom query

    Authorizations:
    path Parameters
    queryId
    required
    integer

    CustomQuery id

    Request Body schema: application/json
    pageNumber
    integer
    pageSize
    integer
    environmentExecutionId
    integer
    inputVariables
    Array of object

    Responses

    200

    Successful response

    401

    Unauthorized

    404

    Custom query not found

    post /customQueries/{queryId}
    Default server
    https://luca-bds.com/luca-web/api/customQueries/{queryId}

    Request samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "pageNumber": 0,
    • "pageSize": 0,
    • "environmentExecutionId": 0,
    • "inputVariables":
      [
      ]
    }

    Response samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "headers":
      [
      ],
    • "rows":
      [
      ],
    • "_embedded":
      {
      },
    • "pagination":
      {
      }
    }

    Favorites

    Execute your favorite queries

    Favorite query execution

    Authorizations:
    path Parameters
    favoriteId
    required
    integer

    Favorite id

    query Parameters
    pageNumber
    integer
    pageSize
    integer

    Responses

    200

    Successful response

    401

    Unauthorized

    404

    Favorite query not found

    get /favorites/{favoriteId}
    Default server
    https://luca-bds.com/luca-web/api/favorites/{favoriteId}

    Response samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "headers":
      [
      ],
    • "rows":
      [
      ],
    • "_embedded":
      {
      },
    • "pagination":
      {
      }
    }

    Charts

    Execute your LUCA Charts

    Find user charts

    Authorizations:
    query Parameters
    groupId
    integer

    Group id for filter

    interactionSystemId
    integer

    InteractionSytem id for filter

    Responses

    200

    Successful responses

    401

    Unauthorized

    get /charts
    Default server
    https://luca-bds.com/luca-web/api/charts

    Response samples

    application/json
    Copy
    Expand all Collapse all
    [
    • {
      }
    ]

    Find chart detail

    Authorizations:
    path Parameters
    chartId
    required
    integer

    Chart id

    Responses

    200

    Successful responses

    401

    Unauthorized

    404

    Chart not found

    get /charts/{chartId}/info
    Default server
    https://luca-bds.com/luca-web/api/charts/{chartId}/info

    Response samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "id": 0,
    • "name": "string",
    • "description": "string",
    • "modificationDate": "string",
    • "creationUser":
      {
      },
    • "interactionSystem":
      {
      },
    • "group":
      {
      },
    • "chartType": "column",
    • "doubleAxisY": true,
    • "stacked": true,
    • "drilldown": true,
    • "chartVariablesX":
      [
      ],
    • "chartVariablesY":
      [
      ],
    • "chartVariablesZ":
      [
      ],
    • "chartFilters":
      [
      ]
    }

    Execute chart with a filter

    Authorizations:
    path Parameters
    chartId
    required
    integer

    Chart id to execute

    filterId
    required
    integer

    Filter id to execute

    Responses

    200

    Successful responses

    401

    Unauthorized

    404

    Chart not found

    get /charts/{chartId}/filter/{filterId}
    Default server
    https://luca-bds.com/luca-web/api/charts/{chartId}/filter/{filterId}

    Response samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "chart":
      {
      },
    • "filter":
      {
      },
    • "result": { }
    }

    Execute chart with a list of input variables

    Authorizations:
    path Parameters
    chartId
    required
    integer

    Chart id to execute

    Responses

    200

    Successful responses

    401

    Unauthorized

    404

    Chart not found

    post /charts/{chartId}
    Default server
    https://luca-bds.com/luca-web/api/charts/{chartId}

    Response samples

    application/json
    Copy
    Expand all Collapse all
    {
    • "chart":
      {
      },
    • "filter":
      {
      },
    • "result": { }
    }