Create service Related Docs
post
/appstore/publisher/v1/services/{listingVersionId}/relateddocs
Creates related documents for the an 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:
Show Source
object
-
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
Nested Schema : entity
Type:
object
Nested Schema : MediaType
Type:
Show Source
object
-
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
Nested Schema : MultiPart
Type:
Show Source
object
-
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
Nested Schema : Providers
Type:
object
Nested Schema : BodyPart
Type:
Show Source
object
-
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
Nested Schema : entity
Type:
object
Nested Schema : ParameterizedHeader
Type:
Show Source
object
-
parameters(optional):
object parameters
Additional Properties Allowed: additionalProperties
-
value(optional):
string
Nested Schema : FormDataBodyPart
Type:
Show Source
object
-
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
Nested Schema : entity
Type:
object
Nested Schema : FormDataContentDisposition
Type:
Show Source
object
-
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
Nested Schema : entity
Type:
object
Response
Supported Media Types
- application/json;qs=1
- application/xml;qs=.5
200 Response
Successful Operation
Nested Schema : Link
Type:
Show Source
object
-
href(optional):
string
-
rel(optional):
string
Allowed Values:
[ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]
400 Response
Bad Request
401 Response
Not Authorized
404 Response
Entity Not Found
500 Response
System Error
Examples
The following example uploads the related documents 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/relateddocs"
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": "related_docs_1", "description": "related_docs_1 create ", "fileName": "file1.pdf", "contentType": "USER_GUIDES", "sourceType": "INTERNAL" }, { "name": "related_docs_2", "description": "related_docs_2 create ", "fileName": "file2.pdf", "contentType": "WHITEPAPER", "sourceType": "INTERNAL" }, { "name": "e40540", "description": "e40540 - external doc - create ", "sourceURL": "https://docs.oracle.com/cd/E11882_01/server.112/e40540.pdf", "contentType":"USER_GUIDES", "sourceType": "EXTERNAL" } ]
HTTP Status Code:
200 OK
JSON Response:
{ "items": [ { "acknowledgement": { "entityId": "3451142", "name": "e40540" } }, { "acknowledgement": { "entityId": "3451144", "name": "related_docs_1" } }, { "acknowledgement": { "entityId": "3451146", "name": "related_docs_2" } } ], "hasMore": false, "count": 0, "totalResults": 0, "links": [ { "rel": "CANONICAL", "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services/9483951/relateddocs" }, { "rel": "SELF", "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services/9483951/relateddocs" } ] }Back to Top