Documentation
Tutorials
authentication Browsing-a-Cas-Table casActionRun casActionRunExample casFetchData Compute-Service-made-easy computeRunExample Executing-a-cas-action findReport getReportImage Managing-clientids masDescribe restafeditExample Scoring-in-the-Cas-Server Scoring-with-MAS Scripting-on-the-Cas-Server usefulTips vaddc videos_dataEntry
restaf restaflib restafedit

Global

Methods

Type Definitions

object

# actionPayload

payload for cas actions

Properties:
Name Type Description
actionName string
actionParameter object
object

# appControl

appControl

Properties:
Name Type Description
description, string
source "cas" | "compute"
cacheControl boolean
byvars array
initialFetch object
customColumns object
editControl object
appData object
object

# appEnv

appEnv

Properties:
Name Type Description
source string
store store
session object
servers object
logonPayload logonPayloadCode | logonPayloadPassword | logonPayloadToken
appControl appControl
state appEnvState
object

# appEnv

Application Environment.

object

# appEnvState

appEnvstate

Properties:
Name Type Description
data rowObjectArray
columns columns
"password" | "code" | "server" | "token"

# authType

authType

object

# byVars

Array of by variables

object

# casTable

casTable

Properties:
Name Type Description
caslib string
name string
object

# computeSummary

computeSummary from computeSummary

object

# computeSummary

computeSummary from computeSummary

object

# computeTable

computeTable

Properties:
Name Type Description
libref string
name string
object

# eSchema

Extended schema.

object

# fetchControl

Information to fetch records

Properties:
Name Type Description
qs fetchQuery
object

# fetchQuery

Information to fetch records

Properties:
Name Type Description
start number
limit number
format boolean
where string
object

# fetchResults

Information to fetch results

object

# logonPayload

Logon payload

object

# logonPayloadCode

Code logon payload

Properties:
Name Type Attributes Description
authType "code" | "server"
host URL
token string <optional>

Useful when CORS is set *
bearer tokenType <optional>
object

# logonPayloadCode

Code logon payload

Properties:
Name Type Description
authType "code" | "server"
host URL
token string

optional
bearer "Bearer"

optional
object

# logonPayloadPassword

Password logon payload

Properties:
Name Type Description
authType "password"
host string
user string
password string
clientID string
clientSecret string
object

# logonPayloadPassword

Password logon payload

Properties:
Name Type Description
authType "password"
host string
token string

optional
bearer string

optional
object

# logonPayloadToken

Token logon payload

Properties:
Name Type Description
authType "token"
host string
token string
bearer string
object

# logonPayloadToken

Token logon payload

Properties:
Name Type Description
authType "token"
host string
token string

optional
bearer string

optional
object

restaf links

object

# rafLinkRel

Link for a specific rel

object

# rafObject

restaf object

object

# rowObject

Data row as object.

Array

# rowObjectArray

Array of row objects.

object

# store

restaf store.

casTable | computeTable

# table

"bearer"

# tokenType

tokenType