REST API for Oracle Integration 3

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"}]

robots: specifies RPA robots included in the deployment. For example:

"robots":[{"identifier":"TEST_RPA1","version":"01.00.0000"},   {"identifier":"TEST_RPA2","version":"02.00.0000"}]

decisions: specifies decision services included in the deployment. For example:

"decisions":[{"identifier":"TEST_DEC1","version":"01.00.0000"},   {"identifier":"TEST_DEC2","version":"02.00.0000"}]

b2btradingpartners: lists B2B trading partners involved in the deployment. For example:

"b2btradingpartners":[{"code":"TEST_B2BTP1","version":"01.00.0000"},   {"code":"TEST_B2BTP2","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

Root Schema : schema

Type: object

Show Source

b2btradingpartners: array b2btradingpartners

B2BTradingPartner List
code(required): string

Deployment Identifier
decisions: array decisions

Decision List
description: string

Deployment Description
integrations: array integrations

Integration List
lastUpdated: string (date-time)

Last Updated Date
name(required): string

Deployment Name
robots: array robots

Robot 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"
        },
        "integrations":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        },
        "robots":{
            "type":"array",
            "description":"Robot List",
            "items":{
                "$ref":"#/components/schemas/RPADeploymentFlow"
            }
        },
        "decisions":{
            "type":"array",
            "description":"Decision List",
            "items":{
                "$ref":"#/components/schemas/DecisionDeploymentFlow"
            }
        },
        "b2btradingpartners":{
            "type":"array",
            "description":"B2BTradingPartner List",
            "items":{
                "$ref":"#/components/schemas/TradingPartner"
            }
        }
    }
}

Nested Schema : b2btradingpartners

Type: array

B2BTradingPartner List

Show Source

Array of: object TradingPartner

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

Nested Schema : decisions

Type: array

Decision List

Show Source

Array of: object DecisionDeploymentFlow

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

Nested Schema : integrations

Type: array

Integration List

Show Source

Array of: object Integration

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

Nested Schema : robots

Type: array

Robot List

Show Source

Array of: object RPADeploymentFlow

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

Nested Schema : TradingPartner

Type: object

Show Source

code: string

TradingPartner Code
inboundAgrs: array inboundAgrs

TradingPartner inboundAgrs List
name: string

TradingPartner Name
outboundAgrs: array outboundAgrs

TradingPartner outboundAgrs List
status: string

TradingPartner Status
transports: array transports

TradingPartner Transports List
type: string

TradingPartner Type
version: string

Default Value: 01.00.0000

TradingPartner Version

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"TradingPartner Code"
        },
        "name":{
            "type":"string",
            "description":"TradingPartner Name"
        },
        "version":{
            "type":"string",
            "description":"TradingPartner Version",
            "default":"01.00.0000"
        },
        "type":{
            "type":"string",
            "description":"TradingPartner Type"
        },
        "status":{
            "type":"string",
            "description":"TradingPartner Status"
        },
        "transports":{
            "type":"array",
            "description":"TradingPartner Transports List",
            "items":{
                "type":"string"
            }
        },
        "inboundAgrs":{
            "type":"array",
            "description":"TradingPartner inboundAgrs List",
            "items":{
                "type":"string"
            }
        },
        "outboundAgrs":{
            "type":"array",
            "description":"TradingPartner outboundAgrs List",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : inboundAgrs

Type: array

TradingPartner inboundAgrs List

Show Source

Array of: string

{
    "type":"array",
    "description":"TradingPartner inboundAgrs List",
    "items":{
        "type":"string"
    }
}

Nested Schema : outboundAgrs

Type: array

TradingPartner outboundAgrs List

Show Source

Array of: string

{
    "type":"array",
    "description":"TradingPartner outboundAgrs List",
    "items":{
        "type":"string"
    }
}

Nested Schema : transports

Type: array

TradingPartner Transports List

Show Source

Array of: string

{
    "type":"array",
    "description":"TradingPartner Transports List",
    "items":{
        "type":"string"
    }
}

Nested Schema : DecisionDeploymentFlow

Type: object

Show Source

displayName: string

Decision Name
identifier: string

Decision Identifier
status: string

Decision Status
version: string

Decision Version

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"string",
            "description":"Decision Identifier"
        },
        "version":{
            "type":"string",
            "description":"Decision Version"
        },
        "displayName":{
            "type":"string",
            "description":"Decision Name"
        },
        "status":{
            "type":"string",
            "description":"Decision Status"
        }
    }
}

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"
        }
    }
}

Nested Schema : RPADeploymentFlow

Type: object

Show Source

displayName: string

Robot Name
identifier: string

Robot Identifier
lifecycleState: string

Robot Lifecycle State
version: string

Robot Version

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"string",
            "description":"Robot Identifier"
        },
        "version":{
            "type":"string",
            "description":"Robot Version"
        },
        "displayName":{
            "type":"string",
            "description":"Robot Name"
        },
        "lifecycleState":{
            "type":"string",
            "description":"Robot Lifecycle State"
        }
    }
}

Response

Supported Media Types

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

200 Response

Successful operation

Root Schema : schema

Type: object

Show Source

b2btradingpartners: array b2btradingpartners

B2BTradingPartner List
code(required): string

Deployment Identifier
decisions: array decisions

Decision List
description: string

Deployment Description
integrations: array integrations

Integration List
lastUpdated: string (date-time)

Last Updated Date
name(required): string

Deployment Name
robots: array robots

Robot 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"
        },
        "integrations":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        },
        "robots":{
            "type":"array",
            "description":"Robot List",
            "items":{
                "$ref":"#/components/schemas/RPADeploymentFlow"
            }
        },
        "decisions":{
            "type":"array",
            "description":"Decision List",
            "items":{
                "$ref":"#/components/schemas/DecisionDeploymentFlow"
            }
        },
        "b2btradingpartners":{
            "type":"array",
            "description":"B2BTradingPartner List",
            "items":{
                "$ref":"#/components/schemas/TradingPartner"
            }
        }
    }
}

Nested Schema : b2btradingpartners

Type: array

B2BTradingPartner List

Show Source

Array of: object TradingPartner

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

Nested Schema : decisions

Type: array

Decision List

Show Source

Array of: object DecisionDeploymentFlow

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

Nested Schema : integrations

Type: array

Integration List

Show Source

Array of: object Integration

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

Nested Schema : robots

Type: array

Robot List

Show Source

Array of: object RPADeploymentFlow

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

Nested Schema : TradingPartner

Type: object

Show Source

code: string

TradingPartner Code
inboundAgrs: array inboundAgrs

TradingPartner inboundAgrs List
name: string

TradingPartner Name
outboundAgrs: array outboundAgrs

TradingPartner outboundAgrs List
status: string

TradingPartner Status
transports: array transports

TradingPartner Transports List
type: string

TradingPartner Type
version: string

Default Value: 01.00.0000

TradingPartner Version

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"TradingPartner Code"
        },
        "name":{
            "type":"string",
            "description":"TradingPartner Name"
        },
        "version":{
            "type":"string",
            "description":"TradingPartner Version",
            "default":"01.00.0000"
        },
        "type":{
            "type":"string",
            "description":"TradingPartner Type"
        },
        "status":{
            "type":"string",
            "description":"TradingPartner Status"
        },
        "transports":{
            "type":"array",
            "description":"TradingPartner Transports List",
            "items":{
                "type":"string"
            }
        },
        "inboundAgrs":{
            "type":"array",
            "description":"TradingPartner inboundAgrs List",
            "items":{
                "type":"string"
            }
        },
        "outboundAgrs":{
            "type":"array",
            "description":"TradingPartner outboundAgrs List",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : inboundAgrs

Type: array

TradingPartner inboundAgrs List

Show Source

Array of: string

{
    "type":"array",
    "description":"TradingPartner inboundAgrs List",
    "items":{
        "type":"string"
    }
}

Nested Schema : outboundAgrs

Type: array

TradingPartner outboundAgrs List

Show Source

Array of: string

{
    "type":"array",
    "description":"TradingPartner outboundAgrs List",
    "items":{
        "type":"string"
    }
}

Nested Schema : transports

Type: array

TradingPartner Transports List

Show Source

Array of: string

{
    "type":"array",
    "description":"TradingPartner Transports List",
    "items":{
        "type":"string"
    }
}

Nested Schema : DecisionDeploymentFlow

Type: object

Show Source

displayName: string

Decision Name
identifier: string

Decision Identifier
status: string

Decision Status
version: string

Decision Version

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"string",
            "description":"Decision Identifier"
        },
        "version":{
            "type":"string",
            "description":"Decision Version"
        },
        "displayName":{
            "type":"string",
            "description":"Decision Name"
        },
        "status":{
            "type":"string",
            "description":"Decision Status"
        }
    }
}

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"
        }
    }
}

Nested Schema : RPADeploymentFlow

Type: object

Show Source

displayName: string

Robot Name
identifier: string

Robot Identifier
lifecycleState: string

Robot Lifecycle State
version: string

Robot Version

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"string",
            "description":"Robot Identifier"
        },
        "version":{
            "type":"string",
            "description":"Robot Version"
        },
        "displayName":{
            "type":"string",
            "description":"Robot Name"
        },
        "lifecycleState":{
            "type":"string",
            "description":"Robot Lifecycle State"
        }
    }
}

400 Response

Bad request, missing required data

500 Response

Server error

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, robots & decisions in a project:

TEST_INT1|01.00.0000
TEST_INT2|02.00.0000
TEST_INT2|02.00.0002
TEST_INT3|03.00.0000
TEST_RPA1|01.00.0000
TEST_RPA2|02.00.0000
TEST_DEC1|01.00.0000
TEST_DEC2|02.00.0002

In this example, we create a deployment with two integrations, one robot and one decision.

{"name":"TestDeployment","code":"TESTDEPLOYMENT","description":"Test deployment","integrations":
[{"code":"TEST_INT1","version":"01.00.0000"}, {"code":"TEST_INT2","version":"02.00.0002"}],"robots":
[{"identifier":"TEST_RPA1","version":"01.00.0000"}],"decisions":[{"code":"TEST_DEC2","version":"02.00.0002"}]}