Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Info |
|---|
This function is one of Open API Operation. You can find the movie in ARGOS RPA+ video tutorial. |
POST /openapi/v1/uxrobot/remote_command/ondemandrun/api
Example request :
| Code Block | ||||
|---|---|---|---|---|
| ||||
POST /openapi/v1/uxrobot/remote_command/ondemandrun/api?apiKey=abcd4eb2b12345c74c18 HTTP/1.1
Host: api2-rpa.argos-labs.com
{
"userId": "test@test.com",
"workId": "this_is_your_work_id",
"endPoint": "this_is_your_endpoint",
"apiPamId": "api12pam345id",
"apiScenarioId": "api12scenario34id",
"botParameters": [
{
"variable_text":"{{param.searchText}}",
"value":"hello world"
}
]
}
|
| Field | Type | Description | Required |
|---|---|---|---|
| userId | String | User ID that belongs to API Key | True |
| workId | String | Other Job/Work ID for API User | False |
| endPoint | String | <POST> API User's Webhook URL Value | False |
| apiPamId | String | One of Pam IDs from a pam list | True |
| apiScenarioId | String | One Of Scenario IDs from a scenario list | True |
| botParameters | List | Parameter to use for pam operations | False |
| timeOut | int | Time for time-out; default value is 10000 and time unit is milliseconds | False |
Example response:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"message": "OK",
"status": 200,
"error": null,
"data": [
{
"userId": "test@test.com",
"taskId": "b611234524c996034518ed681c1e067cf98d12a75a4af5e2b5079ecf3e19dec8",
"workId": null,
"commandResponse": {
"response_source": "0",
"status": 200,
"elapseTime": null,
"data": {
"Value": "success",
"Key": "result"
}
}
}
]
} |
| Field | Type | Description | |
|---|---|---|---|
userId | String | User ID | |
| taskId | String | Unique ID given to each transaction call for pam operations | |
| workId | String | Other Job/Work ID for API User | |
Command Response | response_source | String | Message from a pan |
| status | String | Socket status after connection | |
| elapseTime | Long | Elapsed time to get a response message from a pam | |
| data | String | value : on-demand result's value | |
Value of Status
| Status Code | Description |
|---|---|
| 200 | success |
| 408 | timeout |
| 500 | failure |
| 503 | failure(busy) |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
|