REST API for Oracle Cloud Marketplace Publisher

Create Service Providers

post

/appstore/publisher/v1/services/{listingVersionId}/serviceproviders

Creates service provider for the a service with the specified ID.

Request

Supported Media Types

multipart/form-data

Path Parameters

listingVersionId: integer(int64)

Listing ID for which to upload related documents.

Upload the required resources and provide required information.

Root Schema : FormDataMultiPart

Type: object

Show Source

bodyParts(optional): array bodyParts
contentDisposition(optional): object ContentDisposition
entity(optional): object entity
fields(optional): object fields

Additional Properties Allowed: additionalProperties
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "fields":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/FormDataBodyPart"
                }
            }
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : bodyParts

Type: array

Show Source

Array of: object BodyPart

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

Nested Schema : ContentDisposition

Type: object

Show Source

creationDate(optional): string(date-time)
fileName(optional): string
modificationDate(optional): string(date-time)
parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
readDate(optional): string(date-time)
size(optional): integer(int64)
type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : fields

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/FormDataBodyPart"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : MediaType

Type: object

Show Source

parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
subtype(optional): string
type(optional): string
wildcardSubtype(optional): boolean

Default Value: false
wildcardType(optional): boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean",
            "default":false
        },
        "wildcardSubtype":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : MultiPart

Type: object

Show Source

bodyParts(optional): array bodyParts
contentDisposition(optional): object ContentDisposition
entity(optional): object entity
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : Providers

Type: object

Nested Schema : BodyPart

Type: object

Show Source

contentDisposition(optional): object ContentDisposition
entity(optional): object entity
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Nested Schema : ParameterizedHeader

Type: object

Show Source

parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object FormDataBodyPart

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

Nested Schema : FormDataBodyPart

Type: object

Show Source

contentDisposition(optional): object ContentDisposition
entity(optional): object entity
formDataContentDisposition(optional): object FormDataContentDisposition
headers(optional): object headers

Additional Properties Allowed: additionalProperties
mediaType(optional): object MediaType
name(optional): string
parameterizedHeaders(optional): object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent(optional): object MultiPart
providers(optional): object Providers
simple(optional): boolean

Default Value: false
value(optional): string

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "simple":{
            "type":"boolean",
            "default":false
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "formDataContentDisposition":{
            "$ref":"#/definitions/FormDataContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : FormDataContentDisposition

Type: object

Show Source

creationDate(optional): string(date-time)
fileName(optional): string
modificationDate(optional): string(date-time)
name(optional): string
parameters(optional): object parameters

Additional Properties Allowed: additionalProperties
readDate(optional): string(date-time)
size(optional): integer(int64)
type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

Nested Schema : bodyParts

Type: array

Show Source

Array of: object BodyPart

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

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object ParameterizedHeader

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

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/Acknowledgement"
            }
        },
        "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 acknowledgement

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

Nested Schema : link

Type: array

Show Source

Array of: object Link

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

Nested Schema : acknowledgement

Type: object

Show Source

contentURL(optional): string
entityId(optional): string
message(optional): string
name(optional): string
uri(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        }
    },
    "xml":{
        "name":"acknowledgement"
    }
}

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

404 Response

Entity Not Found

500 Response

System Error

Examples

The following example uploads the service provider document for an existing service belonging to a partner, by submitting a POST request on the REST resource using cURL.

cURL Example

curl -X POST -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW " -F "file=@file-path" -F "file=@file-path" -F "json=JSON-data-as-shown-in-following-example"  "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services/9483951/serviceproviders"

Request Header

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

Request Body

[form-data]

file: File Upload (file1.pdf)

file: File Upload (file2.pdf)

[
   {
      "name":"serviceProvider1",
      "description":"Create serviceprovider",
      "fileName":"doc.txt",
      "contentType":"CONSULTING_SERVICE",
      "sourceType":"INTERNAL"
   },
   {
      "name":"serviceProvider_Other",
      "description":"Create Serviceprovider External",
      "contentType":"OTHER",
      "sourceType":"EXTERNAL",
      "sourceURL":"https://docs.oracle.com/cd/E11882_01/server.112/e40540.pdf",
      "otherDescription":"OtherHeader"
   }
]

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
      "acknowledgement": {
        "entityId": "9483967",
        "name": "serviceProvider_Other"
      }
    },
    {
      "acknowledgement": {
        "entityId": "9483969",
        "name": "serviceProvider1"
      }
    }
  ],
  "hasMore": false,
  "count": 0,
  "totalResults": 0,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://den02mfs.us.oracle.com:7101/appstore/publisher/v1/services/9483951/serviceproviders"
    },
    {
      "rel": "SELF",
      "href": "https://den02mfs.us.oracle.com:7101/appstore/publisher/v1/services/9483951/serviceproviders"
    }
  ]
}