Starting from HOPEX V5 the method for authentication for API has evolved. With a Basic Auth.With an API Key (preferred choice) Former Bearer Token is not available in V5. Oauth2 Authentication is not supported for the moment for API calls. Depend...
The GraphQL REST API exposes in standard a subset of the full HOPEX Metamodel. This subset is organized into several endpoint represented by a schema (SDL). The split is mainly done by solution scope or technical grouping: ITPM, BPA, Audit… It is...
When building graphQL to query element, it is sometime interesting to filter the data by different criteria : filtering by name, by Id, by relationships... Filters represent a "where" condition in queries. Filtering can : filter by fields (MetaAtt...
With GraphQL you are able to make query or mutation on object of the repository. When syncing with an external tool you may want to use the identifier of the other tool to create or connect object. GraphQL provide 3 types of identifier : Absolute I...
HOPEX Platform come with REST API that can be used in a wide range of use cases. The documentation of the endpoints of the HOPEX REST API is available as catalog as well as classical textual documentation. Full Endpoint documentation Click here...
The REST API based on GraphQL allows to perform all actions of the CRUD : CreateReadUpdateDelete This mechanism allows to perform a various kind of action into the repository. Read action are performed with the keyword "query" in GraphQL whereas Read...
When calling HOPEX REST API you need to provided the absolute identifier of the environment and the repository. You will find below some explaination on how and where to find this information. In HOPEX V3 on the server side you can access the : Hex...
The REST API heavily leverage the GraphQL framework. The GraphQL framework enable to have only one endpoint for all REST API call. To ease navigation in the HOPEX platform repository we have created endpoint for each solution. The endpoint correspo...
When making query or mutation to GraphQL REST API all access rights are check based on the profile you are using. The access rights are defined, in this order, at several level : License levelOption levelProfile levelWorkflow levelData Reading or W...
query user { personSystem(filter:{name:"Thomas"}) { id name dataLanguage { ...on Language { language:languageCode languageId:id languageName:name } } } } In HOPEX the data can be inputt...
This post concern version V3 or V4. For V5 go to this link Basic Auth vs API Key (HOPEX V5 and forward) The HOPEX REST API based on GraphQL allows to be called in two way : With a Basic AuthWith Bearer Token Depending on the use case you want to us...
When querying elements through the REST API a lot of items can be returned. To limit the size of items returned it can be relevant to paginate the data. Pagination allows you to request a certain chunk of objects. You can seek forwards or backwards...
HOPEX contains diagrams that have been designed or generated. Within the web front end you can see and download the diagrams as images. The REST API also provide the ability to export the diagram as a file. 3 format of files are supported : PNG, JP...
In HOPEX, you can store attachments in the concept called Business Document. The files supported are numerous (DOCX, XLSX, JPEG, PNG, PDF,...) which can be uploaded/downloaded from the web interface. You may want to access this information by REST AP...
When building graphQL query it can be convenient to use auto-completion to navigate the available information in the schema. Thus, useful to write the graphQL to read/write in the REST API. For instance, for ITPM to know which MetaClass, MetaAttrib...
Calling the REST API can be done with a wide range of tools. In this post we explain how to leverage postman to make HTTP request to the API. The main steps to use postman with the HOPEX REST API are : Download postman Download postman collection t...
Each of the GraphQL endpoints, to query the repository, can return results in synchronous or asynchronous way. To avoid confusion, it is important to make the difference between : What does the endpoint return ? Synchronous/Asynchronous responseHow...
Before making any call to a REST API in HOPEX you need to get an authentication bearer token. This token will allow you to access the data based on your credentials. Prior to continue make sure you have at leat the there following information : the l...
