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 TopResponse
Supported Media Types
- application/json;charset=utf-8, application/vnd.oracle.model+json;type=collection
200 Response
Successful operation
Nested Schema : LabelRs
Type:
Show Source
object
-
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
400 Response
Malformed parameters
500 Response
Server error
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