Task Definition

A task has the following properties:

Properties	Description	Examples
name	The name of the task.	Daily Scan all
startTime	The start time of the task in GMT. Only applies to Daily, Weekly and Monthly frequencyType.	17:00
frequencyType	Possible values are: Daily Weekly Monthly Hourly (start-time is implicitly the next hour)
frequencyInterval	Only applies to Weekly, Monthly and Hourly frequencyType. Weekly - possible values are from 1 to 7, which is Mon to Sun, respectively. Monthly- possible values are from 1 to 31. Hourly - possible values are from 1 to 23.
properties	This object is dependent on the name of the service. Currently, only environmentScanner is supported.

environmentScanner properties

The properties of environmentScanner are given in the following table:

Properties	Description
appId	This is the appContainerId of the app to be scanned.
scope	This is an array of scope. Each scope can be of type EnvironmentGroup or Environment.
orgScan	Boolean indicating whether an org scan must be done or not.

Example of a Task

An example of a task is given here.

{
    "name": "Daily Scan All",
    "startTime": "17:00",
    "frequencyType": "Daily",
    "frequencyInterval": null,
    "properties": {
        "appId": "omz5z2r6l934yu1xhddj",
        "scope": [
            {
                "type": "EnvironmentGroup",
                "value": "r-pak3"
            }
        ],
        "orgScan": true
    }
}