Update an active UI instruction parameter.

URL

/rw/rapid/uiinstr/active/param/{stackurl}/{uiparam}

Method

POST

URL Params

action=set Required, form data see Get rapid task actions

See Common URL parameters

Data Params

value={value}

For example, TPFK3 can accept a value like "0" and TPCompleted can accept a value like TRUE

Success Response

NO_CONTENT(204), see HTTP Status codes

Error Response

BAD REQUEST(400),NOT_FOUND(404),FORBIDDEN(403) see HTTP Status codes

Robot controller errors, see Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics -d "value=0" -X POST "http://127.0.0.1/rw/rapid/uiinstr/active/param/RAPID/T_ROB1/%$104/TPFK3?action=set"

curl --digest -u "Default User":robotics -d "value=TRUE" X POST "http://127.0.0.1/rw/rapid/uiinstr/active/param/RAPID/T_ROB1/%$104/TPCompleted?action=set"

Notes

-Not supported in bootserver mode

-{stackurl} ends with a variable number, which can be obtained from "Get Active UI Instruction" API.

-RAPID program should be running

-Example of {uiparam} are TPFK1, TPFK2, TPFK3, TPCompleted etc