createPost
post
/ccadmin/v1/posts
Create Post. Creates a new Announcement. While creating a new Announcement, type parameter should be set to 'announcementPost'.
Request
Supported Media Types
- application/json
Root Schema : createPost_request
Type:
Show Source
object
-
active(optional):
string
Specify default status for new Announcement. Possible values are 'true' or 'false'. Default value is 'true'
-
message:
string
Specify new Announcement message rich text String
-
type:
string
Specify type of the post to create.
Example:
{
"active":"true",
"message":"New Announcent # 2",
"type":"announcementPost"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createPost_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-04-28T09:32:18.335Z",
"repositoryId":"100002",
"active":true,
"links":[
{
"rel":"self",
"href":"http://admin.example.com:9080/ccadminui/v1/posts"
}
],
"id":"100002",
"message":"New Announcent # 2
\n",
"creationDate":"2015-04-28T09:32:18.335Z",
"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|
|------------------|------------------|
|200205|Invalid Announcement post type is passed.|
|200204|Post Type Input is null or empty.|
|200206|Internal error occured|
|200146|Post data is not available in input.|
|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