Get
/ci-rest-api/jersey/v1/inventory-location/B710F10A4359F940E053508010ACC979
Get Location by VUUID
Overview
Retrieves a CI Inventory Location using its unique VUUID.
If the record exists and the user has access, the full location details are returned.
Notes
The VUUID must be valid.
Authentication and authorization are required.
If the location does not exist or is not accessible, an appropriate error is returned.
UI Navigation
Asset Management→ Inventory → Setup → Local Tables → Inventory Locations
Finders
The following finders are available for data filtering and optimizing request performance.
- N/A (This endpoint retrieves a single record by primary key)
HTTP Method & Endpoint
Method: GET
Endpoint:
/ci-rest-api/jersey/v1/inventory-location/{Vuuid}
Path Parameters
| Parameter | Description | Example |
|---|---|---|
| Vuuid | Unique identifier of the CI Location | B710F10A4359F940E053508010ACC979 |
Example Request
GET /ci-rest-api/jersey/v1/inventory-location/B710F10A4359F940E053508010ACC979
Attributes
The request body must contain an items array.
Each object in the array represents one inventory location to be created.
All attributes are listed below for completeness.
Only attributes marked as Mandatory = True are required during creation.
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Mandatory |
|---|---|---|---|---|---|---|---|
| CilocCompCode | cilocation | cilocCompCode | Company code for the inventory location | String | 8 | CL02 | True |
| CilocCode | cilocation | cilocCode | Unique inventory location code | String | 7 | DRLC01 | True |
| CilocName | cilocation | cilocName | Name or description of the inventory location | String | 60 | Main Warehouse - Bin 01 | True |
| CilocDeptCode | cilocation | cilocDeptCode | Department code associated with the location | String | 6 | 00 | True |
| CilocTypeCode | cilocation | cilocTypeCode | Inventory location type (W = Warehouse, B = Bin) | String | 1 | W | True |
| CilocCtrlCode | cilocation | cilocCtrlCode | Control code for bin locations (required only when type is B) | String | 7 | BIN01 | Conditional |
| CilocBinCtrlFlag | cilocation | cilocBinCtrlFlag | Indicates whether bin control is enabled (Y/N) | String | 1 | Y | False |
| CilocPctUsed | cilocation | cilocPctUsed | Percentage of storage capacity used | Number | 6,2 | 0.00 | False |
| CilocDeptDistFlag | cilocation | cilocDeptDistFlag | Department distribution flag (Y/N) | String | 1 | N | True |
| CilocHier | cilocation | cilocHier | Hierarchical structure of the inventory location | String | 255 | WH1/BIN1 | False |
| CilocInvSerCode | cilocation | cilocInvSerCode | Inventory serialization code | String | 4 | SER1 | False |
| CilocMszoneCode | cilocation | cilocMszoneCode | Material staging zone code | String | 10 | ZONE1 | False |
| CilocIuCreateDate | cilocation | cilocIuCreateDate | Date and time when the record is created | String | N/A | System generated | False |
| CilocIuCreateUser | cilocation | cilocIuCreateUser | User who created the inventory location | String | 30 | System user | False |
| CilocIuUpdateDate | cilocation | cilocIuUpdateDate | Date and time of last update | String | N/A | System generated | False |
| CilocIuUpdateUser | cilocation | cilocIuUpdateUser | User who last updated the record | String | 30 | System user | False |
| CilocVUuid | cilocation | cilocVUuid | Virtual unique identifier generated by the system | String | 64 | Generated | False |
Security
HTTP
Type basic
Basic authentication
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
"{\n \"cilocCompCode\": \"RV1\",\n \"cilocCode\": \"WHSE1\",\n \"cilocName\": \"Warehouse 1\",\n \"cilocDeptCode\": \"00\",\n \"cilocTypeCode\": \"W\",\n \"cilocCtrlCode\": null,\n \"cilocBinCtrlFlag\": \"N\",\n \"cilocPctUsed\": null,\n \"cilocDeptDistFlag\": \"N\",\n \"cilocHier\": \"RV1 .WHSE1 .\",\n \"cilocInvSerCode\": null,\n \"cilocMszoneCode\": null,\n \"cilocIuCreateDate\": \"2011-01-04T13:42:27-05:00\",\n \"cilocIuUpdateDate\": \"2023-05-24T15:54:46-04:00\",\n \"cilocVUuid\": \"B710F10A4359F940E053508010ACC979\"\n}"string