- API Reference
- Access Points
- API Calls
- Batches
- Bins
- Carriers
- Clients
- Cost Centers
- Images (Supplements)
- Kits
- Kit Lines
- Locations
- Location Contents
- Materials
- Material Codes
- Material Properties
- Orders
- Order Lines
- Reports
- Report Rows
- Settings
- Shelves
- Snapshots
- Stations
- Storage Rules
- Storage Units
- Transactions
- Users
- Warehouses
- Work Order Lines
- Zones
Images (Supplements)
Supplemental image files for a material or material family.
Attributes
-
materialId
uuid
Unique identifier for the material.
-
name
string
Optional unique name for the supplement.
Default value: If a name is not provided, the file name (without extension) is used.
-
type
integer
The file type or extension.
-
classification
integer
Classification type of what the image contains.
Possible values:
1 = Material
2 = Bin
3 = Shelf
5 = Material Family -
origin
string
The path to the original file.
-
hyperlink
string
Hyperlink or path to the file.
Endpoints
List Images (Supplements)
get /api/imagesGet a list of all supplemental images for materials, locations, or material families.
Arguments
-
materialId
uuid
Unique identifier for the material.
-
name
string
Optional unique name for the supplement. If a name is not provided, the file name (without extension) is used.
-
type
integer
The file type or extension.
-
classification
integer
Classification type of what the image contains.
Possible values:
1 = Material
2 = Bin
3 = Shelf
5 = Material Family -
origin
string
The path to the original file.
-
hyperlink
string
Hyperlink or path to the file.
-
limit
integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000.
Default value: 250
-
page
integer
Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.
-
countOnly
boolean
When "true", will only return a count of the amount of items in the query.
Default value: false
{ "images": [ { "classification": 1, "hyperlink": "C:\\PPG\\Images\\1101.jpg", "id": "F5DE1AC1-559D-4FE7-92C2-D78DA636D2C4", "materialId": "D09020B2-CD59-4BB1-B971-926A4007873C", "name": "1101", "origin": "C:\\PPG\\Images\\1101.jpg", "type": 3 }, { "classification": 1, "hyperlink": "C:\\PPG\\Images\\1102.jpg", "id": "733A116E-CB3C-4C6B-98D9-87E0FDD27084", "materialId": "56C557D7-E526-4B42-A024-BA35D08AB46D", "name": "1102", "origin": "C:\\PPG\\Images\\1102.jpg", "type": 3 } ] }
Show Image (Supplement)
get /api/images/[ID]Get a supplemental image by calling its ID.
Arguments
{ "image": { "classification": 1, "hyperlink": "C:\\PPG\\Images\\1101.jpg", "id": "F5DE1AC1-559D-4FE7-92C2-D78DA636D2C4", "materialId": "D09020B2-CD59-4BB1-B971-926A4007873C", "name": "1101", "origin": "C:\\PPG\\Images\\1101.jpg", "type": 3 } }