POST api/v2.0/Question/Post

Submit a new question

Request Information

URI Parameters

None.

Body Parameters

New question to submit

NewQuestionRequest
NameDescriptionTypeAdditional 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

Sample:
{
  "Title": "sample string 1",
  "Content": "sample string 2",
  "ContainerKey": "8609a446-6e19-4b18-a026-c67aeddb2120",
  "DocumentKey": "06852b2b-58ac-4c1b-b98f-3e237aceffb7",
  "IsAnonymous": true,
  "TopicTagKeys": [
    "970372c1-7364-4e4b-b70c-f7a5e8460a8d",
    "749d3d31-9f43-4b54-8085-bada63d4297d"
  ]
}

application/xml, text/xml

Sample:
<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>8609a446-6e19-4b18-a026-c67aeddb2120</_x003C_ContainerKey_x003E_k__BackingField>
  <_x003C_Content_x003E_k__BackingField>sample string 2</_x003C_Content_x003E_k__BackingField>
  <_x003C_DocumentKey_x003E_k__BackingField>06852b2b-58ac-4c1b-b98f-3e237aceffb7</_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>970372c1-7364-4e4b-b70c-f7a5e8460a8d</d2p1:guid>
    <d2p1:guid>749d3d31-9f43-4b54-8085-bada63d4297d</d2p1:guid>
  </_x003C_TopicTagKeys_x003E_k__BackingField>
</NewQuestionRequest>

Response Information

Resource Description

Submitted question

Question
NameDescriptionTypeAdditional 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.

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

Sample:
{
  "QuestionKey": "df13628e-a6be-460c-9f38-0da5fbaeb06b",
  "Title": "sample string 2",
  "HasBestAnswer": true,
  "BestAnswerOn": "2021-05-18T02:12:15.4062554Z",
  "IsThreadClosed": true,
  "ThreadClosedOn": "2021-05-18T02:12:15.4062554Z",
  "ThreadClosedBy": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "c0d3a9a9-1014-4dcd-9764-5886f588e10c",
    "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": "2021-05-18T02:12:15.4062554Z",
    "UpdatedByContactKey": "b7efa114-367f-4a17-a6ec-7feaaac9b768",
    "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": "2021-05-18T02:12:15.4062554Z"
  },
  "IsFollowing": true,
  "Content": "sample string 8",
  "PublishedOn": "2021-05-18T02:12:15.4062554Z",
  "Community": null,
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "c0d3a9a9-1014-4dcd-9764-5886f588e10c",
    "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": "2021-05-18T02:12:15.4062554Z",
    "UpdatedByContactKey": "b7efa114-367f-4a17-a6ec-7feaaac9b768",
    "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": "2021-05-18T02:12:15.4062554Z"
  },
  "Attachments": [
    {
      "DocumentAttachmentKey": "26e80d99-a09b-4e8f-b522-fea6ea50c891",
      "DocumentKey": "26b5018e-d301-4cc6-816c-ec7ea669d438",
      "FileName": "sample string 3",
      "UploadedByContact": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "c0d3a9a9-1014-4dcd-9764-5886f588e10c",
        "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": "2021-05-18T02:12:15.4062554Z",
        "UpdatedByContactKey": "b7efa114-367f-4a17-a6ec-7feaaac9b768",
        "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": "2021-05-18T02:12:15.4062554Z"
      },
      "CreatedOn": "2021-05-18T02:12:15.4062554Z",
      "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": "26e80d99-a09b-4e8f-b522-fea6ea50c891",
      "DocumentKey": "26b5018e-d301-4cc6-816c-ec7ea669d438",
      "FileName": "sample string 3",
      "UploadedByContact": {
        "LinkToProfile": "sample string 1",
        "PictureUrl": "sample string 2",
        "ContactKey": "c0d3a9a9-1014-4dcd-9764-5886f588e10c",
        "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": "2021-05-18T02:12:15.4062554Z",
        "UpdatedByContactKey": "b7efa114-367f-4a17-a6ec-7feaaac9b768",
        "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": "2021-05-18T02:12:15.4062554Z"
      },
      "CreatedOn": "2021-05-18T02:12:15.4062554Z",
      "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": "c0d3a9a9-1014-4dcd-9764-5886f588e10c",
    "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": "2021-05-18T02:12:15.4062554Z",
    "UpdatedByContactKey": "b7efa114-367f-4a17-a6ec-7feaaac9b768",
    "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": "2021-05-18T02:12:15.4062554Z"
  },
  "EditedOn": "2021-05-18T02:12:15.4062554Z",
  "EditedBy": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "c0d3a9a9-1014-4dcd-9764-5886f588e10c",
    "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": "2021-05-18T02:12:15.4062554Z",
    "UpdatedByContactKey": "b7efa114-367f-4a17-a6ec-7feaaac9b768",
    "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": "2021-05-18T02:12:15.4062554Z"
  },
  "IsModerated": true,
  "RecommendationCount": 13,
  "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:

Sample not available.

text/xml

Sample:

Sample not available.