Skip to main content

Returns all TaskResult resources.

GET 
/TaskResults

This endpoint returns all TaskResult resources.

Attributes to include in the response can be specified with the 'attributes' query parameter.

Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

The schema related to TaskResult is:

  • urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult

Request​

Query Parameters

    filter string

    Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

    lookupByName boolean

    (OPTIONAL) Set to true if the TaskResult name is passed instead of the TaskResult id.

    sortBy string

    Allows sorting the results by a resource's attributes.

    sortOrder string

    Default value: ascending

    Determines what order to sort results in.

    Example: descending
    startIndex integer

    Default value: 1

    Determines the starting index of the result set.

    count integer

    Default value: 1000

    Specifies the number of results per page.

    attributes string

    A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

    excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses​

Returned all SCIM resources for this endpoint.

Schema
    totalResults integer

    Number of resources returned for this endpoint

    startIndex integer

    The starting index of the resource set list. Can be specified with startIndex query parameter.

    schemas string[]

    SCIM Schema used for response.

    Resources undefined[]
  • Array [
    • id string

    Unique identifier of the TaskResult.

    name string

    Name of the TaskResult.

    type string

    Type of the TaskResult.

    completionStatus string

    Possible values: [Success, Warning, Error, Terminated, TempError]

    Completion Status of the TaskResult.

    launcher string

    Launcher of the TaskResult.

    host string

    Host of the TaskResult.

    progress string

    Progress of the TaskResult.

    targetClass string

    Target Class of the TaskResult.

    targetName string

    Target Name of the Task Result.

    terminated boolean

    Flag to indicate this TaskResult is terminated.

    partitioned boolean

    Flag to indicate this TaskResult is partitioned.

    launched date-time

    The launched DateTime of the TaskResult.

    completed date-time

    The completed DateTime of the TaskResult.

    expiration date-time

    The expiration DateTime of the TaskResult.

    verified date-time

    The verification DateTime of the TaskResult.

    percentageComplete integer

    The percentage completed of this TaskResult.

    pendingSignOffs integer

    The number of pending signoffs of this TaskResult.

    taskDefinition string

    Name of the TaskDefinition of the TaskResult.

    taskSchedule string

    Name of the TaskSchedule of the TaskResult.

    attributes undefined[]

    A list of attributes of the TaskResult.

  • Array [
    • key string

    The attribute key.

    value string

    The attribute value.

  • ]
    • messages undefined[]

    List of messages of the TaskResult.

    meta object
    created date-time

    DateTime when the TaskResult was created.

    location string

    URL to the TaskResult.

    lastModified date-time

    DateTime of TaskResult last modification.

    version string

    TaskResult version.

    resourceType string

    Resource type of the metadata subject.

    schemas array
  • ]
Loading...