REST API for Oracle Cloud Marketplace Publisher

List of Supporting Document Types and Templates

get

/appstore/publisher/v1/supportingdoctypes

Get a list of available supporting document types and the query parameter "hastemplate" lets you to get only the supporting document types with templates.

Request

Query Parameters

hastemplate(optional): boolean

hastemplate accepts only true.And it filters only the type which has template.
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

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/SupportingDocType"
            }
        },
        "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 supportingdoctype

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

Nested Schema : link

Type: array

Show Source

Array of: object Link

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

Nested Schema : supportingdoctype

Type: object

Show Source

code(optional): string
description(optional): string
name(optional): string
templateUrl(optional): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "templateUrl":{
            "type":"string"
        }
    },
    "xml":{
        "name":"supportingdoctype"
    }
}

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

Examples

1.List of suporting document types

The following example returns a list of available supporting doc types, 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/suportingdoctypes?limit=3"

Request Header

X-Oracle-UserId: fname.lname@oracle.com
Authorization: Bearer Access-token

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
   "items":[
      {
         "supportingdoctypes":{
            "name":"Test use cases",
            "code":"TEST_USE_CASES",
            "description":"Test Plan Review Documentation",
            "templateUrl":"https://ocm-apis.cloud.oracle.com/partner/content?contentId=4178536"
         }
      },
      {
         "supportingdoctypes":{
            "name":"Deployment guide",
            "code":"DEPLOYMENT_GUIDE",
            "description":"Deployment guide"
         }
      },
      {
         "supportingdoctypes":{
            "name":"Other",
            "code":"OTHER",
            "description":"Other",
            "templateUrl":"https://ocm-apis.cloud.oracle.com/partner/content?contentId=5546870"
         }
      }
   ],
   "hasMore":false,
   "count":10,
   "totalResults":10,
   "links":[
      {
         "rel":"CANONICAL",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/supportingdoctypes"
      },
      {
         "rel":"SELF",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/supportingdoctypes?limit=3"
      },
      {
         "rel":"NEXT",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/supportingdoctypes?offset=3&limit=3"
      }
   ]
}

2.List of Templates

The following example returns a list of supporting doc types which has template, 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/supportingdoctypes?hastemplate=true&limit=3"

Request Header

X-Oracle-UserId: fname.lname@oracle.com
Authorization: Bearer Access-token

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
   "items":[
      {
         "supportingdoctypes":{
            "name":"Commerce Cloud",
            "code":"COMMERCE_CLOUD",
            "templateUrl":"https://ocm-apis.cloud.oracle.com/partner/content?contentId=7189741"
         }
      },
      {
         "supportingdoctypes":{
            "name":"Test technical document type",
            "code":"TEST_TECHNICAL_DOCUMENT_TYPE",
            "description":"jenatara doc type",
            "templateUrl":"https://ocm-apis.cloud.oracle.com/partner/content?contentId=8460359"
         }
      },
      {
         "supportingdoctypes":{
            "name":"Security Questionnaire",
            "code":"SECURITY_QUESTIONNAIRE",
            "templateUrl":"https://ocm-apis.cloud.oracle.com/partner/content?contentId=7189735"
         }
      }
   ],
   "hasMore":true,
   "count":3,
   "totalResults":9,
   "links":[
      {
         "rel":"CANONICAL",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/supportingdoctypes"
      },
      {
         "rel":"SELF",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/supportingdoctypes?hastemplate=true&limit=3"
      },
      {
         "rel":"NEXT",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/supportingdoctypes?hastemplate=true&offset=3&limit=3"
      }
   ]
}