Job Work Unit Logic in Web API
Overview
As part of work to remove limitations to the number of items allowed in operations on the Extended API (https://extended.api.uk.alloyapp.io/), the logic performed when creating, updating and deleting job work units (work items and bill items) will be moved to the Web API (https://api.uk.alloyapp.io/).
This work is part of ongoing changes being made to functionality that has historically been available through the Extended API. Similar changes were made to defect logic (August), inspection logic (September) and job logic (September).
Who will be affected?
This change will affect any users who work with job work units in Alloy, as these changes will be introduced on the API used by both the web client and mobile apps.
Details
There have always been two routes to working with job work units:
- Through the Web API, where job work units are treated like any other item.
- Through the Extended API, where logic specific to job work units is applied when performing the same operations (e.g. limiting the types of parent a job work unit can have).
However, the way in which this additional logic was applied in the Extended API required a limit on the number of items being operated on, to guard against service degradation. Therefore, we're moving this logic to the Web API, so these limits can be removed in future.
As a result, there will be some changes to the behaviour of the Web API Item endpoints when a job work unit item is operated on.
Linking Jobs and Job Work Units
When creating or editing a job, it isn't possible to manually create links to corresponding job work units (or change an existing links).
This is because linking is handled automatically during other processes:
- When creating a job work unit, it will be linked to the parent job you specify.
- When a job work unit is deleted, the link to its parent job will be removed.
- When a job or job work unit is deep cloned, copies of both the job and job work units are created and linked together.
Job Work Unit constraints
A job work unit must be created with a link to a single parent job and a single work unit. Attempting to create one these will result in a BadRequest Error 1657715843.
Previously, if a job work unit had a custom parent in addition to its parent job, it was possible to clone that custom parent via this endpoint (see ReDoc).
POST /api/item/{id}/clone
with cascadeModes
set to Deep
.
This would result in copies of the custom parent and job work unit being created and linked together. However, the job work unit would be missing the link to its parent job, which wouldn't be included in the clone operation.
This is no longer possible and will produce a BadRequest Error 1596183833 if attempted.
Automatic budget and estimated value
When creating a job work unit, if a budget or estimated value isn’t supplied, values for these will be copied from its linked work unit (if it holds any values for them).
Expected Release Date
8th December 2022 as part of the Alloy v2.42 release