194 lines
6.7 KiB
Markdown
194 lines
6.7 KiB
Markdown
# Unit import / update specifications
|
|
|
|
Names of fields listed here are the exact case and spelling required to be recognized by AyaNova for [importing / updating](adm-import.md).
|
|
|
|
Any field in the import file that is not listed on this page will be removed before sending to the server for import.
|
|
|
|
## Required fields
|
|
|
|
- Serial
|
|
- CustomerViz
|
|
|
|
## Key field used to match to existing records
|
|
|
|
- Serial
|
|
|
|
## Fields directly importable / updateable
|
|
|
|
- Serial (import only)
|
|
- Active
|
|
- Notes
|
|
- Wiki
|
|
- Tags
|
|
- UnitHasOwnAddress
|
|
- BoughtHere
|
|
- Receipt
|
|
- PurchasedDate
|
|
- Description
|
|
- OverrideModelWarranty
|
|
- WarrantyLength
|
|
- WarrantyTerms
|
|
- ContractExpires
|
|
- Metered
|
|
- LifeTimeWarranty
|
|
- Text1
|
|
- Text2
|
|
- Text3
|
|
- Text4
|
|
- Address
|
|
- City
|
|
- Region
|
|
- Country
|
|
- Latitude
|
|
- Longitude
|
|
|
|
## Linked object fields
|
|
|
|
The following linked objects are importable / updateable:
|
|
|
|
- Customer owner of unit via "CustomerViz" which must contain the name of an existing customer and is **required**
|
|
- Unit that is the "parent" of this unit via "ParentUnitViz" which must contain the serial of an existing unit
|
|
- Unit model via "UnitModelNameViz" which must contain an existing Unit model name
|
|
- Vendor the unit was purchased from via "PurchasedFromVendorViz" field which must contain the name of an existing Vendor
|
|
- Unit that is the replacement of this unit via "ReplacedByUnitViz" which must contain the serial of an existing unit
|
|
- Contract via "ContractViz" field which must contain the name of an existing Contract
|
|
|
|
If the Contract is specified then the ContractExpires field can be used to set the expiry date of the Contract.
|
|
If ContractExpires is omitted then it is set to the import date and time minus 1 minute so that it won't take effect until it's been set to a future date.
|
|
|
|
## JSON file format
|
|
|
|
The .json file must contain an array of one or more Unit objects.
|
|
|
|
```JSON
|
|
[
|
|
{
|
|
"Active": true,
|
|
"Notes": "Magni est consequatur itaque atque explicabo quibusdam debitis reprehenderit.",
|
|
"Wiki": null,
|
|
"Tags": [
|
|
"jade",
|
|
"zone0"
|
|
],
|
|
"Serial": "00897259",
|
|
"CustomerViz": "Stanton, Wiza and Hahn",
|
|
"ParentUnitViz": null,
|
|
"UnitModelNameViz": "Ranchero Garden - 625229",
|
|
"UnitHasOwnAddress": true,
|
|
"BoughtHere": false,
|
|
"PurchasedFromVendorViz": "Considine Group",
|
|
"Receipt": "599307",
|
|
"PurchasedDate": "2020-05-31T21:07:05.099769Z",
|
|
"Description": "Ergonomic Metal Car",
|
|
"ReplacedByUnitViz": null,
|
|
"OverrideModelWarranty": false,
|
|
"WarrantyLength": null,
|
|
"WarrantyTerms": null,
|
|
"ContractViz": "Bronze",
|
|
"ContractExpires": "2023-03-27T18:44:21.679721Z",
|
|
"Metered": false,
|
|
"LifeTimeWarranty": false,
|
|
"Text1": "21491466",
|
|
"Text2": null,
|
|
"Text3": null,
|
|
"Text4": null,
|
|
"Address": "6036 Reggie Pine",
|
|
"City": "South Velva",
|
|
"Region": "Georgia",
|
|
"Country": "Chile",
|
|
"Latitude": 41.188300,
|
|
"Longitude": -152.686600
|
|
},
|
|
{
|
|
"Active": true,
|
|
"Notes": "Ullam magni voluptatum numquam pariatur consectetur accusantium accusantium excepturi.",
|
|
"Wiki": null,
|
|
"Tags": [
|
|
"red",
|
|
"zone0"
|
|
],
|
|
"Serial": "01052815",
|
|
"CustomerViz": "Gulgowski Group",
|
|
"ParentUnitViz": null,
|
|
"UnitModelNameViz": "Fiesta Toys - 144172",
|
|
"UnitHasOwnAddress": false,
|
|
"BoughtHere": false,
|
|
"PurchasedFromVendorId": 4,
|
|
"PurchasedFromVendorViz": "Weimann Group",
|
|
"Receipt": "123706",
|
|
"PurchasedDate": "2018-02-02T18:22:09.24824Z",
|
|
"Description": "Intelligent Plastic Gloves",
|
|
"ReplacedByUnitViz": null,
|
|
"OverrideModelWarranty": false,
|
|
"WarrantyLength": null,
|
|
"WarrantyTerms": null,
|
|
"ContractViz": null,
|
|
"ContractExpires": null,
|
|
"Metered": false,
|
|
"LifeTimeWarranty": false,
|
|
"Text1": null,
|
|
"Text2": null,
|
|
"Text3": null,
|
|
"Text4": null,
|
|
"Address": null,
|
|
"City": null,
|
|
"Region": null,
|
|
"Country": null,
|
|
"Latitude": null,
|
|
"Longitude": null
|
|
},
|
|
{
|
|
"Active": true,
|
|
"Notes": "Deleniti et cupiditate qui corrupti aut eius.",
|
|
"Wiki": null,
|
|
"CustomFields": null,
|
|
"Tags": [
|
|
"black",
|
|
"blue",
|
|
"violet",
|
|
"white",
|
|
"zone9"
|
|
],
|
|
"Serial": "01367224",
|
|
"CustomerViz": "O'Hara LLC",
|
|
"ParentUnitViz": null,
|
|
"UnitModelNameViz": "Challenger Music - 926816",
|
|
"UnitHasOwnAddress": false,
|
|
"BoughtHere": false,
|
|
"PurchasedFromVendorViz": "Weimann Group",
|
|
"Receipt": "714259",
|
|
"PurchasedDate": "2019-05-31T23:35:01.24309Z",
|
|
"Description": "Gorgeous Cotton Bike",
|
|
"ReplacedByUnitViz": null,
|
|
"OverrideModelWarranty": false,
|
|
"WarrantyLength": null,
|
|
"WarrantyTerms": null,
|
|
"ContractViz": null,
|
|
"ContractExpires": null,
|
|
"Metered": false,
|
|
"LifeTimeWarranty": false,
|
|
"Text1": null,
|
|
"Text2": null,
|
|
"Text3": null,
|
|
"Text4": null,
|
|
"Address": null,
|
|
"City": null,
|
|
"Region": null,
|
|
"Country": null,
|
|
"Latitude": null,
|
|
"Longitude": null
|
|
}
|
|
]
|
|
```
|
|
|
|
## CSV file format
|
|
|
|
The first row of the .csv file must contain column headers that match the field names listed above.
|
|
|
|
```
|
|
Active,Notes,Wiki,Tags,Serial,CustomerViz,ParentUnitViz,UnitModelNameViz,UnitHasOwnAddress,BoughtHere,PurchasedFromVendorViz,Receipt,PurchasedDate,Description,ReplacedByUnitViz,OverrideModelWarranty,WarrantyLength,WarrantyTerms,ContractViz,ContractExpires,Metered,LifeTimeWarranty,Text1,Text2,Text3,Text4,Address,City,Region,Country,Latitude,Longitude
|
|
true,Magni est consequatur itaque atque explicabo quibusdam debitis reprehenderit.,,"jade,zone0",00897259,"Stanton, Wiza and Hahn",,Ranchero Garden - 625229,true,false,Considine Group,599307,2020-05-31T21:07:05.099769Z,Ergonomic Metal Car,,false,,,Bronze,2023-03-27T18:44:21.679721Z,false,false,21491466,,,,6036 Reggie Pine,South Velva,Georgia,Chile,41.1883,-152.6866
|
|
true,Ullam magni voluptatum numquam pariatur consectetur accusantium accusantium excepturi.,,"red,zone0",01052815,Gulgowski Group,,Fiesta Toys - 144172,false,false,Weimann Group,123706,2018-02-02T18:22:09.24824Z,Intelligent Plastic Gloves,,false,,,,,false,false,,,,,,,,,,
|
|
true,Deleniti et cupiditate qui corrupti aut eius.,,"black,blue,violet,white,zone9",01367224,O'Hara LLC,,Challenger Music - 926816,false,false,Weimann Group,714259,2019-05-31T23:35:01.24309Z,Gorgeous Cotton Bike,,false,,,,,false,false,,,,,,,,,,
|
|
```
|