--- title: "POST /udl/item" method: POST path: "/udl/item" tags: ["AirOperations"] --- # POST /udl/item `POST /udl/item` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/item` - Auth: none declared Service operation to take a single item record as a POST body and ingest into the database. A specific role is required to perform this service operation. Please contact the UDL team for assistance. ## Request body - ItemIngest - `id` string: Unique identifier of the record, auto-generated by the system if not provided on create operations. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `idAirLoadPlan` string: The UDL ID of the air load plan this item is associated with. - `scanCode` string, required: The tracking identifier of an item or person. May be similar in representation of a barcode or UPC. If no scanCode or tracking number equivalent is available, 'NONE' should be used. - `scGenTool` string: The algorithm name or standard that generated the scanCode (e.g. UPC-A, EAN-13, GTIN, SSCC, bID, JAN, etc.). - `type` string, required: The item type of this record (e.g. EQUIPMENT, CARGO, PASSENGER). - `cargoType` string: The type of cargo (e.g. PALLET, ROLLING STOCK, LOOSE, OTHER). Applicable for cargo item types only. - `name` string: Name of the item. Applicable for equipment and cargo item types only. - `destination` string: The destination of the item, typically an ICAO or port code. Applicable for cargo and passenger item types only. - `departure` string: The departure code or location where this item has left or is leaving. - `receivingUnit` string: The name of the unit receiving this item. - `receivingBranch` string: The military branch receiving this item. - `lastArrDate` string, date: The latest acceptable arrival date of the item at the destination, in ISO 8601 date-only format (e.g. YYYY-MM-DD). - `uln` string: The unit line number of this item. - `weight` number, double: Weight of the item in kilograms (if item is a passenger, include on-person bags). - `weightTS` string, date-time: Timestamp when the weight was taken, in ISO 8601 UTC format with millisecond precision. - `commodityCode` string: The classification code of the commodity or group of commodities. - `commoditySys` string: The classification system denoting the commodity code, commodityCode (e.g. AIR, WATER, NMFC, UFC, STCC, DODUNQ, etc.). - `productCode` string: The code denoting the type of material item. - `productSys` string: The assigning system that denotes the type of material item, productCode (e.g. NSN-national stock number, NDC-national drug code, MPN-manufacturer part number, etc.). - `width` number, double: Width of the cargo in meters. Applicable for cargo item types only. - `length` number, double: Length of the cargo in meters. Applicable for cargo item types only. - `height` number, double: Height of the cargo in meters. Applicable for cargo item types only. - `volume` number, double: The volume of the item, in cubic meters. Applicable for cargo item types only. - `cg` number, double: Center of gravity position of the item, measured from the item's front datum, in centimeters. - `fs` number, double: The fuselage station of the item measured from the reference datum, in centimeters. Applicable for cargo and passenger item types only. - `centerlineOffset` number, double: How far left or right of centerline is the item in meters. Applicable for cargo and passenger item types only. - `moment` number, double: Moment of the item in Newton-meters. Applicable for equipment and cargo item types only. - `airdrop` boolean: Flag indicating this item is planned to be airdropped. Applicable for cargo and passenger item types only. - `tcn` string: Transportation Control Number of the cargo. Applicable for cargo item types only. - `hazCodes` number[]: Array of UN hazard classes or division codes that apply to this item. - `netExpWt` number, double: Net explosive weight of the item, in kilograms. - `container` boolean: Flag indicating this item acts as a container and contains additional items. - `itemContains` string[]: Array of tracking identifiers that are contained within this item. - `numPalletPos` integer: Number of pallet positions or equivalent on the aircraft, ship, or conveyance equipment that this item occupies. - `dvCode` string: United States Distinguished Visitor Code, only applicable to people. - `notes` string: Optional notes or comments about this item. - `keys` string[]: Array of keys that may be associated to this item. The entries in this array must correspond to the position index in the values array. This array must be the same length as values.. - `values` string[]: Array of values for the keys that may be associated to this tracked item. The entries in this array must correspond to the position index in the keys array. This array must be the same length as keys. - `altDataFormat` string: Name of the additional data format so downstream consuming applications can know how to parse it. Typically includes the source system name and the format name. - `accSystem` string: Name of the system that accepted this item from a customer. Where a user or application could go look for additional information. - `accSysNotes` string: Additional data required to find this item in the accepting system. - `accSysKeys` string[]: Array of keys that may be associated to the accepting system data. The entries in this array must correspond to the position index in accSysValues array. This array must be the same length as accSysValues. - `accSysValues` string[]: Array of values for the keys that may be associated to the accepting system data. The entries in this array must correspond to the position index in accSysKeys array. This array must be the same length as accSysKeys. - `createdAt` string, date-time: Time the row was created in the database, auto-populated by the system. - `createdBy` string: Application user who created the row in the database, auto-populated by the system. - `sourceDL` string: The source data library from which this record was received. This could be a remote or tactical UDL or another data library. If null, the record should be assumed to have originated from the primary Enterprise UDL. - `source` string, required: Source of the data. - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets. ## Response `201` Success ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `415`: MediaType Unsupported - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2025-04-16** `75f764c843a9`: 2 info - api operation id `create_54` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/item/post.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)