Jump to

• Request
• Response
• Examples

Cloud Resource Properties

get

/appstore/publisher/v1/cloudservices/{serviceCode}/resourcenames/{resourceName}

Get the list of Cloud Resource Properties under each Cloud Resource.

Request

Path Parameters

• resourceName: string
  Unique identifier of the cloud resource for which the associated properties are required.
• serviceCode: string
  Unique identifier of the cloud service for which the associated resource properties are required.

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : CloudResourceProperty

Type: object

Show Source

• cardinality(optional): string
• dataType(optional): string
• description(optional): string
• displayName(optional): string
• isRequired(optional): boolean
• links(optional): array link
• name(optional): string
• sequence(optional): integer
• supportedFiles(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "dataType":{
            "type":"string"
        },
        "cardinality":{
            "type":"string"
        },
        "isRequired":{
            "type":"boolean"
        },
        "supportedFiles":{
            "type":"boolean"
        },
        "sequence":{
            "type":"integer"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• rel(optional): string
  Allowed Values: [ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "SELF",
                "CANONICAL",
                "NEXT",
                "TEMPLATE",
                "PREV"
            ]
        },
        "href":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

400 Response

Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example fetches the cloud services, by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/cloudservices"

Request Header

X-Oracle-UserId: [e-mail] 
Authorization: Bearer Access-token 

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
        {
            "CloudService": {
                "name": "oic",
                "displayName": "Oracle Integration Cloud Service",
                "description": "Oracle Integration Cloud Service",
                "status": "ACTIVE"
            }
        },
        {
            "CloudService": {
                "name": "Compute",
                "displayName": "Oracle Compute Cloud Service",
                "description": "Oracle Compute Cloud Service",
                "status": "ACTIVE"
            }
        },
        {
            "CloudService": {
                "name": "JAVA",
                "displayName": "Java Service",
                "description": "Java Service desc",
                "status": "ACTIVE"
            }
        }
    ],
    "hasMore": false,
    "count": 3,
    "totalResults": 3,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "http://den02bni.us.oracle.com:7101/appstore/publisher/v1/cloudservices"
        },
        {
            "rel": "SELF",
            "href": "http://den02bni.us.oracle.com:7101/appstore/publisher/v1/cloudservices"
        }
    ]
}

Back to Top