Jump to

• Request
• Response
• Examples

List of Services

get

/appstore/publisher/v1/services

GET the list of all services for the publisher.

Request

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).
• orderby(optional): string
  This property sorts the result set. Acceptable values are NAME, LASTUPDATEDATE
• sortorder(optional): string
  This property specifies the order in which to sort the result set. Acceptable values are ASC and DESC.

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root Schema : collection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• links(optional): array link
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ListingSummary"
            }
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"collection"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object listingSummary

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : listingSummary

Type: object

Show Source

• icon(optional): object Icon
• industries(optional): array industries
• listingId(optional): integer(int64)
• listingVersionId(optional): integer(int64)
• name(optional): string
• products(optional): array products
• shortDescription(optional): string
• status(optional): string
• tagLine(optional): string
• tags(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "listingId":{
            "type":"integer",
            "format":"int64"
        },
        "listingVersionId":{
            "type":"integer",
            "format":"int64"
        },
        "shortDescription":{
            "type":"string"
        },
        "tags":{
            "type":"string"
        },
        "tagLine":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "icon":{
            "$ref":"#/definitions/Icon"
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Product"
            }
        },
        "industries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        }
    },
    "xml":{
        "name":"listingSummary"
    }
}

Nested Schema : Icon

Type: object

Show Source

• contentId(optional): integer(int64)
• contentURL(optional): string
• fileExtension(optional): string
• mimeType(optional): string
• name(optional): string
• resourceURL(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        },
        "contentId":{
            "type":"integer",
            "format":"int64"
        },
        "resourceURL":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "fileExtension":{
            "type":"string"
        }
    }
}

Nested Schema : industries

Type: array

Show Source

• Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Item"
    }
}

Nested Schema : products

Type: array

Show Source

• Array of: object product

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Product"
    }
}

Nested Schema : Item

Type: object

Show Source

• code(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : product

Type: object

Show Source

• categories(optional): array categories
• code(optional): string
• filters(optional): array filters
• name(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "filters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProductFilter"
            }
        }
    },
    "xml":{
        "name":"product"
    }
}

Nested Schema : categories

Type: array

Show Source

• Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Item"
    }
}

Nested Schema : filters

Type: array

Show Source

• Array of: object ProductFilter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ProductFilter"
    }
}

Nested Schema : ProductFilter

Type: object

Show Source

• code(optional): string
• name(optional): string
• values(optional): array values

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        }
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Item"
    }
}

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

Invalid Parameter Value

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example fetches the list of services, 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/services?limit=2"

Request Header

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

Request Body

NONE

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
        {
            "listingSummary": {
                "name": "APS18.2.4REST-SI",
                "listingId": 2829825,
                "listingVersionId": 2829826,
                "shortDescription": "short description keywords",
                "tags": "keywords keywords",
                "tagLine": "tag line",
                "status": "NEW",
                "icon": {
                    "name": "star.png",
                    "contentURL": "https://partner.cloudmarketplace.oracle.com/partner/content?contentId=2829840",
                    "mimeType": "image/png",
                    "fileExtension": "png"
                },
                "products": [
                    {
                        "code": "compute",
                        "name": "Compute Classic"
                    },
                    {
                        "code": "marketing",
                        "name": "Marketing Cloud"
                    }
                ],
                "industries": [
                    {
                        "code": "PUBLIC_SECTOR",
                        "name": "Public Sector"
                    },
                    {
                        "code": "HEALTHCARE",
                        "name": "Healthcare"
                    },
                    {
                        "code": "CONSUMER_GOODS",
                        "name": "Consumer Goods"
                    }
                ]
            }
        },
        {
            "listingSummary": {
                "name": "stgJulySI",
                "listingId": 2829345,
                "listingVersionId": 2829346,
                "shortDescription": "stgJulySIsd",
                "tags": "stgJulySIkey",
                "tagLine": "stgJulySIHL",
                "status": "PUBLISHED",
                "icon": {
                    "name": "SI-icon 130x103.gif",
                    "contentURL": "https://partner.cloudmarketplace.oracle.com/partner/content?contentId=2829355",
                    "mimeType": "image/gif",
                    "fileExtension": "gif"
                },
                "products": [
                    {
                        "code": "ADMINCLOUD",
                        "name": "Admin Cloud"
                    }
                ],
                "industries": [
                    {
                        "code": "12C_STAGE_INDUSTRY",
                        "name": "12C Stage Industry1"
                    }
                ]
            }
        }
    ],
    "hasMore": true,
    "count": 2,
    "totalResults": 121,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services"
        },
        {
            "rel": "SELF",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services?limit=2"
        },
        {
            "rel": "NEXT",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services?offset=2&limit=2"
        }
    ]
}

Back to Top