List Enhancements
enhancements_list( type = NULL, author = NULL, status = NULL, archived = NULL, limit = NULL, page_num = NULL, order = NULL, order_dir = NULL )
type | string optional. If specified, return items of these types. |
---|---|
author | string optional. If specified, return items from this author. Must use user IDs. A comma separated list of IDs is also accepted to return items from multiple authors. |
status | string optional. If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'. |
archived | string optional. The archival status of the requested item(s). |
limit | integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50. |
page_num | integer optional. Page number of the results to return. Defaults to the first page, 1. |
order | string optional. The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at. |
order_dir | string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc. |
An array containing the following fields:
integer, The ID for the enhancement.
string, The name of the enhancement job.
string, The type of the enhancement (e.g CASS-NCOA)
string, The time this enhancement was created.
string, The time the enhancement was last updated.
list, A list containing the following elements:
id integer, The ID of this user.
name string, This user's name.
username string, This user's username.
initials string, This user's initials.
online boolean, Whether this user is online.
string, The status of the enhancement's last run
string, The archival status of the requested item(s).