# Job Definitions

With the End Points of the API it's possible to define jobs, which are a collection of multiple Profiling Criteria or Business Rules. 

## YAML Example

```yaml
# Example of a Job Definition in YAML format
name: run_all_profiling_criteria
is_active: true
is_offical: false
criteria_query: 
    - type: profiling
trigger: 
    - day_of_week: 5
    - start_date: "2025-01-01"
    - end_date: "2025-12-31"
reference_data_rule:
    - interval: day
    - shift: 0
    - timing: begin
```

## YAML Reference

## Documentation for Job Definition YAML Format

### Fields

```yaml
# Example of a Job Definition in YAML format
- name (string): The name of the job.
- is_active (bool): Indicates whether the job is currently active.
- is_offical (bool): Specifies if the job is an official job.
- criteria_query (list of objects): A list of criteria queries for the job.
    - type (string): The type of the criteria query.
- trigger (list of objects): Defines the schedule or conditions that trigger the job.
    - day_of_week (string): The day of the week when the job should run (e.g., "Monday").
    - start_date (string): The start date for the job in a valid date format.
    - end_date (string): The end date for the job in a valid date format.
- reference_data_rule (list of objects): Rules for referencing data in the job.
    - interval (string): The interval at which the rule applies (e.g., "daily", "weekly").
    - shift (int): The shift value for the rule, typically used for offsetting.
    - timing (string): The timing of the rule (e.g., "before", "after").
```


## End Points
At the following location the API references can be found: https://app-dq-dev-01.azurewebsites.net/docs#/. For Job Definitions, the following end points can be used:
```
Manage:
/job/definitions #POST for adding a new selection
/job/definitions/{id} #PUT for changing an existing selection

Find (GET):
/job/definitions #For returning all selections
/job/definitions/{id} #For finding a specific selection
/job/definitions/find_one #To find specific selections without pagination
/job/definitions/find  #To find specific selection with pagination
```

# Job Runs

The jobs can be started via the ADQ User Interface or with the endpoint /job/runs.
The job can be monitored with the ADQ User Interface and with the endpoint /job/runs/{id}.

## YAML Example
```yaml
# Example of a Job Run in YAML format
definition: run_all_profiling_criteria
reference_date: 2025-01-01
```

## YAML Reference
```yaml
# YAML Reference for Job Runs
- definition (string): The name of the job definition to be executed.
- reference_date (string): The reference date at which the job will be run, in a valid date format (e.g., "YYYY-MM-DD").
```

## End Points
At the following location the API references can be found: https://app-dq-dev-01.azurewebsites.net/docs#/. For Job Runs, the following end points can be used:
```
Manage:
/job/runs #POST for adding a new selection
/job/runs/{id} #PUT for changing an existing selection

Find (GET):
/job/runs #For returning all selections
/job/runs/{id} #For finding a specific selection
/job/runs/find_one #To find specific selections without pagination
/job/runs/find  #To find specific selection with pagination
```