HomeREST APIBlog

Blog

Create and manage blogs and blog posts.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/blog/active

Get a list of active blogs

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
404

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PersonId": 0,
        "Summary": "string",
        "Active": true,
        "SectionId": 0,
        "PublicPrivate": true,
        "BlogType": 0,
        "IsSubscribed": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        }
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/inactive

Get a list of inactive blogs

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
404

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PersonId": 0,
        "Summary": "string",
        "Active": true,
        "SectionId": 0,
        "PublicPrivate": true,
        "BlogType": 0,
        "IsSubscribed": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        }
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/most-subscribed

List the most subscribed blogs.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PersonId": 0,
        "Summary": "string",
        "Active": true,
        "SectionId": 0,
        "PublicPrivate": true,
        "BlogType": 0,
        "IsSubscribed": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        }
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/{blogId}

Get a blog summary by blog id

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes

Responses

Status Body
200 See below
404

Response body

{
  "BlogId": 0,
  "PersonId": 0,
  "Summary": "string",
  "Active": true,
  "SectionId": 0,
  "PublicPrivate": true,
  "BlogType": 0,
  "IsSubscribed": true,
  "Owner": {
    "Id": 0,
    "AssetId": 0,
    "Name": "string"
  }
}
FieldType
BlogIdinteger (int32)
PersonIdinteger (int32)
Summarystring
Activeboolean
SectionIdinteger (int32)
PublicPrivateboolean
BlogTypeinteger (int32)
IsSubscribedboolean
Ownerobject

POST /api/blog

Adds a new blog post

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Request body

{
  "PostId": 0,
  "BlogId": 0,
  "Title": "string",
  "Body": "string",
  "AddedBy": 0,
  "DateAdded": "2024-01-01T00:00:00Z",
  "Active": true,
  "PersonId": 0,
  "Featured": true,
  "AssetId": 0,
  "BlogTemplateId": 0,
  "MinutesToRead": 0,
  "Summary": "string",
  "Likes": 0,
  "Comments": 0,
  "Shares": 0,
  "IsLiked": true
}
FieldType
PostIdinteger (int32)
BlogIdinteger (int32)
Titlestring
Bodystring
AddedByinteger (int32)
DateAddedstring (date-time)
Activeboolean
PersonIdinteger (int32)
Featuredboolean
AssetIdinteger (int32)
BlogTemplateIdinteger (int32)
MinutesToReadinteger (int32)
Summarystring
Likesinteger (int32)
Commentsinteger (int32)
Sharesinteger (int32)
IsLikedboolean

Responses

Status Body
200 See below
404
500

Response body

{
  "Title": "string",
  "Context": 0,
  "Description": "string",
  "StatusCode": "Continue",
  "ErrorCollection": {},
  "HasErrors": true,
  "TotalResults": 0
}
FieldType
Titlestring
Contextinteger (int32)
Descriptionstring
StatusCodestring
ErrorCollectionobject
HasErrorsboolean
TotalResultsinteger (int32)

PUT /api/blog/{blogId}/activate

Activate the blog.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes

Request body

{
  "Value": true
}
FieldType
Valueboolean

Responses

Status Body
200 boolean
404

GET /api/blog/blog-post/featured

Get a list of featured blog posts

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
404
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PostId": 0,
        "TemplateId": 0,
        "Title": "string",
        "Summary": "string",
        "Body": "string",
        "AssetId": 0,
        "DateAdded": "2024-01-01T00:00:00Z",
        "Stats": {
          "Likes": 0,
          "Comments": 0,
          "Shares": 0
        },
        "MinutesToRead": 0,
        "IsFeatured": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        },
        "IsLiked": true,
        "IsPublished": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/blog-post/latest

List the latest blog posts.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PostId": 0,
        "TemplateId": 0,
        "Title": "string",
        "Summary": "string",
        "Body": "string",
        "AssetId": 0,
        "DateAdded": "2024-01-01T00:00:00Z",
        "Stats": {
          "Likes": 0,
          "Comments": 0,
          "Shares": 0
        },
        "MinutesToRead": 0,
        "IsFeatured": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        },
        "IsLiked": true,
        "IsPublished": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/blog-post/popular

List the popular blog posts.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PostId": 0,
        "TemplateId": 0,
        "Title": "string",
        "Summary": "string",
        "Body": "string",
        "AssetId": 0,
        "DateAdded": "2024-01-01T00:00:00Z",
        "Stats": {
          "Likes": 0,
          "Comments": 0,
          "Shares": 0
        },
        "MinutesToRead": 0,
        "IsFeatured": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        },
        "IsLiked": true,
        "IsPublished": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/blog-post/subscribed

List the subscribed blog posts.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PostId": 0,
        "TemplateId": 0,
        "Title": "string",
        "Summary": "string",
        "Body": "string",
        "AssetId": 0,
        "DateAdded": "2024-01-01T00:00:00Z",
        "Stats": {
          "Likes": 0,
          "Comments": 0,
          "Shares": 0
        },
        "MinutesToRead": 0,
        "IsFeatured": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        },
        "IsLiked": true,
        "IsPublished": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/blog/blog-post/{blogPostId}

Get a blog post by it's ID

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogPostId path integer (int32) Yes

Responses

Status Body
200 See below
404
500

Response body

{
  "BlogId": 0,
  "PostId": 0,
  "TemplateId": 0,
  "Title": "string",
  "Summary": "string",
  "Body": "string",
  "AssetId": 0,
  "DateAdded": "2024-01-01T00:00:00Z",
  "Stats": {
    "Likes": 0,
    "Comments": 0,
    "Shares": 0
  },
  "MinutesToRead": 0,
  "IsFeatured": true,
  "Owner": {
    "Id": 0,
    "AssetId": 0,
    "Name": "string"
  },
  "IsLiked": true,
  "IsPublished": true
}
FieldType
BlogIdinteger (int32)
PostIdinteger (int32)
TemplateIdinteger (int32)
Titlestring
Summarystring
Bodystring
AssetIdinteger (int32)
DateAddedstring (date-time)
Statsobject
MinutesToReadinteger (int32)
IsFeaturedboolean
Ownerobject
IsLikedboolean
IsPublishedboolean

GET /api/blog/{blogId}/blog-post

Get a list of blog posts by Blog Id

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
404

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PostId": 0,
        "TemplateId": 0,
        "Title": "string",
        "Summary": "string",
        "Body": "string",
        "AssetId": 0,
        "DateAdded": "2024-01-01T00:00:00Z",
        "Stats": {
          "Likes": 0,
          "Comments": 0,
          "Shares": 0
        },
        "MinutesToRead": 0,
        "IsFeatured": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        },
        "IsLiked": true,
        "IsPublished": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

GET /api/person/{id}/blog-post

List blog posts.

Parameters

Name In Type Required Description
id path integer (int32) Yes
includeOwner query boolean No
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
500

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "BlogId": 0,
        "PostId": 0,
        "TemplateId": 0,
        "Title": "string",
        "Summary": "string",
        "Body": "string",
        "AssetId": 0,
        "DateAdded": "2024-01-01T00:00:00Z",
        "Stats": {
          "Likes": 0,
          "Comments": 0,
          "Shares": 0
        },
        "MinutesToRead": 0,
        "IsFeatured": true,
        "Owner": {
          "Id": 0,
          "AssetId": 0,
          "Name": "string"
        },
        "IsLiked": true,
        "IsPublished": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

POST /api/blog/{blogId}/blog-post/date

Create a date.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
offset query integer (int32) No
limit query integer (int32) No

Request body

{
  "PublishedFromDate": "2024-01-01T00:00:00Z",
  "PublishedToDate": "2024-01-01T00:00:00Z"
}
FieldType
PublishedFromDatestring (date-time)
PublishedToDatestring (date-time)

Responses

Status Body
200 See below
500

Response body

{
  "StatusCode": "Continue",
  "Result": {
    "PostId": 0,
    "BlogId": 0,
    "Title": "string",
    "Body": "string",
    "AddedBy": 0,
    "DateAdded": "2024-01-01T00:00:00Z",
    "Active": true,
    "PersonId": 0,
    "Featured": true,
    "AssetId": 0,
    "BlogTemplateId": 0,
    "MinutesToRead": 0,
    "Summary": "string",
    "Likes": 0,
    "Comments": 0,
    "Shares": 0,
    "IsLiked": true
  },
  "TotalResults": 0,
  "Page": 0,
  "Size": 0
}
FieldType
StatusCodestring
Resultobject
TotalResultsinteger (int32)
Pageinteger (int32)
Sizeinteger (int32)

POST /api/blog/{blogId}/blog-post/{blogPostId}/like

Adds a like reaction to the specified blog post

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
blogPostId path integer (int32) Yes

Responses

Status Body
200
400

POST /api/blog/{blogId}/blog-post/{blogPostId}/share

Shares a blog post

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
blogPostId path integer (int32) Yes

Request body

"string"

No documented fields.

Responses

Status Body
200
400

PUT /api/blog/{blogId}/blog-post/{blogPostId}

Update an existing blog post

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path string Yes
blogPostId path string Yes

Request body

{
  "PostId": 0,
  "BlogId": 0,
  "Title": "string",
  "Body": "string",
  "AddedBy": 0,
  "DateAdded": "2024-01-01T00:00:00Z",
  "Active": true,
  "PersonId": 0,
  "Featured": true,
  "AssetId": 0,
  "BlogTemplateId": 0,
  "MinutesToRead": 0,
  "Summary": "string",
  "Likes": 0,
  "Comments": 0,
  "Shares": 0,
  "IsLiked": true
}
FieldType
PostIdinteger (int32)
BlogIdinteger (int32)
Titlestring
Bodystring
AddedByinteger (int32)
DateAddedstring (date-time)
Activeboolean
PersonIdinteger (int32)
Featuredboolean
AssetIdinteger (int32)
BlogTemplateIdinteger (int32)
MinutesToReadinteger (int32)
Summarystring
Likesinteger (int32)
Commentsinteger (int32)
Sharesinteger (int32)
IsLikedboolean

Responses

Status Body
200
404
500

DELETE /api/blog/{blogId}/blog-post/{blogPostId}

Delete a blog post by post Id

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogPostId path integer (int32) Yes
blogId path string Yes

Responses

Status Body
200 See below
404

Response body

{
  "Title": "string",
  "Context": true,
  "Description": "string",
  "StatusCode": "Continue",
  "ErrorCollection": {},
  "HasErrors": true,
  "TotalResults": 0
}
FieldType
Titlestring
Contextboolean
Descriptionstring
StatusCodestring
ErrorCollectionobject
HasErrorsboolean
TotalResultsinteger (int32)

DELETE /api/blog/{blogId}/blog-post/{blogPostId}/like

Removes a like reaction for the specified blog post

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
blogPostId path integer (int32) Yes

Responses

Status Body
200
400

GET /api/blog/person/blog-configuration

Gets the initialization settings for the blog Allows user with no access to blogs to access as required for frontend functionality in person profile and people directory

Responses

Status Body
200 See below
404
500

Response body

{
  "StatusCode": "Continue",
  "Item": {
    "HasBlogPosts": true,
    "HasBlogPublishPermission": true,
    "HasBlogPermission": true,
    "BlogId": 0,
    "IsDisabled": true,
    "VideoUploadEnabled": true,
    "MediaEmbedPluginEnabled": true,
    "ShowFollowUnfollow": true,
    "DisplayInteractRecommendsOnPersonalBlogs": true
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Itemobject
ErrorMessagesarray of string

GET /api/blog/{blogId}/person/{personId}/is-subscribed

Check whether the person is subscribed.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
personId path integer (int32) Yes

Responses

Status Body
200 boolean
500

POST /api/blog/person/{personId}/blog-activate

Activates the blog for the user

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
personId path integer (int32) Yes

Responses

Status Body
200 integer (int32)
404

POST /api/blog/{blogId}/person/{personId}/subscribe

Subscribe to the person.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
personId path integer (int32) Yes

Responses

Status Body
200 boolean
500

POST /api/blog/{blogId}/person/{personId}/unsubscribe

Unsubscribe from the person.

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
blogId path integer (int32) Yes
personId path integer (int32) Yes

Responses

Status Body
200 boolean
500

GET /api/blog/post/{postId}

Get a blogId by post id

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
postId path integer (int32) Yes

Responses

Status Body
200 See below
404

Response body

{
  "Title": "string",
  "Context": 0,
  "Description": "string",
  "StatusCode": "Continue",
  "ErrorCollection": {},
  "HasErrors": true,
  "TotalResults": 0
}
FieldType
Titlestring
Contextinteger (int32)
Descriptionstring
StatusCodestring
ErrorCollectionobject
HasErrorsboolean
TotalResultsinteger (int32)

GET /api/blog/post/{postId}/like

Get a list of people who liked the blog post

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
postId path integer (int32) Yes
offset query integer (int32) No
limit query integer (int32) No

Responses

Status Body
200 See below
404

Response body

{
  "StatusCode": "Continue",
  "Page": {
    "Items": [
      {
        "Id": 0,
        "FullName": "string",
        "AssetId": 0,
        "JobTitle": "string",
        "Department": "string",
        "IsFollowing": true,
        "IsActive": true
      }
    ],
    "HasResults": true,
    "Info": {
      "TotalResults": 0,
      "Limit": 0,
      "Offset": 0
    }
  },
  "ErrorMessages": [
    "string"
  ]
}
FieldType
StatusCodestring
Pageobject
ErrorMessagesarray of string

PUT /api/blog/post/{postId}/active

Update the active (published) value of a blog post

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
postId path integer (int32) Yes

Request body

true

No documented fields.

Responses

Status Body
200 boolean
404

PUT /api/blog/post/{postId}/featured

Update the featured value of a blog post

🔒Access — Requires the ADMIN_CONTENT_BLOGS permission

Parameters

Name In Type Required Description
postId path integer (int32) Yes

Request body

{
  "Value": true
}
FieldType
Valueboolean

Responses

Status Body
200 See below
404

Response body

{
  "Title": "string",
  "Context": true,
  "Description": "string",
  "StatusCode": "Continue",
  "ErrorCollection": {},
  "HasErrors": true,
  "TotalResults": 0
}
FieldType
Titlestring
Contextboolean
Descriptionstring
StatusCodestring
ErrorCollectionobject
HasErrorsboolean
TotalResultsinteger (int32)
Section: REST API