operationsManager

Get tasks

Searches the Task collection.

get/operations-manager/tasks

Request

  • Base URL: https://example.itential.io
  • URL: https://example.itential.io/operations-manager/tasks
  • Auth: none declared

Query parameters

limitinteger

Number of results to return. Used for pagination.

skipinteger

Number of results to skip. Used for pagination.

order'-1' | '1'

Sort direction, 1 for ascending and -1 for descending.

sort'name'

Field to sort by

includestring

Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.

excludestring

Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.

instring

Search for fields exactly matching one of the given list options

not-instring

Search for fields not exactly matching one of the given list options

equalsstring

Returns results where the specified fields exactly match the given match string(s).

containsstring

Returns results where the specified fields contain the given match string(s).

starts-withstring

Returns results where the specified fields start with the given match string(s).

ends-withstring

Returns results where the specified fields end in the given match string(s).

dereferencestring

Designates foreign key fields to dereference in the API output.

gtstring

Returns results where the specified fields have values greater than the specified values.

gtestring

Returns results where the specified fields have values greater than or equal to the specified values.

ltstring

Returns results where the specified fields have values less than the specified values.

ltestring

Returns results where the specified fields have values less than or equal to the specified values.

qstring

Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.

actionableTasksboolean

If true, only returns actionable tasks that the current user has write access to.

Response

The Tasks that matched the search query.

messagestring required

A human-readable message summarizing the result of the operation

Changes

No recorded changes to this operation across all 1 revision of this API.