# Automatic Rostering

## Docs

- [Get the latest result](https://docs.automaticrostering.visma.net/api-reference/roster/get-the-latest-result.md)
- [Get the status of a job](https://docs.automaticrostering.visma.net/api-reference/roster/get-the-status-of-a-job.md)
- [Start a job](https://docs.automaticrostering.visma.net/api-reference/roster/start-a-job.md)
- [Stop a job](https://docs.automaticrostering.visma.net/api-reference/roster/stop-a-job.md)
- [Periods](https://docs.automaticrostering.visma.net/v2/concepts/periods.md): Learn how to define references to periods of time in the roster.
- [Demands](https://docs.automaticrostering.visma.net/v2/entities/demands.md): Learn how to define the demands that must be covered in the roster.
- [Employees](https://docs.automaticrostering.visma.net/v2/entities/employees.md): Learn how to define the employees that will be used in the roster.
- [Shifts](https://docs.automaticrostering.visma.net/v2/entities/shifts.md): Learn how to define the shifts that employees can be assigned to cover demand.
- [Authentication](https://docs.automaticrostering.visma.net/v2/getting-started/authentication.md): Learn how to authenticate to the API
- [Migrate from v1](https://docs.automaticrostering.visma.net/v2/getting-started/migrate-from-v1.md): Upgrade your integration from the v1 API to the v2 API.
- [Quickstart](https://docs.automaticrostering.visma.net/v2/getting-started/quickstart.md): Learn how to create your first roster
- [Introduction](https://docs.automaticrostering.visma.net/v2/index.md): Welcome to Automatic Rostering!
- [Availability](https://docs.automaticrostering.visma.net/v2/rules/availability.md): Block employees from working on specific days or shifts, or make it desired/undesired for them to work on specific days or shifts.
- [Consecutive](https://docs.automaticrostering.visma.net/v2/rules/consecutive.md): Control the number of consecutive shifts or days that employees can work.
- [Cooldown](https://docs.automaticrostering.visma.net/v2/rules/cooldown.md): Define minimum rest periods between shifts for employees.
- [Fairness](https://docs.automaticrostering.visma.net/v2/rules/fairness.md): Improve the fairness among employees of (in)conveniences from other rules.
- [Basic rule concepts](https://docs.automaticrostering.visma.net/v2/rules/index.md): Learn about the rules the solver can follow when generating rosters.
- [Pattern](https://docs.automaticrostering.visma.net/v2/rules/pattern.md): Define desired or undesired shift patterns.
- [Period Distribution](https://docs.automaticrostering.visma.net/v2/rules/period-distribution.md): Set rules for how many periods (marked by labels) an employee can work.
- [Periodic Rest](https://docs.automaticrostering.visma.net/v2/rules/periodic-rest.md): Set targets for the minimum rest an employee should receive in each period
- [Utilization](https://docs.automaticrostering.visma.net/v2/rules/utilization.md): Set targets and limits for the number of hours or shifts worked by employees in specific periods.

## OpenAPI Specs

- [openapi](https://docs.automaticrostering.visma.net/openapi.yaml)
- [openapi.no-deprecated](https://docs.automaticrostering.visma.net/v1/api-reference/openapi.no-deprecated.yml)

## Optional

- [Playground](https://ar-playground-one.vercel.app/)