Function getAutomationRuns

  • Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the TenantAdmin role.

    Parameters

    • id: string

      The unique identifier for the automation.

    • query: {
          fields?: string;
          filter?: string;
          limit?: number;
          sort?:
              | "status"
              | "id"
              | "+status"
              | "-status"
              | "+id"
              | "-id"
              | "startTime"
              | "-startTime"
              | "+startTime";
      }

      an object with query parameters

      • Optionalfields?: string

        Allows to select the actual fields to be returned. Where the default is all fields

      • Optionalfilter?: string

        Allowed filters: status, context, startTime and title, spaceId, ownerId, executedById

      • Optionallimit?: number

        The number of runs to retrieve.

      • Optionalsort?:
            | "status"
            | "id"
            | "+status"
            | "-status"
            | "+id"
            | "-id"
            | "startTime"
            | "-startTime"
            | "+startTime"

        The field to sort by, with +- prefix indicating sort order. (?query=-startTime => sort on the startTime field using descending order)

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetAutomationRunsHttpResponse>

    GetAutomationRunsHttpError