Jump to

• Request
• Response
• Examples

Recommended Services for Listing

get

/appstore/publisher/v1/applications/{listingVersionId}/availableservices

Get a list of service integrators. Publishers can recommend particular service integrators for their application listings by adding them to each application listing as recommended services.

Request

Path Parameters

• listingVersionId: integer(int64)
  Unique identifier of the listing for which available services are required.

Query Parameters

• keyword(optional): string
  This is a filter. If specified, recommended services specific to the keyword are returned.
• 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).

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/RecommendedService"
            }
        },
        "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 recommendedService

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : recommendedService

Type: object

Show Source

• code(optional): string
• largeAppIconId(optional): integer(int64)
• links(optional): array link
• name(optional): string
• partnerName(optional): string
• rating(optional): number(double)
• reviewCount(optional): integer(int64)
• serviceId(optional): integer(int64)
• smallAppIconId(optional): integer(int64)
• tagLine(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "serviceId":{
            "type":"integer",
            "format":"int64"
        },
        "partnerName":{
            "type":"string"
        },
        "smallAppIconId":{
            "type":"integer",
            "format":"int64"
        },
        "largeAppIconId":{
            "type":"integer",
            "format":"int64"
        },
        "tagLine":{
            "type":"string"
        },
        "rating":{
            "type":"number",
            "format":"double"
        },
        "reviewCount":{
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"recommendedService"
    }
}

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

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 recommended services for their application listings, 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/applications/6186119/availableservices?keywords=crm&limit=1"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
      "recommendedService": {
        "name": "6eTechnologies Cloud Solution",
        "serviceId": 4974621,
        "partnerName": "6e Technologies"
      }
    }
  ],
  "hasMore": true,
  "count": 1,
  "totalResults": 425,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/6186119/availableservices"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/6186119/availableservices?keywords=crm&limit=1"
    },
    {
      "rel": "NEXT",
      "href": "https://ocm-apis.ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/6186119/availableservices?keywords=crm&offset=1&limit=1"
    }
  ]
}

Back to Top