POST /api/workflow/objects/{ObjectID}/actions

Performs a valid action applicable to the workflow for the specified resource.

Authorization Roles/Permissions: Must be logged in. Must be the specific authorized user; for example, an API Admin for the API to which the workflow applies, or an app team member for an app to which the workflow applies.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/workflow/objects/{ObjectID}/actions

Sample Request

The example below shows unpublishing a discussion.

Sample Request URL

https://{hostname}/api/workflow/objects/discussion11018.acmepaymentscorp/actions

Sample request headers

POST http://{hostname}l/api/workflow/objects/discussion11018.acmepaymentscorp/actions HTTP/1.0
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "ActionName":"discussion.action.unpublish",
  "Comments":"Unpublishing while I edit."
}

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 or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
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
ObjectID	Path	string	Required	The unique ID for a specific resource, such as an app, API, or user.
Action	Body	Action	Required	Contains information about an action performed on a resource as part of a workflow-related activity.

Response

If successful, this operation returns HTTP status code 200, with the updated workflow state of the resource.

Sample Response

The sample response below shows successful completion of this operation. The discussion has been unpublished and is now in a workflow state of pending.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Expires: Wed, 28 Jan 2015 16:46:15 GMT

Sample response body

Pending

Response Headers

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

Header	Description
Content-Type	text/plain

Response Body

Name	Type	Description
Workflow state	string	The updated workflow state of the resource.

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