Optimization Tasks: List
List Optimization Tasks for the account, optionally filtered by task and location.
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| taskIds | string Comma-separated list of Optimization Task IDs corresponding to Optimization Tasks that should be included in the response. If no IDs are provided, defaults to all available Optimization Tasks in the account. |
| locationIds | string Comma-separated list of Location IDs to be used as a filter. If no IDs are provided, defaults to all Locations in the account. |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "optimizationTasks": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "locationsEligible": 0,
- "locationsCompleted": 0
}
]
}
}Optimization Tasks: Get Link
Retrieve a link to perform any pending Optimization Tasks given a set of Optimization Tasks and a location
path Parameters
| accountId required | string |
query Parameters
| v required | string A date in |
| taskIds | string Comma-separated list of Optimization Task IDs corresponding to Optimization Tasks that should be included in the response. If no IDs are provided, defaults to all available Optimization Tasks in the account. |
| locationId | string Location ID to be used as a filter. If no ID is provided, defaults to all Locations in the account. |
| mode | string Default: "PENDING_ONLY" Enum: "PENDING_ONLY" "ALL_TASKS" "RESET" When mode is When mode is |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "link": "string"
}
}