Type Alias ListJobsData

ListJobsData: {
    allWorkspaces?: boolean;
    args?: string;
    createdBy?: string;
    createdOrStartedAfter?: string;
    createdOrStartedBefore?: string;
    hasNullParent?: boolean;
    isFlowStep?: boolean;
    isNotSchedule?: boolean;
    isSkipped?: boolean;
    jobKinds?: string;
    label?: string;
    page?: number;
    parentJob?: string;
    perPage?: number;
    result?: string;
    running?: boolean;
    schedulePath?: string;
    scheduledForBeforeNow?: boolean;
    scriptHash?: string;
    scriptPathExact?: string;
    scriptPathStart?: string;
    startedAfter?: string;
    startedBefore?: string;
    success?: boolean;
    tag?: string;
    workspace: string;
}

Type declaration

  • OptionalallWorkspaces?: boolean

    get jobs from all workspaces (only valid if request come from the admins workspace)

  • Optionalargs?: string

    filter on jobs containing those args as a json subset (@> in postgres)

  • OptionalcreatedBy?: string

    mask to filter exact matching user creator

  • OptionalcreatedOrStartedAfter?: string

    filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp

  • OptionalcreatedOrStartedBefore?: string

    filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp

  • OptionalhasNullParent?: boolean

    has null parent

  • OptionalisFlowStep?: boolean

    is the job a flow step

  • OptionalisNotSchedule?: boolean

    is not a scheduled job

  • OptionalisSkipped?: boolean

    is the job skipped

  • OptionaljobKinds?: string

    filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,

  • Optionallabel?: string

    mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')

  • Optionalpage?: number

    which page to return (start at 1, default 1)

  • OptionalparentJob?: string

    The parent job that is at the origin and responsible for the execution of this script if any

  • OptionalperPage?: number

    number of items to return for a given page (default 30, max 100)

  • Optionalresult?: string

    filter on jobs containing those result as a json subset (@> in postgres)

  • Optionalrunning?: boolean

    filter on running jobs

  • OptionalschedulePath?: string

    mask to filter by schedule path

  • OptionalscheduledForBeforeNow?: boolean

    filter on jobs scheduled_for before now (hence waitinf for a worker)

  • OptionalscriptHash?: string

    mask to filter exact matching path

  • OptionalscriptPathExact?: string

    mask to filter exact matching path

  • OptionalscriptPathStart?: string

    mask to filter matching starting path

  • OptionalstartedAfter?: string

    filter on started after (exclusive) timestamp

  • OptionalstartedBefore?: string

    filter on started before (inclusive) timestamp

  • Optionalsuccess?: boolean

    filter on successful jobs

  • Optionaltag?: string

    filter on jobs with a given tag/worker group

  • workspace: string

Settings

Member Visibility