Jump to

• Request
• Response
• Examples

Cloud Resources

get

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

Get the list of Cloud Resources under each Cloud Service.

Request

Path Parameters

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

Query Parameters

• expands(optional): string
  It accepts one value - properties : If this value is specified, it includes properties under each resource

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root Schema : CloudResource

Type: object

Show Source

• displayName(optional): string
• isRequired(optional): boolean
• links(optional): array link
• name(optional): string
• supportsCustomProperties(optional): boolean

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "isRequired":{
            "type":"boolean"
        },
        "supportsCustomProperties":{
            "type":"boolean"
        },
        "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 resources under a given service, 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/{serviceName}/resources"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
        {
            "CloudResource": {
                "name": "IntegrationFlow",
                "displayName": "Integration Flow",
                "isRequired": false,
                "supportsCustomProperties": false
            }
        },
        {
            "CloudResource": {
                "name": "ProcessFlow",
                "displayName": "Process Flow",
                "isRequired": false,
                "supportsCustomProperties": false
            }
        }
    ],
    "hasMore": false,
    "count": 2,
    "totalResults": 2,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/cloudservices/oic/resources"
        },
        {
            "rel": "SELF",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/cloudservices/oic/resources"
        }
    ]
}

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/{serviceName}/resources?expands=properties"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
        {
            "CloudResource": {
                "name": "IntegrationFlow",
                "displayName": "Integration Flow",
                "isRequired": false,
                "supportsCustomProperties": false,
                "properties": [
                    {
                        "name": "file",
                        "displayName": "File",
                        "description": "Upload Par file",
                        "dataType": "file",
                        "cardinality": "SINGLE_VALUE",
                        "isRequired": true,
                        "supportedFiles": "par",
                        "sequence": 1
                    },
                    {
                        "name": "packageName",
                        "displayName": "Package Name",
                        "description": "Package name which is part of the par file",
                        "dataType": "string",
                        "cardinality": "SINGLE_VALUE",
                        "isRequired": true,
                        "sequence": 2
                    },
                    {
                        "name": "integrationType",
                        "displayName": "Integration Type",
                        "dataType": "lov",
                        "cardinality": "SINGLE_VALUE",
                        "isRequired": true,
                        "lookupTypeId": 101,
                        "sequence": 3,
                        "listOfValues": [
                            {
                                "code": "sample",
                                "displayName": "Sample"
                            },
                            {
                                "code": "Pre-built",
                                "displayName": "Pre-built"
                            }
                        ]
                    }
                ]
            }
        },
        {
            "CloudResource": {
                "name": "ProcessFlow",
                "displayName": "Process Flow",
                "isRequired": false,
                "supportsCustomProperties": false,
                "properties": [
                    {
                        "name": "file",
                        "displayName": "File",
                        "description": "Upload exp file",
                        "dataType": "file",
                        "cardinality": "SINGLE_VALUE",
                        "isRequired": true,
                        "supportedFiles": "exp",
                        "sequence": 1
                    },
                    {
                        "name": "space",
                        "displayName": "Space",
                        "dataType": "string",
                        "cardinality": "SINGLE_VALUE",
                        "isRequired": true,
                        "sequence": 2
                    }
                ]
            }
        }
    ],
    "hasMore": false,
    "count": 2,
    "totalResults": 2,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/cloudservices/oic/resources"
        },
        {
            "rel": "SELF",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/cloudservices/oic/resources?expands=properties"
        }
    ]
}

Back to Top