Jump to

• Request
• Response
• Examples

Company Profile Upgrade

patch

/appstore/publisher/v1/profile

Upgrade the profile from devloper to publisher.

Request

Supported Media Types

• application/xml
• application/json

Body ()

Provide the body with required information.

Root Schema : CompanyProfile

Type: object

Show Source

• action(optional): string
• city(optional): string
• contactDetails(optional): object ContactDetails
• country(optional): object Item
• description(optional): string
• domicile(optional): string
• founded(optional): string
• isMspEnabled(optional): boolean
• logoURL(optional): string
• name(optional): string
• opnLevel(optional): object Item
• opnNumber(optional): string
• packageConfigurations(optional): object PackageConfigurations
• partnerDetails(optional): object PartnerDetails
• partnerMode(optional): object Item
• partnerPortalOptions(optional): object PartnerPortalOptions
• products(optional): array products
• publisherType(optional): array publisherType
• size(optional): object Item
• state(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "opnNumber":{
            "type":"string"
        },
        "opnLevel":{
            "$ref":"#/definitions/Item"
        },
        "publisherType":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Item"
            }
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Product"
            }
        },
        "logoURL":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "size":{
            "$ref":"#/definitions/Item"
        },
        "founded":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "country":{
            "$ref":"#/definitions/Item"
        },
        "domicile":{
            "type":"string"
        },
        "contactDetails":{
            "$ref":"#/definitions/ContactDetails"
        },
        "action":{
            "type":"string"
        },
        "partnerMode":{
            "$ref":"#/definitions/Item"
        },
        "partnerPortalOptions":{
            "$ref":"#/definitions/PartnerPortalOptions"
        },
        "packageConfigurations":{
            "$ref":"#/definitions/PackageConfigurations"
        },
        "partnerDetails":{
            "$ref":"#/definitions/PartnerDetails"
        },
        "isMspEnabled":{
            "type":"boolean"
        }
    }
}

Nested Schema : ContactDetails

Type: object

Show Source

• additionalDetails(optional): object AdditionalContactInfo
• contactEmail(optional): string
• notificationEmail(optional): string
• phone(optional): string
• website(optional): string

{
    "type":"object",
    "properties":{
        "website":{
            "type":"string"
        },
        "phone":{
            "type":"string"
        },
        "contactEmail":{
            "type":"string"
        },
        "notificationEmail":{
            "type":"string"
        },
        "additionalDetails":{
            "$ref":"#/definitions/AdditionalContactInfo"
        }
    }
}

Nested Schema : Item

Type: object

Show Source

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

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

Nested Schema : PackageConfigurations

Type: object

Show Source

• enableDownloadablePackage(optional): boolean
  Default Value: false
• enablePackageCreation(optional): boolean
  Default Value: false
• pkgTestInstallMandatory(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "enableDownloadablePackage":{
            "type":"boolean",
            "default":false
        },
        "enablePackageCreation":{
            "type":"boolean",
            "default":false
        },
        "pkgTestInstallMandatory":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : PartnerDetails

Type: object

Show Source

• opnDesignation(optional): string
• opnMembershipType(optional): object Item
• opnMemberType(optional): object Item

{
    "type":"object",
    "properties":{
        "opnMemberType":{
            "$ref":"#/definitions/Item"
        },
        "opnMembershipType":{
            "$ref":"#/definitions/Item"
        },
        "opnDesignation":{
            "type":"string"
        }
    }
}

Nested Schema : PartnerPortalOptions

Type: object

Show Source

• enableAutoApproval(optional): boolean
  Default Value: false
• enableAutoPublish(optional): boolean
  Default Value: false
• enableDevInstanceRequest(optional): boolean
  Default Value: false
• enablePrivateListing(optional): boolean
  Default Value: false
• enableReport(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "enableReport":{
            "type":"boolean",
            "default":false
        },
        "enablePrivateListing":{
            "type":"boolean",
            "default":false
        },
        "enableDevInstanceRequest":{
            "type":"boolean",
            "default":false
        },
        "enableAutoApproval":{
            "type":"boolean",
            "default":false
        },
        "enableAutoPublish":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : products

Type: array

Show Source

• Array of: object product

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

Nested Schema : publisherType

Type: array

Show Source

• Array of: object Item

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

Nested Schema : AdditionalContactInfo

Type: object

Show Source

• facebookURL(optional): string
• linkedInURL(optional): string
• twitterURL(optional): string

{
    "type":"object",
    "properties":{
        "facebookURL":{
            "type":"string"
        },
        "twitterURL":{
            "type":"string"
        },
        "linkedInURL":{
            "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"
    }
}

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

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

400 Response

Invalid Parameter Value/Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example upgrades company profile from developer to publisher by submitting a PATCH request on the REST resource using cURL.

cURL Example

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

Request Header

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

Request Body

{
  "name": "TEST Inc.",
  "opnNumber": "4-555003140938",
  "description": "Testing description from REST API",
  "size": {
    "code": "ONE_TO_FIFTY"
  },
  "founded": "2016",
  "city": "London",
  "state": "Westminster",
  "country": {
    "code": "United Kingdom"
  },
  "contactDetails": {
  "website": "https://www.test.com",
  "phone": "0044-744-040-8543",
  "contactEmail": "[e-mail]",
  "notificationEmail": "[e-mail]",
  "additionalDetails": {
      "twitterURL": "https://twitter.com/test",
      "facebookURL": "https://www.facebook.com/test",
      "linkedInURL": "https://www.linkedin.com/test"
   }
  },
  "action" : "UPGRADE"
}

HTTP Status Code:

200 OK

JSON Response:

{
  "message": "Company profile upgrade request successfully created"
}

Back to Top