Jump to

• Request
• Response
• Examples

Create a Deployment in a Project

post

/ic/api/integration/v1/projects/{projectId}/deployments

Creates a deployment in a project. The request body must contain name and code.

• name: defines the name of the deployment.
• code: defines the code which is the unique identifier for the deployment.
• description: describes the deployment.
• integrations: specifies the integrations associated with the deployment. For example:

  "integrations":[{"code":"TEST_INT1","version":"01.00.0000"},  {"code":"TEST_INT2","version":"02.00.0000"}]

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

• code(required): string
  Deployment Identifier
• description: string
  Deployment Description
• lastUpdated: string (date-time)
  Last Updated Date
• name(required): string
  Deployment Name
• rows: array rows
  Integration List

{
    "required":[
        "name",
        "code"
    ],
    "type":"object",
    "properties":{
        "name":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Name"
        },
        "code":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Identifier"
        },
        "description":{
            "type":"string",
            "description":"Deployment Description"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "rows":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        }
    }
}

Nested Schema : rows

Type: array

Integration List

Show Source

• Array of: object Integration

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

Nested Schema : Integration

Type: object

Show Source

• code: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8, application/vnd.oracle.model+json;type=singular

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• code(required): string
  Deployment Identifier
• description: string
  Deployment Description
• lastUpdated: string (date-time)
  Last Updated Date
• name(required): string
  Deployment Name
• rows: array rows
  Integration List

{
    "required":[
        "name",
        "code"
    ],
    "type":"object",
    "properties":{
        "name":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Name"
        },
        "code":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Identifier"
        },
        "description":{
            "type":"string",
            "description":"Deployment Description"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "rows":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        }
    }
}

Nested Schema : rows

Type: array

Integration List

Show Source

• Array of: object Integration

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

Nested Schema : Integration

Type: object

Show Source

• code: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

400 Response

Bad request, missing required data

500 Response

Server error

Back to Top

Examples

The following example shows how to create a deployment in 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: Create a deployment in the project TEST_PROJECT

This command consumes JSON data and creates a deployment with the name and values specified in the request body.

Request:

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

Request Body:

The following example shows the contents of the request body in JSON format. This is the content of the deployment.json file listed in the cURL command with the -d option. For example, we have the following integrations in a project:

• TEST_INT1|01.00.0000
• TEST_INT2|02.00.0000
• TEST_INT2|02.00.0002
• TEST_INT3|03.00.0000

In this example, we create a deployment with two integrations.

{"name":"TestDeployment","code":"TESTDEPLOYMENT","description":"Test deployment","integrations":[{"code":"TEST_INT1","version":"01.00.0000"},  {"code":"TEST_INT2","version":"02.00.0000"}]}

Back to Top