Jump to

• Request
• Response
• Examples

Copy an Integration in a Project

post

/ic/api/integration/v1/projects/{projectId}/integrations/copy

Copies an integration into a project. The integration to copy can be either in a different project (as long as it is marked as globally available) or outside of any project. The request body must include the integration's code and version. If the integration belongs to another project, the projectCode field in the request body should specify the project's code.

Request

Path Parameters

• projectId(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• integrations: array integrations
  Integration Details
• project-code: string
  Project Identifier

{
    "type":"object",
    "properties":{
        "project-code":{
            "type":"string",
            "description":"Project Identifier"
        },
        "integrations":{
            "type":"array",
            "description":"Integration Details",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        }
    }
}

Nested Schema : integrations

Type: array

Integration Details

Show Source

• Array of: object Integration

{
    "type":"array",
    "description":"Integration Details",
    "items":{
        "$ref":"#/components/schemas/Integration"
    }
}

Nested Schema : Integration

Type: object

Show Source

• code: string
  Integration Code
• name: string
  Integration Name
• status: string
  Integration Status
• type: string
  Integration Type
• version: string
  Integration Version

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Integration Code"
        },
        "version":{
            "type":"string",
            "description":"Integration Version"
        },
        "name":{
            "type":"string",
            "description":"Integration Name"
        },
        "status":{
            "type":"string",
            "description":"Integration Status"
        },
        "type":{
            "type":"string",
            "description":"Integration Type"
        }
    }
}

Back to Top

Response

204 Response

Successful operation

400 Response

Bad request, missing required data

500 Response

Server error

Back to Top

Examples

The following example shows how to copy an integration into a project by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Copy integration TEST_PROJ2_INT from another project into TEST_PROJECT

This command consumes JSON data and copies a integration with the code and version specified in the request body.

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @copyprojectintegration.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations/copy?integrationInstance=service-instance

Request body

The following example shows the contents of the request body in JSON format. This is the content of the copyprojectintegration.json file listed in the cURL command with the -d option.

{"projectCode":"TEST_PROJ2","integrations":[{"code":"TEST_PROJ2_INT","version":"01.00.0000"}]}

Example: Copy integration TEST_GLOBAL_INT outside of any project into project TEST_PROJECT

This command consumes JSON data and copies a integration with the code and version specified in the request body.

Request

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d @copyglobalintegration.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations/copy?integrationInstance=service-instance

Request Body

The following example shows the contents of the request body in JSON format. This is the content of the copyglobalintegration.json file listed in the cURL command with the -d option.

{"projectCode":null,"integrations":[{"code":"TEST_GLOBAL_INT","version":"01.00.0000"}]}

Back to Top