Oracle Commerce Cloud October 2017

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

Body Parameter

Root Schema : createPost_request

Example


{
    "active":"true",
    "message":"New Announcent # 2",
    "type":"announcementPost"
}

Properties

active: Type: string

Specify default status for new Announcement. Possible values are 'true' or 'false'. Default value is 'true'
message: Type: string

Required: true

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

Required: true

Specify type of the post to create.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createPost_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-04-28T09:32:18.335Z",
    "repositoryId":"100002",
    "active":true,
    "links":[
        {
            "rel":"self",
            "href":"http://some.machine.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.|

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

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

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": "New Announcent # 2",
  "type": "announcementPost"
}

Sample Response Payload returned by endpoint:

{
  "lastModifiedDate": "2015-04-28T09:32:18.335Z",
  "repositoryId": "100002",
  "active": true,
  "links": [{
    "rel": "self",
    "href": "http://some.machine.example.com:9080/ccadminui/v1/posts"
  }],
  "id": "100002",
  "message": "<p>New Announcent # 2<\/p>\n",
  "creationDate": "2015-04-28T09:32:18.335Z",
  "type": "announcementPost"
}