GET /api/discussions/{DiscussionID}/details

Returns information about a discussion, including details such as workflow steps that are valid for the discussion and, possibly, comments and target resources relating to the discussion.

Authorization Roles/Permissions: This operation applies to all users. Results are only returned if the user has visibility of the specific discussion.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/discussions/{DiscussionID}/details

Sample Request

The example below shows a request for details for the specified discussion.

Sample Request URL

https://{hostname}/api/discussions/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/details

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
DiscussionID	Path	string	Required	The unique ID for a specific discussion.

Response

If successful, this operation returns HTTP status code 200, with details about the specified discussion.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Expires: Mon, 11 May 2015 15:46:27 GMT

Sample response body

{
  "Discussion" : {
    "DiscussionID" : "063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp",
    "DiscussionSubjectID" : "ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp",
    "DiscussionType" : "com.soa.discussion.type.comment",
    "Topic" : "Call for feature requests ",
    "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!",
    "UserID" : "8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp",
    "UserName" : "JaneMead",
    "Created" : "2015-05-11T20:29:53Z",
    "Comments" : 0,
    "Marks" : 0,
    "IsMarked" : false,
    "Tag" : [ ],
    "Visibility" : "Limited",
    "AuthoringUser" : {
      "UserID" : "8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp",
      "Name" : "JaneMead",
      "Image" : {
        "Url" : "http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar",
        "Title" : "JaneMead"
      }
    },
    "Image" : {
      "Url" : "http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar"
    },
    "Published" : true,
    "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"
      } ]
    }
  },
  "Action" : [ {
    "value" : "discussion.action.unpublish",
    "label" : "discussion.action.unpublish"
  }, {
    "value" : "discussion.action.delete",
    "label" : "discussion.action.delete"
  } ]
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

Response Body

Name	Type	Description
DiscussionDetails	DiscussionDetails	Includes information about a discussion, including details such as workflow steps that are valid for the discussion and, possibly, comments and target resources relating to the discussion.

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 for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics