Jump to

• Request
• Response
• Examples

Update terms

put

/appstore/publisher/v1/terms/{termsid}

Update the terms version in new status.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• termsid: integer(int64)
  Unique identifier of terms.

Body ()

Provide the body with required information.

Root Schema : TermsVersion

Type: object

Show Source

• contentDescription(optional): string
• contentId(optional): integer(int64)
• contentURL(optional): string
• lastUpdateDate(optional): string
• lastUpdatedBy(optional): string
• rawVersionName(optional): string
• status(optional): string
• termsVersionId(optional): integer(int64)
• versionName(optional): string

{
    "type":"object",
    "properties":{
        "termsVersionId":{
            "type":"integer",
            "format":"int64"
        },
        "contentId":{
            "type":"integer",
            "format":"int64"
        },
        "versionName":{
            "type":"string"
        },
        "rawVersionName":{
            "type":"string"
        },
        "contentDescription":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "lastUpdateDate":{
            "type":"string"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        }
    }
}

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 update the version in new status of passed terms id by submitting a PUT request on the REST resource using cURL.

cURL Example

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

Request Header

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

Request Body

{
  "versionName" : "Version 2",
  "contentDescription" : "Please read terms."
}

HTTP Status Code:

200 OK

JSON Response:

{
  "message": "Terms of Use was update successfully.",
  "entityId": "7934470"
}

Back to Top