Jump to

• Request
• Response

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 ()

Root Schema : createPost_request

Type: object

Show Source

• 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.

{
    "properties":{
        "active":{
            "description":"Specify default status for new Announcement. Possible values are 'true' or 'false'. Default value is 'true'",
            "type":"string"
        },
        "type":{
            "description":"Specify type of the post to create.",
            "type":"string"
        },
        "message":{
            "description":"Specify new Announcement message rich text String",
            "type":"string"
        }
    },
    "required":[
        "type",
        "message"
    ],
    "example":{
        "active":"true",
        "message":"New Announcent # 2",
        "type":"announcementPost"
    }
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createPost_response

Type: object

Show Source

• 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.

{
    "properties":{
        "lastModifiedDate":{
            "description":"The date on which the Announcement post was last modified.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository id of the Announcement post.",
            "type":"string"
        },
        "active":{
            "description":"Indicates whether a Announcement post is active.",
            "type":"boolean"
        },
        "id":{
            "description":"The Announcement post Id.",
            "type":"string"
        },
        "creationDate":{
            "description":"The creation date of the Announcement post.",
            "type":"string"
        },
        "message":{
            "description":"The Announcement post text.",
            "type":"string"
        },
        "type":{
            "description":"The type of the Announcement post item.",
            "type":"string"
        }
    }
}

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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top