Gets the available compartments for a given tenancyId
get
/appstore/publisher/v1/ocitenancies/{tenancyId}/compartments
Get the available compartments for a given tenancyId of a partner.
Request
Path Parameters
-
tenancyId: boolean
this value specifies the tenancy which compartments need to be fetched.
Query Parameters
-
limit(optional): integer(int32)
Limit tells how many records to return (starting from the offset). Limit should be greater than zero and less than or equal to 100 (default=30).
-
offset(optional): integer(int32)
Offset and limit together determine how many records to return from the collection. Offset is the starting index of the records to return, which should be greater than or equal to zero (default=0).
Response
Supported Media Types
- application/json;qs=1
- application/xml;qs=.5
200 Response
Successful Operation
Nested Schema : Link
Type:
Show Source
object
-
href(optional):
string
-
rel(optional):
string
Allowed Values:
[ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]
400 Response
Invalid Parameter Value
401 Response
Not Authorized
404 Response
Entity Not Found
500 Response
System Error
Examples
The following example fetches the compartments for a given tenancy, by submitting a GET request on the REST resource using cURL.
cURL Example
curl -X GET -H "Authorization: Bearer Access-token" -H "X-Oracle-UserId: partner-email" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/ocitenancies/15786747/compartments?limit=100"
Request Header
Authorization: Bearer Access-token X-Oracle-UserId: fname.lname@oracle.com
Request Body
NONEHTTP Status Code:
200 OK
JSON Response:
{ "items":[ { "TenancyCompartment":{ "id":"ocid1.compartment.region1..aaaaaaaa3wbgnc7d4644drvokszlp6usigamqdwzofzb2qjdxfwvxf6od5jq", "compartmentId":"ocid1.tenancy.oc1..aaaaaaaaqaeq3aymehirrbetu7kxpzctvqfhqpy3hk7rjde6na7457pfyj7q", "name":"acme", "description":"Compartent for acme App Catalog Listings ", "lifecycleState":"Active" } }, { "TenancyCompartment":{ "id":"ocid1.compartment.region1..aaaaaaaaelzb6xjh2zsebgziqnbsdva7sk4ngmfq3m3r2vcgwkss4efum7gq", "compartmentId":"ocid1.tenancy.oc1..aaaaaaaaqaeq3aymehirrbetu7kxpzctvqfhqpy3hk7rjde6na7457pfyj7q", "name":"test", "description":"...", "lifecycleState":"Active" } }, { "TenancyCompartment":{ "id":"ocid1.tenancy.oc1..aaaaaaaaqaeq3aymehirrbetu7kxpzctvqfhqpy3hk7rjde6na7457pfyj7q", "compartmentId":"ocid1.tenancy.oc1..aaaaaaaaqaeq3aymehirrbetu7kxpzctvqfhqpy3hk7rjde6na7457pfyj7q", "name":"vkvemula", "lifecycleState":"Active" } } ], "hasMore":false, "count":3, "totalResults":3, "links":[ { "rel":"CANONICAL", "href":"https://ocm-apis.us.oracle.com/appstore/publisher/v1/ocitenancies/15786747/compartments" }, { "rel":"SELF", "href":"https://ocm-apis.us.oracle.com/appstore/publisher/v1/ocitenancies/15786747/compartments?limit=100" } ] }Back to Top