POST api/v2.0/Question/Post
Submit a new question
Request Information
URI Parameters
None.
Body Parameters
New question to submit
NewQuestionRequestName | Description | Type | Additional information |
---|---|---|---|
Title |
The subject/title of the question |
string |
Required |
Content |
The body/description of the question |
string |
Required |
ContainerKey |
The communityKey that the question should be contained in |
globally unique identifier |
None. |
DocumentKey |
The document key of the resource library entry containing files to attach to this question. This field is optional. |
globally unique identifier |
None. |
IsAnonymous |
Whether or not you want to post the question as an anonymous user |
boolean |
None. |
TopicTagKeys |
If the community that the question is being asked in is a topic community, then pass one or more valid Topic tags to apply to the question. You can get the set of valid tag keys from the Community Model TopicTagGroups property. |
Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
{ "Title": "sample string 1", "Content": "sample string 2", "ContainerKey": "998acb27-9545-4dfe-9c47-90bc8acdaecf", "DocumentKey": "4061f601-5ade-4bac-8e4f-fc9d7f5deddd", "IsAnonymous": true, "TopicTagKeys": [ "376e2e03-f173-417d-92da-a11ccc550848", "d72408c1-37f3-4f4e-b392-80182d6abba8" ] }
application/xml, text/xml
<NewQuestionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Request"> <_x003C_ContainerKey_x003E_k__BackingField>998acb27-9545-4dfe-9c47-90bc8acdaecf</_x003C_ContainerKey_x003E_k__BackingField> <_x003C_Content_x003E_k__BackingField>sample string 2</_x003C_Content_x003E_k__BackingField> <_x003C_DocumentKey_x003E_k__BackingField>4061f601-5ade-4bac-8e4f-fc9d7f5deddd</_x003C_DocumentKey_x003E_k__BackingField> <_x003C_IsAnonymous_x003E_k__BackingField>true</_x003C_IsAnonymous_x003E_k__BackingField> <_x003C_Title_x003E_k__BackingField>sample string 1</_x003C_Title_x003E_k__BackingField> <_x003C_TopicTagKeys_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>376e2e03-f173-417d-92da-a11ccc550848</d2p1:guid> <d2p1:guid>d72408c1-37f3-4f4e-b392-80182d6abba8</d2p1:guid> </_x003C_TopicTagKeys_x003E_k__BackingField> </NewQuestionRequest>
Response Information
Resource Description
Submitted question
QuestionName | Description | Type | Additional information |
---|---|---|---|
QuestionKey |
Unique identifier of the question |
globally unique identifier |
None. |
Title |
Plaintext Title of the question |
string |
None. |
HasBestAnswer |
True if a best answer has been designated for this question. False if no best answer has been designated for this question. |
boolean |
None. |
HasReplied |
True if the current user has created an answer to the question. |
boolean |
None. |
BestAnswerOn |
DateTime in UTC when best answer for this question was designated. Omitted when no best answer has been designated. |
date |
None. |
IsThreadClosed |
True if thread is closed and any subsequent answers submitted are rejected. False if thread is available to receive answers. |
boolean |
None. |
ThreadClosedOn |
DateTime in UTC when thread was closed to any further submitted answers. Omitted when thread is open. |
date |
None. |
ThreadClosedBy |
DateTime in UTC when this thread was closed to any further submitted answers. Omitted when thread is open. |
ContactConcise |
None. |
IsFollowing |
Indicates whether the current user is following the question thread. |
boolean |
None. |
Content |
HTML Body of the item |
string |
None. |
PublishedOn |
DateTime in UTC when the item was published |
date |
None. |
Community |
Community to which the item was published |
Community |
None. |
Author |
Author to which the item should be attributed |
ContactConcise |
None. |
Attachments |
Attachments included with this item. |
Collection of DocumentAttachment |
None. |
IsAnonymous |
True if author attribution is to indicate item was submitted anonymously, False if the author attribution indicates who authored the item. Omitted when item is attributed to its author. |
boolean |
None. |
Creator |
When item is posted anonymously, indicates the actual author of the item. Omitted when item is attributed to its author. |
ContactConcise |
None. |
EditedOn |
DateTime in UTC when the item was last edited. Omitted if item has not been edited. |
date |
None. |
EditedBy |
Indicates contact that last edited this item. Omitted if item has not been edited. |
ContactConcise |
None. |
IsModerated |
Indicates whether the item is currently moderated. Omitted when the item is not in moderation. |
boolean |
None. |
RecommendationCount |
Number of contacts who have recommended this item. |
integer |
None. |
HasRecommended |
If the current contact has recommended this item |
boolean |
None. |
Tags |
All of the tags indexed for the item. This includes user tags and admin based tags. |
Collection of ItemTagResponse |
None. |
UserPermissions |
Permissions for actions the current user can take on the item. |
Collection of string |
None. |
Response Formats
application/json, text/json
{ "QuestionKey": "7c24e345-2bd8-4258-b871-7349ff4e191a", "Title": "sample string 2", "HasBestAnswer": true, "HasReplied": true, "BestAnswerOn": "2024-09-07T22:26:52.9580029Z", "IsThreadClosed": true, "ThreadClosedOn": "2024-09-07T22:26:52.9580029Z", "ThreadClosedBy": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "8efeef43-c1d5-488c-95a9-ee6e91e8301d", "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-09-07T22:26:52.9580029Z", "UpdatedByContactKey": "78c44aed-d4dd-4cb1-a266-a5a254ab09f4", "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-09-07T22:26:52.9580029Z" }, "IsFollowing": true, "Content": "sample string 9", "PublishedOn": "2024-09-07T22:26:52.9580029Z", "Community": null, "Author": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "8efeef43-c1d5-488c-95a9-ee6e91e8301d", "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-09-07T22:26:52.9580029Z", "UpdatedByContactKey": "78c44aed-d4dd-4cb1-a266-a5a254ab09f4", "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-09-07T22:26:52.9580029Z" }, "Attachments": [ { "DocumentAttachmentKey": "4e6648cd-06b8-4756-a659-98674b85c8fa", "DocumentKey": "b846991c-faca-4db9-bb06-67a3e1bd4c1b", "FileName": "sample string 3", "UploadedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "8efeef43-c1d5-488c-95a9-ee6e91e8301d", "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-09-07T22:26:52.9580029Z", "UpdatedByContactKey": "78c44aed-d4dd-4cb1-a266-a5a254ab09f4", "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-09-07T22:26:52.9580029Z" }, "CreatedOn": "2024-09-07T22:26:52.9580029Z", "FileExtension": "sample string 5", "FileSizeInBytes": 1, "Width": 1, "Height": 1, "DurationSeconds": 1, "DownloadUrl": "sample string 6", "IconUrl": "sample string 7", "Status": "sample string 8" }, { "DocumentAttachmentKey": "4e6648cd-06b8-4756-a659-98674b85c8fa", "DocumentKey": "b846991c-faca-4db9-bb06-67a3e1bd4c1b", "FileName": "sample string 3", "UploadedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "8efeef43-c1d5-488c-95a9-ee6e91e8301d", "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-09-07T22:26:52.9580029Z", "UpdatedByContactKey": "78c44aed-d4dd-4cb1-a266-a5a254ab09f4", "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-09-07T22:26:52.9580029Z" }, "CreatedOn": "2024-09-07T22:26:52.9580029Z", "FileExtension": "sample string 5", "FileSizeInBytes": 1, "Width": 1, "Height": 1, "DurationSeconds": 1, "DownloadUrl": "sample string 6", "IconUrl": "sample string 7", "Status": "sample string 8" } ], "IsAnonymous": true, "Creator": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "8efeef43-c1d5-488c-95a9-ee6e91e8301d", "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-09-07T22:26:52.9580029Z", "UpdatedByContactKey": "78c44aed-d4dd-4cb1-a266-a5a254ab09f4", "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-09-07T22:26:52.9580029Z" }, "EditedOn": "2024-09-07T22:26:52.9580029Z", "EditedBy": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "8efeef43-c1d5-488c-95a9-ee6e91e8301d", "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-09-07T22:26:52.9580029Z", "UpdatedByContactKey": "78c44aed-d4dd-4cb1-a266-a5a254ab09f4", "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-09-07T22:26:52.9580029Z" }, "IsModerated": true, "RecommendationCount": 14, "HasRecommended": true, "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "UserPermissions": [ "sample string 1", "sample string 2" ] }
application/xml
Sample not available.
text/xml
Sample not available.