AirOperations

PUT /udl/item/{id}

Changed on Apr 16, 2025

Service operation to update a single Item. An Item can be cargo, equipment, or a passenger. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

Base URL
https://unifieddatalibrary.com
URL
https://unifieddatalibrary.com/udl/item/{id}
Auth
none declared

Path parameters

idstring required

The ID of the Item to update.

Request body

idstring

Unique identifier of the record, auto-generated by the system if not provided on create operations.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

idAirLoadPlanstring

The UDL ID of the air load plan this item is associated with.

scanCodestring 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.

scGenToolstring

The algorithm name or standard that generated the scanCode (e.g. UPC-A, EAN-13, GTIN, SSCC, bID, JAN, etc.).

typestring required

The item type of this record (e.g. EQUIPMENT, CARGO, PASSENGER).

cargoTypestring

The type of cargo (e.g. PALLET, ROLLING STOCK, LOOSE, OTHER). Applicable for cargo item types only.

namestring

Name of the item. Applicable for equipment and cargo item types only.

destinationstring

The destination of the item, typically an ICAO or port code. Applicable for cargo and passenger item types only.

departurestring

The departure code or location where this item has left or is leaving.

receivingUnitstring

The name of the unit receiving this item.

receivingBranchstring

The military branch receiving this item.

lastArrDatestring date

The latest acceptable arrival date of the item at the destination, in ISO 8601 date-only format (e.g. YYYY-MM-DD).

ulnstring

The unit line number of this item.

weightnumber double

Weight of the item in kilograms (if item is a passenger, include on-person bags).

weightTSstring date-time

Timestamp when the weight was taken, in ISO 8601 UTC format with millisecond precision.

commodityCodestring

The classification code of the commodity or group of commodities.

commoditySysstring

The classification system denoting the commodity code, commodityCode (e.g. AIR, WATER, NMFC, UFC, STCC, DODUNQ, etc.).

productCodestring

The code denoting the type of material item.

productSysstring

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.).

widthnumber double

Width of the cargo in meters. Applicable for cargo item types only.

lengthnumber double

Length of the cargo in meters. Applicable for cargo item types only.

heightnumber double

Height of the cargo in meters. Applicable for cargo item types only.

volumenumber double

The volume of the item, in cubic meters. Applicable for cargo item types only.

cgnumber double

Center of gravity position of the item, measured from the item's front datum, in centimeters.

fsnumber double

The fuselage station of the item measured from the reference datum, in centimeters. Applicable for cargo and passenger item types only.

centerlineOffsetnumber double

How far left or right of centerline is the item in meters. Applicable for cargo and passenger item types only.

momentnumber double

Moment of the item in Newton-meters. Applicable for equipment and cargo item types only.

airdropboolean

Flag indicating this item is planned to be airdropped. Applicable for cargo and passenger item types only.

tcnstring

Transportation Control Number of the cargo. Applicable for cargo item types only.

hazCodesnumber[]

Array of UN hazard classes or division codes that apply to this item.

netExpWtnumber double

Net explosive weight of the item, in kilograms.

containerboolean

Flag indicating this item acts as a container and contains additional items.

itemContainsstring[]

Array of tracking identifiers that are contained within this item.

numPalletPosinteger

Number of pallet positions or equivalent on the aircraft, ship, or conveyance equipment that this item occupies.

dvCodestring

United States Distinguished Visitor Code, only applicable to people.

notesstring

Optional notes or comments about this item.

keysstring[]

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..

valuesstring[]

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.

altDataFormatstring

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.

accSystemstring

Name of the system that accepted this item from a customer. Where a user or application could go look for additional information.

accSysNotesstring

Additional data required to find this item in the accepting system.

accSysKeysstring[]

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.

accSysValuesstring[]

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.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourceDLstring

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.

sourcestring required

Source of the data.

originstring

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.

origNetworkstring

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.

Example request

{
  "id": "22f1f6da-a568-655a-ea37-76d013d04853",
  "classificationMarking": "U",
  "idAirLoadPlan": "1038c389-d38e-270f-51cc-6a12e905abe8",
  "scanCode": "12345ABCD",
  "scGenTool": "bID",
  "type": "CARGO",
  "cargoType": "PALLET",
  "name": "Product Name",
  "destination": "RMS",
  "departure": "CHS",
  "receivingUnit": "50 SBN",
  "receivingBranch": "Air Force",
  "lastArrDate": "2023-03-13",
  "uln": "T01ME01",
  "weight": 5443.335,
  "weightTS": "2023-03-13T16:06:00.123Z",
  "commodityCode": "2304116",
  "commoditySys": "STCC",
  "productCode": "530500234",
  "productSys": "NSN",
  "width": 1.1,
  "length": 1.1,
  "height": 1.1,
  "volume": 7.8902,
  "cg": 112.014,
  "fs": 412.1,
  "centerlineOffset": 3.1,
  "moment": 4000.1,
  "airdrop": true,
  "tcn": "M1358232245912XXX",
  "hazCodes": [
    1.1,
    1.2
  ],
  "netExpWt": 51.437,
  "container": true,
  "itemContains": [
    "2UJ8843K",
    "745YV1T65"
  ],
  "numPalletPos": 2,
  "dvCode": "DV-2",
  "notes": "Example notes",
  "keys": [
    "key1",
    "key2"
  ],
  "values": [
    "value1",
    "value2"
  ],
  "altDataFormat": "Alt Data Format",
  "accSystem": "Accepting System",
  "accSysNotes": "Accepting System Notes",
  "accSysKeys": [
    "System key1",
    "System key2"
  ],
  "accSysValues": [
    "System value1",
    "System value2"
  ],
  "createdAt": "2023-03-21T16:00:00.123Z",
  "createdBy": "some.user",
  "sourceDL": "AXE",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST"
}

Response

Success

Changes

Apr 16, 202575f764c843a9 Revision changes
- info
  api operation id edit_31 removed and replaced with
- info
  the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.

Operation history