Developers can use multiple APIs and SDKs to interact with Hyland Automate Modeling.
The OpenAPI specifications for application endpoints require the {application-name} element in the URL:
- Application runtime bundle: {domain-name}/{application-name}/rb/swagger-ui/index.html.
- Application query service: {domain-name}//{application-name}/query/swagger-ui/index.html.
The query service can also use GraphQL to expand the querying and can be accessed at: {domain-name}/{application-name}/notifications/graphiql.
Platform Endpoints
The OpenAPI specifications for platform endpoints are as follows:
| Service | Description | Example |
|---|---|---|
| Modeling | {domain-name}/modeling-service/swagger-ui/index.html | https://aae.studio.experience.hyland.com/modeling-service/swagger-ui/index.html |
| Deployment | {domain-name}/deployment-service/swagger-ui/index.html | https://aae.studio.experience.hyland.com/deployment-service/swagger-ui/index.html |
App-Specific Endpoints
The OpenAPI specifications for application endpoints require the {application-name} element in the URL as demonstrated in the following:
| Service | Description | Example |
|---|---|---|
| Application runtime bundle | {domain-name}/{application-name}/rb/swagger-ui/index.html | https://aae.studio.experience.hyland.com/invoice-review/rb/swagger-ui/index.html |
| Application query service | gateway.{domain-name}/{application-name}/query/swagger-ui/index.htmlExamples: | https://aae.studio.experience.hyland.com/invoice-review/query/swagger-ui/index.html |
GraphQL APIs
The query service can also use GraphQL to expand on querying. It can be accessed at the following URL: {domain-name}/{application-name}/notifications/graphql.
Java SDK
The SDK allows developers to interact with the Process Runtime services using Java. The code to interact with individual services is generated when the SDK is compiled based on actual services that are running, so it will be up-to-date with respect to the given deployment that is referenced during compilation.
JavaScript SDK
The SDK allows developers to interact with the Process Runtime services using JavaScript.