Service Blog
- Last UpdatedNov 10, 2022
- 1 minute read
APIs for reading entries posted on the service blog.
List By Page
Returns blog entries ordered by time posted.
Request
GET /api/v1/ServiceBlog/Entries
?skip={skip}&count={count}&includeDeleted={includeDeleted}
Parameters
[optional] integer skip
Number of blogs to skip for paging purposes.[optional] integer count
Number of blogs to count after skip for paging purposes.[optional] boolean includeDeleted
Whether deleted entries are included in return.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | ServiceBlogEntry[] | An array of ServiceBlogEntry objects. |
Example response body
200 Response (ServiceBlogEntry[])
[
{
"IsDeleted": true,
"Id": 0,
"TimePosted": "2019-08-24T14:15:22Z",
"Title": "string",
"Content": "string",
"Author": "string"
}
]
Get Entry By Id
Returns a blog entry specified by identifier.
Request
GET /api/v1/ServiceBlog/Entries/{id}
Parameters
string id
Service blog identifier.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | ServiceBlogEntry | The ServiceBlogEntry with Id id. |
Example response body
200 Response (ServiceBlogEntry)
{
"IsDeleted": true,
"Id": 0,
"TimePosted": "2019-08-24T14:15:22Z",
"Title": "string",
"Content": "string",
"Author": "string"
}
Definitions
ServiceBlogEntry
Representation of a server-side database interpretation of a blog.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| IsDeleted | boolean | false | false | Value indicating whether boolean flag that represents the blog entry's soft delete status. |
| Id | int32 | false | false | Identifier for the blog entry. |
| TimePosted | date-time | false | false | Recorded timestamp managed by the blog editor. |
| Title | string | false | true | Title of the blog entry. |
| Content | string | false | true | Content body of the blog entry. This is where the details of the blog entry are located. |
| Author | string | false | true | Author who created the blog entry. |
{
"IsDeleted": true,
"Id": 0,
"TimePosted": "2019-08-24T14:15:22Z",
"Title": "string",
"Content": "string",
"Author": "string"
}