System Interaction

RealCADENCE™ Enterprise Action Management system has some complexities. Interacting with SKI based APIs can make the job easy and automated.

Optional Request Parameters

Parameters that will enhance tracking and reporting on all requests:

format json|xml
lat 12345.8910
lon 12345.8910
uuid 12345.8910
fk_network_type_id 12345
device_model iPad
device_version 7,11
device_name HR’s iPad
device_uiidiom Portrait|Landscape|Other
system_name iOS
system_version 13.5.1
device_battery_level 100.00%
app_version Cadence
app_name 3.54.1337

SKI

GET   ski/reflectionQuery

Queries notes and updates for a given search term.

Example
curl --request GET \
  --url 'https://myhostname/ski/reflectionQuery?searchTerm=Washington&format=xml&=' \
  --header 'x-api-key: 987654321'
searchTerm “Some keyword or phrase you are looking for.”

POST   ski/assignOnDemandList

Assigns an Action List on Demand to a given location.
Follows the pattern:

https:// [host] / ski / assignOnDemandList / [List ID] / [Location ID] ? [parameters]
Example
curl --request POST \
  --url https://myhostname/ski/assignOnDemandList/123/456 \
  --header 'content-type: application/x-www-form-urlencoded' \
  --header 'x-api-key: 987654321' \
  --data format=json
format (optional) json | xml

POST   ski/assignServiceOnDemand

Assigns a Service On-Demand to a given location.
Follows the pattern:

https:// [host] / ski / assignServiceOnDemand / [Location ID] / [Task ID] ? [parameters]
Example
curl --request POST \
  --url https://myhostname/ski/assignServiceOnDemand/123/456 \
  --header 'content-type: application/x-www-form-urlencoded' \
  --header 'x-api-key: 987654321' \
  --data 'reason_msg=Front generator has lost power.' \
  --data daid=2678731
reason_msg (required) The reason for this service request.
reason_daid (optional) 12345
daid (required*) 12345
qr_input (required*) ABCdef 12345
textual_input (required*) ABCdef 12345
numeric_input (required*) ABCdef 12345
confirmation_input (required*) YES|NO

*Required: if underlying action requires matching evidence response.