Intake APIs are available for the following actions in Product Catalog:
- Creating, retrieving, and updating
- Products and product rules sets
- Bundles and bundle rules sets
- Work units
- Discontinuing
- Products and product rules sets
- Bundles and bundle rules sets
- Releasing work units
To try out these APIs, visit the bundles endpoints page, the products endpoints page, and the work unit endpoints page.
Create Work Units
Use the Create Work Unit API to create a work unit. The system will generate a work unit and return a work unit ID in the response. From there, the work unit ID can be listed on a request to create, update, or discontinue a product or bundle.
| Content of Create Work Unit Request | Method | Path |
|---|---|---|
| POST | /transition/intake/workunits/v1/airlines/{wuOwner}Note: Replace {wuOwner} with the code of the organization that is creating the work unit. |
Retrieve Work Units
Use the Retrieve Work Unit API to get work units of a work unit owner.
| Content of Retrieve Work Unit Request | Method | Path (used for authorization) |
|---|---|---|
| In the request URL: All optional
| GET | /transition/intake/workunits/v1/airlines/{wuOwner}Note: Replace {wuOwner} with the code of the organization that created the work unit. |
Update Work Units
Use the Update Work Unit API to change a work unit’s name or description.
The work unit name and description are editable. The system-assigned work unit identifier cannot be changed.
| Content of Update Work Unit Request | Method | Path (used for authorization) |
|---|---|---|
In the body of the request:
| PATCH | /transition/intake/workunits/v1/airlines/{wuOwner}/{workUnitId}Note: Replace {wuOwner} with the code of the organization that created the work unit and {workUnitId} with the system-assigned work unit identifier. |
Release Work Units
Use the Release Work Unit API to move its associated data to the data distribution process.
| Content of Release Work Unit Request | Method | Path (used for authorization) |
|---|---|---|
In the request URL:
| POST | /transition/intake/workunits/v1/airlines/{wuOwner}/{workUnitId}/releaseNote: Replace {wuOwner} with the code of the organization that created the work unit and {workUnitId} with the system-assigned work unit identifier. |
Reassociate Work Units
Use the Reassociate Work Unit API to move products and bundles from one work unit to another. Reassociation disassociates each item from its current work unit and associates it with the target work unit in a single operation.
| Content of Reassociate Work Unit Request | Method | Path (used for authorization) |
|---|---|---|
In the body of the request, one or more target work unit objects, each with:
| PATCH | /transition/intake/workunits/v1/airlines/{wuOwner}/reassociateNote: Replace {wuOwner} with the code of the organization that owns the source and target work units. |