Jump to

• Request
• Response
• Examples

Retrieve a Deployment in a Project

get

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

Retrieves detailed information about the deployment in a project.

Request

Path Parameters

• id(required): string
  Deployment identifier
• 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.

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

404 Response

Deployment not found

500 Response

Server error

Back to Top

Examples

The following example shows how to get details about a deployment 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: Get details about the deployment TESTDEPLOYMENT 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/TESTDEPLOYMENT?integrationInstance=service-instance

Back to Top