Function getTasks

  • Retrieves a paginated list of tasks the requesting user has access to. Results include task metadata such as owner, resource, space, and last run status. Use the filter parameter to narrow results by field values, or sort to control the ordering.

    Parameters

    • query: {
          filter?: string;
          limit?: number;
          page?: string;
          resourceId?: string;
          sort?:
              | "+ownerId"
              | "-ownerId"
              | "-name"
              | "+name"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
              | "-enabled"
              | "+enabled"
              | "+spaceId"
              | "-spaceId"
              | "+resourceId"
              | "-resourceId"
              | "+updatedBy"
              | "-updatedBy"
              | "+lastStatus"
              | "-lastStatus"
              | "+lastTriggeredBy"
              | "-lastTriggeredBy"
              | "+lastStartedAt"
              | "-lastStartedAt"
              | "+lastEndedAt"
              | "-lastEndedAt"
              | "+lastExecutedAs"
              | "-lastExecutedAs"
              | "+triggerType"
              | "-triggerType";
      }

      an object with query parameters

      • Optionalfilter?: string

        Advanced filter expression using RFC 7644 SCIM syntax. Refer to RFC 7644 for syntax details. All comparisons are case-insensitive. Supported fields: name, enabled, resourceId, ownerId, spaceId, createdAt, updatedAt, updatedBy, lastStatus, lastTriggeredBy, lastStartedAt, lastEndedAt, lastExecutedAs, and triggerType.

      • Optionallimit?: number
      • Optionalpage?: string
      • OptionalresourceId?: string
      • Optionalsort?:
            | "+ownerId"
            | "-ownerId"
            | "-name"
            | "+name"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "-enabled"
            | "+enabled"
            | "+spaceId"
            | "-spaceId"
            | "+resourceId"
            | "-resourceId"
            | "+updatedBy"
            | "-updatedBy"
            | "+lastStatus"
            | "-lastStatus"
            | "+lastTriggeredBy"
            | "-lastTriggeredBy"
            | "+lastStartedAt"
            | "-lastStartedAt"
            | "+lastEndedAt"
            | "-lastEndedAt"
            | "+lastExecutedAs"
            | "-lastExecutedAs"
            | "+triggerType"
            | "-triggerType"

        Field and direction to sort results by. Prefix the field name with + for ascending or - for descending order. Defaults to -updatedAt.

    • Optionaloptions: ApiCallOptions

    Returns Promise<tasks.GetTasksHttpResponse>

    GetTasksHttpError