Type alias RunFlowByPathData

RunFlowByPathData: {
    includeHeader?: string;
    invisibleToOwner?: boolean;
    jobId?: string;
    parentJob?: string;
    path: string;
    requestBody: ScriptArgs;
    scheduledFor?: string;
    scheduledInSecs?: number;
    tag?: string;
    workspace: string;
}

Type declaration

  • Optional includeHeader?: string

    List of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key

  • Optional invisibleToOwner?: boolean

    make the run invisible to the the flow owner (default false)

  • Optional jobId?: string

    The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)

  • Optional parentJob?: string

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

  • path: string
  • requestBody: ScriptArgs

    flow args

  • Optional scheduledFor?: string

    when to schedule this job (leave empty for immediate run)

  • Optional scheduledInSecs?: number

    schedule the script to execute in the number of seconds starting now

  • Optional tag?: string

    Override the tag to use

  • workspace: string

Settings

Member Visibility

Theme