POST /api/discussions

Starts a new discussion.

Note: If you are using markdown, and will be incorporating one or more artifacts in your discussion, you must upload the artifacts first. Run the POST /api/boards/items/artifacts operation to upload the first artifact and the POST /api/boards/items/{BoardItemID}/artifacts operation to upload any subsequent artifacts. Use the values from the responses, such as the BoardItemID and the image paths, to construct the payload for adding the discussion.

Authorization Roles/Permissions: Registered site user; authorized user for the resource.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/discussions

Back to top

Sample Request

The example below shows a user starting a new discussion relating to an API.

Request URL

https://{hostname}/api/discussions

Sample request headers

POST /api/discussions HTTP/1.1
Host: {hostname}
Accept: text/plain
Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body: no artifacts

Line breaks have been added for display reasons. Indentation in subsequent lines indicates a line break; it does not represent spaces in the content.

{ 
  "Content":"We are planning for our next release. Feature requests welcome!",
  "DiscussionSubjectID":"0157f427-0b07-4ae6-9ade-26f4ef3bcc71.acmepaymentscorp",
  "DiscussionType":"com.soa.discussion.type.comment",
  "Tag":[ 
    "features",
    "announcement"
  ],
  "Topic":"Call for feature requests",
  "UserID":"aadb625a-6a2a-41b6-9801-f40f81db7a16.acmepaymentscorp",
  "DescriptionMediaType":"text/markdown",
  "BoardItemArtifacts":{ 
    "BoardItemArtifact":[ 

    ]
  }
}

Sample request body: with artifacts

Line breaks have been added for display reasons. Indentation in subsequent lines indicates a line break; it does not represent spaces in the content.

{
  "Content":"We are planning for our next release. Feature requests welcome! \n\n![image](http://{hostname}/
api/boards/items/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/img_dollars.jpg \"img_dollars.jpg\")
\n\nCash prizes for the first five suggestions that we use!",
  "DiscussionSubjectID":"ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp",
  "DiscussionType":"com.soa.discussion.type.comment",
  "Tag":[

  ],
  "Topic":"Call for feature requests",
  "UserID":"8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp",
  "DescriptionMediaType":"text/markdown",
  "BoardItemArtifacts":{
    "BoardItemArtifact":[
      {
        "ContextID":"063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp",
        "FileName":"img_dollars.jpg",
        "BaseUri":"http://{hostname}",
        "UriPath":"/api/boards/items/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/img_dollars.jpg"
      }
    ]
  }
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
discussion Body Discussion Required Includes information about a discussion. Content, DiscussionSubjectID, Topic, and UserID are required.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the DiscussionID for the new discussion in plain text.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Mon, 11 May 2015 15:29:53 GMT

Sample response body

063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
DiscussionID string The unique ID for a specific discussion.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401

Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.

You would also get this response if you hadn't logged in before running the operation, or if the resource was private and you were not an authorized user.

405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics