getPosts
get
/ccadmin/v1/posts
Get Posts. Fetches Announcements based on the passed filters
Request
Supported Media Types
- application/json
Query Parameters
-
limit(optional): integer
Maximum size of the record set to be returned
-
offset(optional): integer
Numeric offset of the first Announcement post of the sorted result set.
-
q: string
The RQL query string.
-
sort(optional): string
A delimiter separated sort property name and sort direction.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPosts_response
Type:
Show Source
object
-
posts(optional):
array posts
The array of the Announcements.
-
totalPostsCount(optional):
integer
The total number of Announcements.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether a Announcement is active.
-
creationDate(optional):
string
The creation date of the Announcement.
-
id(optional):
string
The Announcement Post Id.
-
lastModifiedDate(optional):
string
The date on which the Announcement was last modified.
-
message(optional):
string
The Announcement Title text.
-
repositoryId(optional):
string
The repository id of the Announcement post.
-
type(optional):
string
The type of the Announcement item.
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/posts?q=type%20%3D%20%22announcementPost%22&offset=0&limit=250&sort=creationDate%3Adesc"
}
],
"totalPostsCount":2,
"posts":[
{
"lastModifiedDate":"2015-05-09T14:32:10.056Z",
"repositoryId":"200001",
"active":true,
"id":"200001",
"message":"Test Announcement message1.",
"creationDate":"2015-05-09T14:32:10.056Z",
"type":"announcementPost"
},
{
"lastModifiedDate":"2015-05-10T06:33:31.242Z",
"repositoryId":"100002",
"active":true,
"id":"100002",
"message":"Test Announcement message2.",
"creationDate":"2015-05-06T10:23:43.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|
|------------------|------------------|
|200201|Internal error occurred.|
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