tasks

Description:
  • Interface to task related API calls
Source:
Interface to task related API calls

Methods

(inner) getAllTasks(parameters, networkParametersopt) → {Promise}

Description:
  • Retrieve all tasks from index
Source:
See:
Parameters:
Name Type Attributes Description
parameters object Additional parameters for task details
Properties
Name Type Attributes Default Description
numResultsPerPage number <optional>
 20 The number of tasks to return - maximum value 100
page number <optional>
 1 The page of results to return
startDate string <optional>
 The start date of results to return - YYYY-MM-DD
endDate string <optional>
 The end date of results to return - YYYY-MM-DD
status string <optional>
 The status of tasks to return - 'QUEUED', 'IN_PROGRESS', 'DONE', 'FAILED', 'CANCELED'
type string <optional>
 The type of tasks to return - 'ingestion', 'user_data_request'
networkParameters object <optional>
 Parameters relevant to the network request
Properties
Name Type Attributes Description
timeout number <optional>
 Request timeout (in milliseconds)
Returns:
Type
Promise

(inner) getTask(parameters, networkParametersopt) → {Promise}

Description:
  • Retrieve task given a specific id
Source:
See:
Parameters:
Name Type Attributes Description
parameters object Additional parameters for task details
Properties
Name Type Description
id string The ID of the task to be retrieved
networkParameters object <optional>
 Parameters relevant to the network request
Properties
Name Type Attributes Description
timeout number <optional>
 Request timeout (in milliseconds)
Returns:
Type
Promise