Importing a Module into Hopex
Module
Module description
Required dependent modules
Importing a Module into Hopex
Updating an environment manually
Authentication via an API key
Hopex MCP Server
Objective
Scope
Key Features
Functional Architecture
Interfaces
Security
Limitations
Use Cases
Analysis and Investigation
Reporting, Governance, and Risk
Transformation Support
Visual Insight
Broader Business Value
Developers
Strategists
Product Managers
Governance Teams
Application Owners
Transformation Leaders
Prerequisites
Administration, Installation, Configuration, and Deployment
Glossary
HOPEX diagrams in MS Teams
Teams Module Description
HOPEX in Microsoft Teams
Adding the App to your Teams (optional)
Adding a diagram tab in your Team
Viewing a HOPEX diagram
Editing the HOPEX diagram
HOPEX Configuration
Installing Teams Module
Configuring Http Security
Setting SameSite cookie
Configuring the authentication
User accounts
API Key
Authorizing HOPEX connection from Teams
REST API and GraphQL
REST API Documentation
GraphQL endpoints
Synchronous versus Asynchronous
Version of the endpoint
GraphQL and Data Confidentiality (CRUD)
Query
Mutation
Managing permission
Selecting the data language with the REST API
Querying data in the current data language
Querying data in a selected data language
Changing the current data language
Changing the data language for a given user
Query to know the language of a given user
Mutation to update the language of a given user
Getting the list of available data languages
Adding data languages and seeing them in the API
Basic Auth vs API Key
Basic Auth
How to use it?
How to enable it?
API Key
Security
Use case
How to use it?
How to enable it?
Multi or Single Mode
Querying/Creating/Updating/Deleting with GraphQL
Basic queries
Getting an object with its attributes
Getting an object with its relations
Basic mutations
Creating an object
Creating an object with a relationship
Updating an object
Deleting an object
Creating custom schema (SDL/JSON) / custom endpoint
How it works?
General principle
Creating/Updating a schema
Creation of your metamodel to expose in the REST API
Creating Custom Metamodel
Completing default metamodel
Important rules
Pagination in REST API with GraphQL
First elements with Skip or After
Last elements with Skip and Before
Pagination and Sort
Filtering data (where condition) in REST API with GraphQL
How to make a filter?
How to combine filters?
Type of filters by type of fields
String filters
Date or DateTime filters
Numbers filters
Enumeration filters
Boolean filters
Mutation: Absolute/External/Temporary - Identifier
Making a Query
Example: query with a result containing the identifiers
Example: query containing a filter on the external identifier
Making a Mutation
Creation without an Identifier
Creation with an External Identifier
Creation with a Temporary Identifier
Asynchronous versus Synchronous Web service call
What does the endpoint return?
Calling the API in asynchronous way
How the endpoint is called?
Which is the best option?
Diagram API: dowloading a diagram by REST API
Use case
Downloading a diagram (Metaclass Diagram or System Diagram)
Result of the API
Attachment API: Uploading or Downloading Business Document
Use case
Downloading an attachment (Business Document)
Uploading an attachment (Business Document)
Getting GraphQL Schema as a file (SDL schema file)
In GraphiQL
In Postman
ID Converter From HexaIdAbs to Absolute identifier
Using Postman to call the REST API
Importing a Module into Hopex
Module
Importing a Module into Hopex
Hopex MCP Server
Objective
Scope
Key Features
Functional Architecture
Interfaces
Security
Limitations
Use Cases
Broader Business Value
Prerequisites
Administration, Installation, Configuration, and Deployment
Glossary
HOPEX diagrams in MS Teams
Teams Module Description
HOPEX in Microsoft Teams
HOPEX Configuration
REST API and GraphQL
REST API Documentation
GraphQL endpoints
GraphQL and Data Confidentiality (CRUD)
Selecting the data language with the REST API
Basic Auth vs API Key
Querying/Creating/Updating/Deleting with GraphQL
Creating custom schema (SDL/JSON) / custom endpoint
Pagination in REST API with GraphQL
Filtering data (where condition) in REST API with GraphQL
Mutation: Absolute/External/Temporary - Identifier
Asynchronous versus Synchronous Web service call
Diagram API: dowloading a diagram by REST API
Attachment API: Uploading or Downloading Business Document
Getting GraphQL Schema as a file (SDL schema file)
ID Converter From HexaIdAbs to Absolute identifier
Using Postman to call the REST API
MODULES
:
Importing a Module into Hopex
MODULES
:
Importing a Module into Hopex
:
Module
MODULES
:
Importing a Module into Hopex
:
Module
:
Module description
MODULES
:
Importing a Module into Hopex
:
Module
:
Required dependent modules
MODULES
:
Importing a Module into Hopex
:
Importing a Module into Hopex
MODULES
:
Importing a Module into Hopex
:
Importing a Module into Hopex
:
Updating an environment manually
MODULES
:
Importing a Module into Hopex
:
Importing a Module into Hopex
:
Authentication via an API key
MODULES
:
Hopex MCP Server
MODULES
:
Hopex MCP Server
:
Objective
MODULES
:
Hopex MCP Server
:
Scope
MODULES
:
Hopex MCP Server
:
Key Features
MODULES
:
Hopex MCP Server
:
Functional Architecture
MODULES
:
Hopex MCP Server
:
Interfaces
MODULES
:
Hopex MCP Server
:
Security
MODULES
:
Hopex MCP Server
:
Limitations
MODULES
:
Hopex MCP Server
:
Use Cases
MODULES
:
Hopex MCP Server
:
Use Cases
:
Analysis and Investigation
MODULES
:
Hopex MCP Server
:
Use Cases
:
Reporting, Governance, and Risk
MODULES
:
Hopex MCP Server
:
Use Cases
:
Transformation Support
MODULES
:
Hopex MCP Server
:
Use Cases
:
Visual Insight
MODULES
:
Hopex MCP Server
:
Broader Business Value
MODULES
:
Hopex MCP Server
:
Broader Business Value
:
Developers
MODULES
:
Hopex MCP Server
:
Broader Business Value
:
Strategists
MODULES
:
Hopex MCP Server
:
Broader Business Value
:
Product Managers
MODULES
:
Hopex MCP Server
:
Broader Business Value
:
Governance Teams
MODULES
:
Hopex MCP Server
:
Broader Business Value
:
Application Owners
MODULES
:
Hopex MCP Server
:
Broader Business Value
:
Transformation Leaders
MODULES
:
Hopex MCP Server
:
Prerequisites
MODULES
:
Hopex MCP Server
:
Administration, Installation, Configuration, and Deployment
MODULES
:
Hopex MCP Server
:
Glossary
MODULES
:
HOPEX diagrams in MS Teams
MODULES
:
HOPEX diagrams in MS Teams
:
Teams Module Description
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX in Microsoft Teams
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX in Microsoft Teams
:
Adding the App to your Teams (optional)
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX in Microsoft Teams
:
Adding a diagram tab in your Team
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX in Microsoft Teams
:
Viewing a HOPEX diagram
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX in Microsoft Teams
:
Editing the HOPEX diagram
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Installing Teams Module
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Configuring Http Security
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Setting SameSite cookie
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Configuring the authentication
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Configuring the authentication
:
User accounts
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Configuring the authentication
:
API Key
MODULES
:
HOPEX diagrams in MS Teams
:
HOPEX Configuration
:
Configuring the authentication
:
Authorizing HOPEX connection from Teams
MODULES
:
REST API and GraphQL
MODULES
:
REST API and GraphQL
:
REST API Documentation
MODULES
:
REST API and GraphQL
:
GraphQL endpoints
MODULES
:
REST API and GraphQL
:
GraphQL endpoints
:
Synchronous versus Asynchronous
MODULES
:
REST API and GraphQL
:
GraphQL endpoints
:
Version of the endpoint
MODULES
:
REST API and GraphQL
:
GraphQL and Data Confidentiality (CRUD)
MODULES
:
REST API and GraphQL
:
GraphQL and Data Confidentiality (CRUD)
:
Query
MODULES
:
REST API and GraphQL
:
GraphQL and Data Confidentiality (CRUD)
:
Mutation
MODULES
:
REST API and GraphQL
:
GraphQL and Data Confidentiality (CRUD)
:
Managing permission
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Querying data in the current data language
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Querying data in a selected data language
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Changing the current data language
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Changing the data language for a given user
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Changing the data language for a given user
:
Query to know the language of a given user
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Changing the data language for a given user
:
Mutation to update the language of a given user
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Getting the list of available data languages
MODULES
:
REST API and GraphQL
:
Selecting the data language with the REST API
:
Adding data languages and seeing them in the API
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
Basic Auth
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
Basic Auth
:
How to use it?
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
Basic Auth
:
How to enable it?
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
API Key
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
API Key
:
Security
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
API Key
:
Use case
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
API Key
:
How to use it?
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
API Key
:
How to enable it?
MODULES
:
REST API and GraphQL
:
Basic Auth vs API Key
:
Multi or Single Mode
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic queries
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic queries
:
Getting an object with its attributes
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic queries
:
Getting an object with its relations
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic mutations
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic mutations
:
Creating an object
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic mutations
:
Creating an object with a relationship
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic mutations
:
Updating an object
MODULES
:
REST API and GraphQL
:
Querying/Creating/Updating/Deleting with GraphQL
:
Basic mutations
:
Deleting an object
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
How it works?
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
How it works?
:
General principle
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
How it works?
:
Creating/Updating a schema
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
Creation of your metamodel to expose in the REST API
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
Creation of your metamodel to expose in the REST API
:
Creating Custom Metamodel
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
Creation of your metamodel to expose in the REST API
:
Completing default metamodel
MODULES
:
REST API and GraphQL
:
Creating custom schema (SDL/JSON) / custom endpoint
:
Creation of your metamodel to expose in the REST API
:
Important rules
MODULES
:
REST API and GraphQL
:
Pagination in REST API with GraphQL
MODULES
:
REST API and GraphQL
:
Pagination in REST API with GraphQL
:
First elements with Skip or After
MODULES
:
REST API and GraphQL
:
Pagination in REST API with GraphQL
:
Last elements with Skip and Before
MODULES
:
REST API and GraphQL
:
Pagination in REST API with GraphQL
:
Pagination and Sort
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
How to make a filter?
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
How to combine filters?
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
Type of filters by type of fields
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
Type of filters by type of fields
:
String filters
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
Type of filters by type of fields
:
Date or DateTime filters
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
Type of filters by type of fields
:
Numbers filters
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
Type of filters by type of fields
:
Enumeration filters
MODULES
:
REST API and GraphQL
:
Filtering data (where condition) in REST API with GraphQL
:
Type of filters by type of fields
:
Boolean filters
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Query
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Query
:
Example: query with a result containing the identifiers
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Query
:
Example: query containing a filter on the external identifier
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Mutation
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Mutation
:
Creation without an Identifier
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Mutation
:
Creation with an External Identifier
MODULES
:
REST API and GraphQL
:
Mutation: Absolute/External/Temporary - Identifier
:
Making a Mutation
:
Creation with a Temporary Identifier
MODULES
:
REST API and GraphQL
:
Asynchronous versus Synchronous Web service call
MODULES
:
REST API and GraphQL
:
Asynchronous versus Synchronous Web service call
:
What does the endpoint return?
MODULES
:
REST API and GraphQL
:
Asynchronous versus Synchronous Web service call
:
Calling the API in asynchronous way
MODULES
:
REST API and GraphQL
:
Asynchronous versus Synchronous Web service call
:
How the endpoint is called?
MODULES
:
REST API and GraphQL
:
Asynchronous versus Synchronous Web service call
:
Which is the best option?
MODULES
:
REST API and GraphQL
:
Diagram API: dowloading a diagram by REST API
MODULES
:
REST API and GraphQL
:
Diagram API: dowloading a diagram by REST API
:
Use case
MODULES
:
REST API and GraphQL
:
Diagram API: dowloading a diagram by REST API
:
Use case
:
Downloading a diagram (Metaclass Diagram or System Diagram)
MODULES
:
REST API and GraphQL
:
Diagram API: dowloading a diagram by REST API
:
Use case
:
Result of the API
MODULES
:
REST API and GraphQL
:
Attachment API: Uploading or Downloading Business Document
MODULES
:
REST API and GraphQL
:
Attachment API: Uploading or Downloading Business Document
:
Use case
MODULES
:
REST API and GraphQL
:
Attachment API: Uploading or Downloading Business Document
:
Downloading an attachment (Business Document)
MODULES
:
REST API and GraphQL
:
Attachment API: Uploading or Downloading Business Document
:
Uploading an attachment (Business Document)
MODULES
:
REST API and GraphQL
:
Getting GraphQL Schema as a file (SDL schema file)
MODULES
:
REST API and GraphQL
:
Getting GraphQL Schema as a file (SDL schema file)
:
In GraphiQL
MODULES
:
REST API and GraphQL
:
Getting GraphQL Schema as a file (SDL schema file)
:
In Postman
MODULES
:
REST API and GraphQL
:
ID Converter From HexaIdAbs to Absolute identifier
MODULES
:
REST API and GraphQL
:
Using Postman to call the REST API