REST API for Oracle Commerce Cloud December 2017

handlePostUpdates

put

/ccadmin/v1/posts/{id}

Handle Post Updates. Updates message and status of given Announcement.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Updated Announcement Id.

Body Parameter

Root Schema : handlePostUpdates_request

Example


{
    "active":"true",
    "message":"Announcement updated.",
    "type":"announcementPost"
}

Properties

active: Type: string

Specify status for updating Announcement. Possible values are 'true' or 'false'.
message: Type: string

Required: true

Specify Updated Announcement message rich text String
type: Type: string

Required: true

Specify type of the post to update.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : handlePostUpdates_response

Properties

active: Type: boolean

Indicates whether a Announcement post is active.
creationDate: Type: string

The creation date of the Announcement post.
id: Type: string

The Announcement post Id.
lastModifiedDate: Type: string

The date on which the Announcement post was last modified.
message: Type: string

The Announcement post text.
repositoryId: Type: string

The repository id of the Announcement post.
type: Type: string

The type of the Announcement post item.

Example application/json


{
    "lastModifiedDate":"2015-05-10T18:45:40.820Z",
    "repositoryId":"200001",
    "active":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/posts/200001"
        }
    ],
    "id":"200001",
    "message":"Announcement updated.",
    "creationDate":"2015-05-09T14:32:10.000Z",
    "type":"announcementPost"
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |200210|Internal error occurred.| |200155|Internal error occurred.| |200160|Post {0} not found.| |200205|Post type is invalid.| |200204|Post Type Input is null or empty.| |200146|Input data is not passed.| |200203|Invalid Post active status.| |200159|Internal error occurred.| |200202|Post active status is null or empty.| |200147|Post message is null or empty.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "active": "true",
  "message": "Announcement updated.",
  "type": "announcementPost"
}

Sample Response Payload returned by endpoint:

{
  "lastModifiedDate": "2015-05-10T18:45:40.820Z",
  "repositoryId": "200001",
  "active": true,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/posts/200001"
  }],
  "id": "200001",
  "message": "Announcement updated.",
  "creationDate": "2015-05-09T14:32:10.000Z",
  "type": "announcementPost"
}