Promote using REST APIs

You can use REST API to promote one or more flows from a source to a target environment by executing a GET in the source environment, and then a POST or PUT in the target environment. However, prior to promoting flows, the applications, application groups, unmanaged products, and partners used in the flow must be defined in the target environment, which you can also do using Rest APIs. For details, see Promote flow participants.

Prerequisites

To create or modify flows on the target environment, you must have permission on the flow resource:

  • POST: Create flow privilege
  • PUT: Modify flow privilege

Identifier overview

If the POST or PUT detects a business ID that does not exist on the target environment, the unique object identifier is taken into account.

Resource

Unique identifier

Promoted via APIs

Comment

applications

Name and host

Yes

 

applicationGroups

Name

Yes

 

products

Name

Partially

You can only promote product communication profiles

unmanagedProducts

Name

Yes

 

partners

Name

Yes

 

Fallback identifier

Central Governance objects are identified by business IDs in the MongoDB, where business IDs are not the same in any two Central Governance installations. Therefore, for promotion purposes, there is a fallback mechanism for POST and PUT commands to use the name of an object when the business ID used in the flow JSON is not found in the production environment.

Example

When updating a flow, the application group business ID is not found in the current Central Governance installation. For an application group, the fallback identifier is its name. Here, the group's business ID is ignored, and the application's group name "g1"is the identifier.

"sources": {

  "type": "GROUP",

      "parts": [

        {

          "part": {

            "businessId": "69f73ca1-0a07-4c66-81df-83e80e05ed7f",

            "name": "g1"

          }

        }

      ]

 

Central Governance | Document Directory

Related Links