External program task: Create

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

POST

Path

qrs/externalprogramtask

Description

Create a task that runs an external program.

Body

{ "path": "C:\\makedir.bat", "name": "MakeDirectory", "taskType": 1, "enabled": true, "taskSessionTimeout": 1440, "maxRetries": 0, "privileges": null, "impactSecurityAccess": false, "schemaPath": "ExternalProgramTask" }

Return value

{ "id": "d3e94340-5940-4ef4-8ab0-cadd1126dc84", "createdDate": "2017-11-23T15:48:02.618Z", "modifiedDate": "2017-11-23T15:48:02.618Z", "modifiedByUserName": "INTERNAL\\sa_repository", "customProperties": [], "path": "C:\\makedir.bat", "parameters": "", "qlikUser": null, "operational": { "id": "f93addc2-4a0f-4363-a460-906684b8f2c8", "lastExecutionResult": { "id": "2ee1712a-78dd-41fc-9942-d52d526cd170", "executingNodeName": "", "status": 0, "startTime": "1753-01-01T00:00:00.000Z", "stopTime": "1753-01-01T00:00:00.000Z", "duration": 0, "fileReferenceID": "00000000-0000-0000-0000-000000000000", "scriptLogAvailable": false, "details": [], "privileges": null }, "nextExecution": "1753-01-01T00:00:00.000Z", "privileges": null }, "name": "MakeDirectory", "taskType": 1, "enabled": true, "taskSessionTimeout": 1440, "maxRetries": 0, "tags": [], "privileges": null, "schemaPath": "ExternalProgramTask" }

Optional parameters

Did this information help you?

Can you tell us why it did not help you and how we can improve it?