POST api/v1.0/Blogs/CreateBlog
Create a new Blog.
Request Information
URI Parameters
None.
Body Parameters
Title: string, Body: string, CommunityKey: (Optional) To be supplied if the Blog should be associated with a specific Community., ViewPermissions: (Optional, Defaults to 'public') Can be one of - 'public', 'authenticated', 'members_only', 'my_contacts'., CommentPermissions: (Optional, Defaults to 'authenticated') Can be one of - 'authenticated', 'members_only', 'my_contacts', 'no_comments'., PublishImmediately: (Optional, Defaults to True) If False, the Blog will be Saved, but not Published.
CreateBlogRequestName | Description | Type | Additional information |
---|---|---|---|
Title | string |
None. |
|
Body | string |
None. |
|
CommunityKey | globally unique identifier |
None. |
|
ViewPermissions | string |
None. |
|
CommentPermissions | string |
None. |
|
PublishImmediately | boolean |
None. |
Request Formats
application/json, text/json
{ "Title": "sample string 1", "Body": "sample string 2", "CommunityKey": "5441d4ff-d526-49c7-b810-6b05133c68e6", "ViewPermissions": "sample string 3", "CommentPermissions": "sample string 4", "PublishImmediately": true }
application/xml, text/xml
<CreateBlogRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <Body>sample string 2</Body> <CommentPermissions>sample string 4</CommentPermissions> <CommunityKey>5441d4ff-d526-49c7-b810-6b05133c68e6</CommunityKey> <PublishImmediately>true</PublishImmediately> <Title>sample string 1</Title> <ViewPermissions>sample string 3</ViewPermissions> </CreateBlogRequest>
Response Information
Resource Description
The newly created Blog.
BlogName | Description | Type | Additional information |
---|---|---|---|
Author | ContactConcise |
None. |
|
BlogKey | globally unique identifier |
None. |
|
Community | Community |
None. |
|
CreatedOn | date |
None. |
|
BlogText | string |
None. |
|
IsPublished | boolean |
None. |
|
LinkToReadBlog | string |
None. |
|
PublishedOn | date |
None. |
|
BlogTitle | string |
None. |
|
UpdatedOn | date |
None. |
|
ViewPermission | string |
None. |
|
CommentPermission | string |
None. |
|
ViewCount | integer |
None. |
|
RatingCount | integer |
None. |
|
CommentCount | integer |
None. |
|
Comments | Collection of Comment |
None. |
|
RelatedLinks | Collection of RelatedLink |
None. |
|
ContactsWhoRecommend | Collection of ContactConcise |
None. |
|
AuthenticatedUserRecommends | boolean |
None. |
|
AuthenticatedUserFavorite | boolean |
None. |
Response Formats
application/json, text/json
{ "Author": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" }, "BlogKey": "b743e2a7-639c-4896-8c7f-6c3ad7c97052", "Community": null, "CreatedOn": "2024-10-08T05:17:05.5216419Z", "BlogText": "sample string 3", "IsPublished": true, "LinkToReadBlog": "sample string 5", "PublishedOn": "2024-10-08T05:17:05.5216419Z", "BlogTitle": "sample string 7", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "ViewPermission": "sample string 9", "CommentPermission": "sample string 10", "ViewCount": 11, "RatingCount": 12, "CommentCount": 13, "Comments": [ { "CommentKey": "13c3074e-8edd-411c-99f2-82590aa23188", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" }, "IsOfficial": true, "ItemKey": "1a9d39db-38b1-44a6-b243-e8367c0a6e5c", "CreatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedOn": "2024-10-08T05:17:05.5216419Z" }, { "CommentKey": "13c3074e-8edd-411c-99f2-82590aa23188", "CommentBody": "sample string 2", "CommentAuthor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" }, "IsOfficial": true, "ItemKey": "1a9d39db-38b1-44a6-b243-e8367c0a6e5c", "CreatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedOn": "2024-10-08T05:17:05.5216419Z" } ], "RelatedLinks": [ { "RelatedLinkKey": "d50cdd0e-2435-4c3e-9b71-6395a31fb5ea", "ItemKey": "5efe84d7-dcb1-49d6-9590-ed0ee00b88f7", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" }, "CreatedOn": "2024-10-08T05:17:05.5216419Z" }, { "RelatedLinkKey": "d50cdd0e-2435-4c3e-9b71-6395a31fb5ea", "ItemKey": "5efe84d7-dcb1-49d6-9590-ed0ee00b88f7", "Url": "sample string 3", "Contributor": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" }, "CreatedOn": "2024-10-08T05:17:05.5216419Z" } ], "ContactsWhoRecommend": [ { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" }, { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "42ad1775-1dfd-4ace-81e1-5d645c8510e7", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2024-10-08T05:17:05.5216419Z", "UpdatedByContactKey": "12243a82-d427-410d-bc19-302fc3678de8", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2024-10-08T05:17:05.5216419Z" } ], "AuthenticatedUserRecommends": true, "AuthenticatedUserFavorite": true }
application/xml
Sample not available.
text/xml
Sample not available.