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

Returns information about workflow actions that are valid for the specified resource.

Authorization Roles/Permissions: Must be logged in. Must have visibility of the specified resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

The example below shows a request for the valid workflow actions for the specified resource.

Request URL

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

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept

application/json, application/xml

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

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

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

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.

Back to top

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.
IncludeReservedActions Query boolean Optional Indicates whether reserved actions should be included in the results. Default: false.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the valid workflow actions for the specified resource.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Content-Type: application/json

Sample response body: application/json

{
  "channel" : {
    "title" : "Custom workflow for managing users",
    "WorkflowObject" : {
      "WorkflowDefinitionKey" : "manage-user-workflow",
      "State" : [ "Setup" ]
    },
    "item" : [ {
      "guid" : {
        "value" : "Change to managed users"
      }
    }, {
      "guid" : {
        "value" : "Change to unmanaged users"
      }
    } ]
  }
}

Back to top

Response Headers

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

Header Description
Content-Type

application/json, application/xml

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

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

application/vnd.soa.v80+json, application/vnd.soa.v80+xml

application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Back to top

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. Each item in the channel represents a valid action for the resource, and includes the information listed below.

Name Type Description
Workflow definition key string The name of the workflow.
State string The workflow state values depend on the workflow definition XML file. See Workflow States.
Item string For each item, a unique GUID and user-defined value.

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

Back to top

Related Topics