Jump to

• Request
• Response
• Examples

Create Services

post

/appstore/publisher/v1/services

Create a new Service listing. Service goes through a state lifecycle.A newly created Service starts off in the "New" state. Service edits are allowed in this state.To publish the listing to the Marketplace, the service listing needs to be submitted for Approval.

Request

Supported Media Types

• application/xml
• application/json

Body ()

Root Schema : Listing

Type: object

Show Source

• additionalInfo(optional): object AdditionalInfo
• banner(optional): object Banner
• contactUs(optional): string
• customerStories(optional): array customerStories
• hasTemplate(optional): boolean
• icon(optional): object Icon
• industries(optional): array industries
• languages(optional): array languages
• lastUpdateDate(optional): string
• links(optional): array link
• listingContentLanguage(optional): object Item
• listingId(optional): integer(int64)
• listingVersionId(optional): integer(int64)
• locations(optional): array locations
• longDescription(optional): string
• name(optional): string
• numberOfTrainedProfessionals(optional): object numberOfTrainedProfessionals
  Additional Properties Allowed: additionalProperties
• opnLevel(optional): string
• opnTypeMembershipServiceDetailsLink(optional): string
• products(optional): array products
• progress(optional): object Progress
• relatedDocuments(optional): array relatedDocuments
• screenShots(optional): array screenShots
• serviceProviders(optional): array serviceProviders
• shortDescription(optional): string
• status(optional): string
• tagLine(optional): string
• tags(optional): string
• versionedListing(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "listingId":{
            "type":"integer",
            "format":"int64"
        },
        "listingVersionId":{
            "type":"integer",
            "format":"int64"
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Product"
            }
        },
        "shortDescription":{
            "type":"string"
        },
        "longDescription":{
            "type":"string"
        },
        "tags":{
            "type":"string"
        },
        "tagLine":{
            "type":"string"
        },
        "listingContentLanguage":{
            "$ref":"#/definitions/Item"
        },
        "hasTemplate":{
            "type":"boolean"
        },
        "languages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "status":{
            "type":"string"
        },
        "additionalInfo":{
            "$ref":"#/definitions/AdditionalInfo"
        },
        "icon":{
            "$ref":"#/definitions/Icon"
        },
        "banner":{
            "$ref":"#/definitions/Banner"
        },
        "relatedDocuments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RelatedDocs"
            }
        },
        "screenShots":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScreenShots"
            }
        },
        "industries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "customerStories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuccessStory"
            }
        },
        "serviceProviders":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceProvider"
            }
        },
        "numberOfTrainedProfessionals":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "locations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Location"
            }
        },
        "contactUs":{
            "type":"string"
        },
        "opnLevel":{
            "type":"string"
        },
        "opnTypeMembershipServiceDetailsLink":{
            "type":"string"
        },
        "versionedListing":{
            "type":"string"
        },
        "progress":{
            "$ref":"#/definitions/Progress"
        },
        "lastUpdateDate":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : AdditionalInfo

Type: object

Show Source

• vanityURL(optional): string
• vanityURLSuffix(optional): string

{
    "type":"object",
    "properties":{
        "vanityURLSuffix":{
            "type":"string"
        },
        "vanityURL":{
            "type":"string"
        }
    }
}

Nested Schema : Banner

Type: object

Show Source

• contentURL(optional): string
• fileExtension(optional): string
• filename(optional): string
• mimeType(optional): string
• name(optional): string
• resourceURL(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "filename":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        },
        "resourceURL":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "fileExtension":{
            "type":"string"
        }
    }
}

Nested Schema : customerStories

Type: array

Show Source

• Array of: object SuccessStory

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

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 : languages

Type: array

Show Source

• Array of: object Item

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Item

Type: object

Show Source

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

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

Nested Schema : locations

Type: array

Show Source

• Array of: object Location

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

Nested Schema : numberOfTrainedProfessionals

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : products

Type: array

Show Source

• Array of: object product

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

Nested Schema : Progress

Type: object

Show Source

• message(optional): string
• percentage(optional): string

{
    "type":"object",
    "properties":{
        "percentage":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Nested Schema : relatedDocuments

Type: array

Show Source

• Array of: object RelatedDocs

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

Nested Schema : screenShots

Type: array

Show Source

• Array of: object ScreenShots

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

Nested Schema : serviceProviders

Type: array

Show Source

• Array of: object ServiceProvider

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

Nested Schema : SuccessStory

Type: object

Show Source

• contentId(optional): integer(int64)
• contentType(optional): string
• contentURL(optional): string
• description(optional): string
• file(optional): object UploadFile
• fileExtension(optional): string
• fileName(optional): string
• listingContentId(optional): integer(int64)
• listingVersionId(optional): integer(int64)
• mimeType(optional): string
• name(optional): string
• resourceURL(optional): string
• sourceType(optional): string
• sourceURL(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contentType":{
            "type":"string"
        },
        "sourceType":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        },
        "sourceURL":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "file":{
            "$ref":"#/definitions/UploadFile"
        },
        "contentId":{
            "type":"integer",
            "format":"int64"
        },
        "resourceURL":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "fileExtension":{
            "type":"string"
        },
        "listingVersionId":{
            "type":"integer",
            "format":"int64"
        },
        "listingContentId":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : UploadFile

Type: object

Show Source

• contentId(optional): integer(int64)
• contentType(optional): integer(int64)
• extension(optional): string
• inputStream(optional): object InputStream
• length(optional): integer(int64)
• mimeType(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "inputStream":{
            "$ref":"#/definitions/InputStream"
        },
        "name":{
            "type":"string"
        },
        "contentId":{
            "type":"integer",
            "format":"int64"
        },
        "contentType":{
            "type":"integer",
            "format":"int64"
        },
        "length":{
            "type":"integer",
            "format":"int64"
        },
        "mimeType":{
            "type":"string"
        },
        "extension":{
            "type":"string"
        }
    }
}

Nested Schema : InputStream

Type: object

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
            }
        }
    }
}

Nested Schema : Location

Type: object

Show Source

• addressLocation(optional): string
• city(optional): string
• contactEmail(optional): string
• contactPhone(optional): string
• country(optional): object Item
• fax(optional): string
• id(optional): integer(int64)
• latitude(optional): string
• locationName(optional): string
• longitude(optional): string
• region(optional): object Item
• state(optional): string
• street(optional): string
• websiteUrl(optional): string
• zipCode(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "locationName":{
            "type":"string"
        },
        "addressLocation":{
            "type":"string"
        },
        "street":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "country":{
            "$ref":"#/definitions/Item"
        },
        "zipCode":{
            "type":"string"
        },
        "contactPhone":{
            "type":"string"
        },
        "contactEmail":{
            "type":"string"
        },
        "fax":{
            "type":"string"
        },
        "websiteUrl":{
            "type":"string"
        },
        "region":{
            "$ref":"#/definitions/Item"
        },
        "latitude":{
            "type":"string"
        },
        "longitude":{
            "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 : RelatedDocs

Type: object

Show Source

• contentId(optional): integer(int64)
• contentType(optional): string
• contentURL(optional): string
• description(optional): string
• file(optional): object UploadFile
• fileExtension(optional): string
• fileName(optional): string
• forOracleUsersOnly(optional): boolean
• mimeType(optional): string
• name(optional): string
• resourceURL(optional): string
• sourceType(optional): string
• sourceURL(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contentType":{
            "type":"string"
        },
        "sourceType":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        },
        "sourceURL":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "file":{
            "$ref":"#/definitions/UploadFile"
        },
        "contentId":{
            "type":"integer",
            "format":"int64"
        },
        "resourceURL":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "fileExtension":{
            "type":"string"
        },
        "forOracleUsersOnly":{
            "type":"boolean"
        }
    }
}

Nested Schema : ScreenShots

Type: object

Show Source

• contentURL(optional): string
• description(optional): string
• fileExtention(optional): string
• fileName(optional): string
• mimeType(optional): string
• name(optional): string
• resourceURL(optional): string
• sequence(optional): string
• sourceType(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "sourceType":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "resourceURL":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "fileExtention":{
            "type":"string"
        },
        "sequence":{
            "type":"string"
        }
    }
}

Nested Schema : ServiceProvider

Type: object

Show Source

• contentId(optional): integer(int64)
• contentType(optional): string
• contentURL(optional): string
• description(optional): string
• file(optional): object UploadFile
• fileExtension(optional): string
• fileName(optional): string
• listingVersionId(optional): integer(int64)
• mimeType(optional): string
• name(optional): string
• resourceURL(optional): string
• sourceType(optional): string
• sourceURL(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contentType":{
            "type":"string"
        },
        "sourceType":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        },
        "sourceURL":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "file":{
            "$ref":"#/definitions/UploadFile"
        },
        "contentId":{
            "type":"integer",
            "format":"int64"
        },
        "resourceURL":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "fileExtension":{
            "type":"string"
        },
        "listingVersionId":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top

Response

Supported Media Types

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

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 creates the service, by submitting a POST request on the REST resource using cURL.

cURL Example

curl -X POST -H "Authorization: Bearer Access-token"  -H "X-Oracle-UserId: partner-email" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/services"

Request Header

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

Request Body

{
    "name": "Myservice",
    "industries": [
        {
            "code": "HEALTHCARE"       
        }
    ],
    "tagLine": "My sample Tag line",
    "tags" : "myservice,test",
    "products": [
        {
            "code": "compute"            
        }
    ],
    "shortDescription": "really really short description",
    "longDescription": "really really long description",   
   "languages": [
        {
            "code": "cs_CZ"
        },
        {
            "code": "en_US"

        }
    ],
    "listingContentLanguage":{
        "code":"fr_FR",
        "name":"French"
    },
    "additionalInfo": {
        "vanityURL": "https://cloudmarketplace.oracle.com/marketplace/service/123456",
        "vanityURLSuffix": "123456"
    },
     "contactUs": "
Contact Us Info
"
     
   }
}

HTTP Status Code:

200 OK

JSON Response:

{
  "message": "Listing was created successfully.",
  "entityId": "9483951",
  "name": "Myservice"
}

Back to Top