Reload task: Create

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

Method

POST

Path

/qrs/reloadtask/create

Description

Create a reload task and its triggers (that is, events). There are two types of triggers for a reload task:

  • Composite event

    This event is triggered on condition of other events succeeding or failing, also known as task event trigger.

  • Schema event

    This event is triggered according to a schedule (covers once-only as well as all repeating triggers).

Body

{ "task": {"app": { "id": "bda74c3e-c7e6-4154-845a-139ad7c07390" }, "name": "Reload task for app xyz" }, "compositeEvents": [ { "timeConstraint": { "days": 0, "hours": 0, "minutes": 360, "seconds": 0 }, "compositeRules": [ { "reloadTask": { "id": "3fecb7c5-aba1-4fac-acac-de837515ebd7" }, "ruleState": 1 } ], "name": "EventTrig2", "enabled": true, "eventType": 1 }], "schemaEvents":[{ "timeZone": "America/New_York", "daylightSavingTime": 0, "startDate": "2017-01-11T12:05:46.000", "expirationDate": "9999-01-01T00:00:00.000", "schemaFilterDescription": [ "* * - * * * * *" ], "incrementDescription": "0 0 1 0", "incrementOption": 2, "name": "Daily", "enabled": true }] }

Return value

{ "id": "365f6544-ec6f-4f60-8dff-62267c397937", "createdDate": "2017-01-16T16:12:18.152Z", "modifiedDate": "2017-01-16T16:12:18.152Z", "modifiedByUserName": "INTERNAL\\sa_repository", "customProperties": [], "app": { "id": "bda74c3e-c7e6-4154-845a-139ad7c07390", "name": "License Monitor", "appId": "", "publishTime": "2016-12-30T17:52:13.609Z", "published": true, "stream": { "id": "a70ca8a5-1d59-4cc9-b5fa-6e207978dcaf", "name": "Monitoring apps", "privileges": null }, "savedInProductVersion": "4.16.0", "migrationHash": "82b8362010f6f32f12217392e08c75194db0d4fc", "availabilityStatus": 0, "privileges": null }, "isManuallyTriggered": false, "operational": { "id": "9b42f5fa-d00d-4427-8845-5b8d00125968", "lastExecutionResult": { "id": "b3f8f475-ea71-48e1-8080-243aa1ff98de", "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": "Reload task for app xyz", "taskType": 0, "enabled": true, "taskSessionTimeout": 1440, "maxRetries": 0, "tags": [], "privileges": [ "create", "read", "update", "delete" ], "impactSecurityAccess": false, "schemaPath": "ReloadTask" }

Optional parameters

-

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

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