Qodex.ai

HOPEX REST API - V5

Number of APIs: 31

Getting Started

The HOPEX REST API catalog allow you to programmatically access many of the features and data available in the HOPEX Platform.

This catalog is composed of different end points that aims to :

  • Authentication : to get, refresh, revoke bearer token for authentication purpose
  • HOPEX Platform : to get the environment list and repositories
  • HOPEX Solutions : to execute GraphQL queries for read/write access to the repository
  • Attachments : to download/upload document in the repository

Key points for the API

  • The add-on about GraphQL must be installed on the server and the web.config must be configured to enable the access. Otherwise 403 response will occur.

  • Almost all exchange are performed in JSON format

  • Get the following information from your administrator :

    • An API KEY

Use cases

The API support a wide range of use cases :

  • data access
  • integration with third parties systems
  • mobile app access
  • external website
  • Reporting
  • ...

Documentation

You will find here the list of the end points, with for each of them :

  • headers and body parameters
  • sample of responses for 200, 206, 403 ... status code

Any information in {{parameter}} is a variable to remplace by your value.

Aditionnal videos and forums are available on the MEGA community

Try it out !

Download the Qodex collection catalog and try your requests (Qodex).

  1. Module REST API-GraphQL - DataAccess-Sync - Audit - GraphQL query (Synchronous) POST {{server_url}}/HOPEXGraphQL/api/audit

  2. Module REST API-GraphQL - DataAccess-Sync - BPA - GraphQL query (Synchronous) POST {{server_url}}/HOPEXGraphQL/api/BPA

  3. Module REST API-GraphQL - DataAccess-Sync - Data - GraphQL query (Synchronous) POST {{server_url}}/HOPEXGraphQL/api/Data

  4. Module REST API-GraphQL - DataAccess-Sync - DataPrivacy - GraphQL query (Synchronous) POST {{server_url}}/HOPEXGraphQL/api/DataPrivacy

  5. Module REST API-GraphQL - DataAccess-Async - ITPM - GraphQL query (Asynchronous) POST {{server_url}}/HOPEXGraphQL/api/async/ITPM

  6. Module REST API-GraphQL - DataAccess-Async - Audit - GraphQL query (Asynchronous) POST {{server_url}}/HOPEXGraphQL/api/async/Audit

  7. Module REST API-Dataset - Report - Export dataset (Asynchronous) GET {{server_url}}/HOPEXGraphQL/api/async/dataset/{{datasetId}}/content

  8. Module REST API-Diagrams - Diagrams - Download (Synchronous) GET {{server_url}}/HOPEXGraphQL/api/diagram/{{diagramId}}/image

  9. Module REST API-Diagrams - Diagrams - Download (Asynchronous) GET {{server_url}}/HOPEXGraphQL/api/async/diagram/{{diagramId}}/image

  10. Module REST API-Business Documents and Attachements - Attachment - Upload POST {{server_url}}/HOPEXGraphQL/api/attachment/{{documentId}}/file