Jump to

• Request
• Response
• Examples

Retrieve Deployments in a Project

get

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

Retrieves information about all the deployments in a project.

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.
• limit: integer(int32)
  Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list deployments starting at the 4th item, and the list will contain 16 items.
• offset: integer(int32)
  Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list deployments starting at the 4th item, and the list will contain 16 items.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : LabelsRs

Type: object

Show Source

• items: array items
  List of Deployments

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Deployments",
            "items":{
                "$ref":"#/components/schemas/LabelRs"
            }
        }
    }
}

Nested Schema : items

Type: array

List of Deployments

Show Source

• Array of: object LabelRs

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

Nested Schema : LabelRs

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

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve details about deployments in a project by submitting a GET 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: Paginate through returned deployments in the project TEST_PROJECT

Pagination is done with limit and offset. In this example, we list deployments starting at the fourth item. The list contains 16 items.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/deployments?integrationInstance=service-instance

Example: Get all deployments in the project TEST_PROJECT

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

Back to Top