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: string
Updated Announcement Id.
Root Schema : handlePostUpdates_request
Type:
Show Source
object
-
active(optional):
string
Specify status for updating Announcement. Possible values are 'true' or 'false'.
-
message:
string
Specify Updated Announcement message rich text String
-
type:
string
Specify type of the post to update.
Example:
{
"active":"true",
"message":"Announcement updated.",
"type":"announcementPost"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : handlePostUpdates_response
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether a Announcement post is active.
-
creationDate(optional):
string
The creation date of the Announcement post.
-
id(optional):
string
The Announcement post Id.
-
lastModifiedDate(optional):
string
The date on which the Announcement post was last modified.
-
message(optional):
string
The Announcement post text.
-
repositoryId(optional):
string
The repository id of the Announcement post.
-
type(optional):
string
The type of the Announcement post item.
Example Response (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.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code