Sessions

Run action

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.

post/cas/sessions/{sessionId}/actions/{actionName}

Request

  • Base URL: http://mock-cas.apifirst.unx.sas.com/cas
  • URL: http://mock-cas.apifirst.unx.sas.com/cas/cas/sessions/{sessionId}/actions/{actionName}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (implicit, authorization URL https://site-specific-url)

Response

OK

statusinteger

Always returns 0. Use disposition.statusCode instead.

logstring

Concatenation of log entries into a single string.

changedResourcesChangedResources[]

A list of enumerated strings that represents state changes in the server that occurred while running the action. Clients can use these flags to distinguish what local resources must be refreshed (e.g. lists of caslibs) to reflect the current state of the server.

Example response

{
  "results": {
    "schema": [
      {
        "label": "Some column label",
        "type": "int"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.