Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Use the following details to configure API:

  1. Capture Pass the tenant access token created during the Automation tenant provisioning. This Bearer token is sent as the Header to the API. Access Bearer token to API as Header. The Bearer token is generated using Tenant Admin Login API. The Bearer token is valid only for 10 mins. The header should be passed as Header - Authorization: Bearer <Tenant Access Token>. You can also use Regenerate Tenant Access Token API to regenerate and fetch the tenant access token.

  2. URI: /gateway/api/v1/export
    For Example: http://itasdevops.automationsaqa1.com/gateway/api/v1/export

  3. HTTP Method for the operation: POST

  4. Send Content-Type: application/json as the Header to the API.

  5. Pass the following as Outbound Payload or Request to the Web Service. The request is passed in the following JSON format.

    Code Block
    [
        {
            "type": "WORKFLOW_DEFINITION",
            "subType": null,
            "ids": [78]
        }
    ]
    1. Type: Refers to the Item name to be exported.

    2. SubType: Refers to the sub-entity. Based on the Type selected, add the subType.

    3. Id: Represents the identifier of the specific item to be exported.

...

  1. URI: /gateway/api/v1/designer/content/import
    For Example: http://itasdevops.automationsaqa1.com/gateway/api/v1/designer/content/import

  2. HTTP Method for the operation: POST

  3. Pass the following Headers to the API:

    1. Capture Pass the tenant access token created during the Automation tenant provisioning. This Bearer token is sent as the Header to the API. Access Bearer token to API as Header. The Bearer token is generated using Tenant Login API. The Bearer token is valid only for 10 mins. The header should be passed as Header - Authorization: Bearer <Tenant Access Token>. You can also use Regenerate Tenant Access Token API to regenerate and fetch the tenant access token.

    2. Content-Type: multipart/form-data. This ensures the API accepts the file attachment as input.

    3. Accept: application/json

  4. Send the ZIP file as an attachment.

...

Info

When importing an instance or operation, the corresponding Connected App should already be available in the target tenant. If the App is not available, the import process fails. Likewise, for Operation import, the corresponding Connected App and Instance should be available in the target tenant.