Central Governance 1.1.3 Users Guide Save PDF Selected topic Selected topic and subtopics All content Using REST API This section describes how to use a public REST API to automate access to a Central Governance resource. Resources are applications, application groups, products, unmanaged products, partners and flows. A sub-resource refers to, for example, a partner's client communication profile. The embedded Central Governance API documentation is implemented using Swagger and can be accessed at the following location: https://<CG_host>:<CG_port>/Axway/CentralGovernance/default/CentralGovernance/resources/cg/doc/external/documentation/restdocs/index.html Or, from the Axway documentation portal, the Central Governance REST APIs are available at: Central Governance REST API v2.1 Business use case A user, such as the digital merchandising manager in a retail company, wants to define a flow that daily updates the product list of the company's stores at many locations. Using Central Governance, the manager sets the source to the product catalog application (PCA), and the target is the stores' applications. The manager deploys the flow. A month from now, the manager needs to add a new store; the flow must be updated with this new application. She can define the new application and add it to the flow via an API. Managing flows with APIs You can use REST APIs to: CRUDL operations for flow components such as applications, application groups, products, unmanaged products, partners and their sub-resources, such as client and server communication profiles CRUDL and deploy A2A flows. A2A flows only support the PeSIT protocol and include Transfer CFT applications and application groups, products as relay, and unmanaged products CRUDL and deploy A2B flows. A2B flows support partners and all product types Update tags on a set of components of the same type CRUDL operations for certificates and SSH keys used in partners and products CRUDL operations for custom defined fields in applications Privileges The operations on a resource or a sub-resource can only be performed if the user has privileges on that resource. See User management > Authorization for more information. Return codes Return status codes include: Success or information codes: 200, 201, 202 Client-error codes: 400, 403, 404, 409, 412 Critical error code: 500 Related topics REST API examples Central Governance | Document Directory Related Links
Using REST API This section describes how to use a public REST API to automate access to a Central Governance resource. Resources are applications, application groups, products, unmanaged products, partners and flows. A sub-resource refers to, for example, a partner's client communication profile. The embedded Central Governance API documentation is implemented using Swagger and can be accessed at the following location: https://<CG_host>:<CG_port>/Axway/CentralGovernance/default/CentralGovernance/resources/cg/doc/external/documentation/restdocs/index.html Or, from the Axway documentation portal, the Central Governance REST APIs are available at: Central Governance REST API v2.1 Business use case A user, such as the digital merchandising manager in a retail company, wants to define a flow that daily updates the product list of the company's stores at many locations. Using Central Governance, the manager sets the source to the product catalog application (PCA), and the target is the stores' applications. The manager deploys the flow. A month from now, the manager needs to add a new store; the flow must be updated with this new application. She can define the new application and add it to the flow via an API. Managing flows with APIs You can use REST APIs to: CRUDL operations for flow components such as applications, application groups, products, unmanaged products, partners and their sub-resources, such as client and server communication profiles CRUDL and deploy A2A flows. A2A flows only support the PeSIT protocol and include Transfer CFT applications and application groups, products as relay, and unmanaged products CRUDL and deploy A2B flows. A2B flows support partners and all product types Update tags on a set of components of the same type CRUDL operations for certificates and SSH keys used in partners and products CRUDL operations for custom defined fields in applications Privileges The operations on a resource or a sub-resource can only be performed if the user has privileges on that resource. See User management > Authorization for more information. Return codes Return status codes include: Success or information codes: 200, 201, 202 Client-error codes: 400, 403, 404, 409, 412 Critical error code: 500 Related topics REST API examples Central Governance | Document Directory