Overview
Error Handling

Methods

API Documentation (API Version bleed)

UserTask/

list

URL:

https://api.liquidweb.com/bleed/UserTask/list

Description:

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'action', 'assetDetails'
codeA valid UUID (Universally Unique IDentifier).
created_dateA standardized search for a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
executed_dateA standardized search for a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
order_byAn associative array containing the fields:
 
fieldOne of: 'created_date', 'executed_date', 'requester', 'scheduled_date', 'status'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
requesterA single word, consisting of only letters and digits.
scheduled_dateA standardized search for a valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
statusA standardized search for One of: 'active', 'cancelled', 'completed', 'failed', 'pending'
uniq_idA standardized search for a six-character identifier, containing only capital letters and digits.

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
codeA valid UUID (Universally Unique IDentifier).* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
executed_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
requesterA single word, consisting of only letters and digits.
scheduled_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
statusA single word, consisting of only letters and digits.
uniq_idA six-character identifier, containing only capital letters and digits.* Optional
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA positive integer value (i.e. 1 and up).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

update

URL:

https://api.liquidweb.com/bleed/UserTask/update

Description:

Parameters:

ParameterTypeNotes
alsowithAn array of One of: 'action', 'assetDetails'
codeA valid UUID (Universally Unique IDentifier).* Required
scheduled_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
statusThe value: 'cancelled'

Returns:

FieldTypeNotes
codeA valid UUID (Universally Unique IDentifier).* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
executed_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.* Optional
requesterA string of text, containing no newlines or other control characters.
scheduled_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.
statusA string of text, containing no newlines or other control characters.
uniq_idA six-character identifier, containing only capital letters and digits.* Optional

Possible Errors:

Refer to the Error Handling documentation for the list of exception types