Run action

post/cas/sessions/{sessionId}/actions/{actionName}
Internal-Use Only

Run the specified action. Action parameters can be specified either as URL query parameters or as POST data (either in form data or JSON format). For example, the echo action:

POST /cas/sessions/{sessionId}/actions/echo?a=1&b=2&c=true

When parameters are specified as part of the URL or in form data, all values are interpreted as strings. Use JSON format to specify action parameters whose data types are not strings. A POST of the following JSON to /cas/sessions/{sessionId}/actions/echo will retain the data types of the parameters.

{ "a": 1,"b": 2,"c": true }

When running the table.upload action, use the PUT method.

NOTE: The table.addTable action is not supported by the REST API.

Request Samples

1

Response Samples

1{
2  "status": 0,
3  "log": "Some log entry that is returned",
4  "results": {
5    "value": {
6      "_ctb": true,
7      "label": "Cas Table Label",
8      "title": "Cas Table Title",
9      "name": "Cas Table Name",
10      "schema": {
11        "value": {
12          "name": "Some column name",
13          "label": "Some column label",
14          "format": "Some format",
15          "type": "int",
16          "width": 7,
17          "attributes": {
18            "Some Attributes": null
19          }
20        }
21      }
22    },
23    "logEntries": {
24      "value": {
25        "level": "all",
26        "message": "Logging entry"
27      }
28    }
29  },
30  "disposition": {
31    "value": {
32      "severity": "Normal",
33      "reason": "OK",
34      "statusCode": 0,
35      "formattedStatus": "null",
36      "debugInfo": "null",
37      "changedResources": {
38        "value": {
39          "$ref": "#/components/examples/CASResource"
40        }
41      }
42    },
43    "metrics": {
44      "value": {
45        "$ref": "#/components/examples/ActionMetrics"
46      }
47    }
48  }
49}

Path Parameters

NameTypeRequiredDescription
actionName
string
true

Name of action. Can be expressed as actionSet.action to specify an action in a specific actionSet.

sessionId
string
true

sessionId (UUID) of session.

Responses

StatusMeaningDescription
200OKOKSchema
404Not FoundSession not found in the server's session list.Schema
410GoneUnknown or expired session. The session is still in the server's session list, but the session is no longer running.Schema