1. Resource Central
  2. arrow-right
  3. Images (Supplements)

Images (Supplements)

Supplemental image files for a material or material family.

Attributes

  • name string

    Optional unique name for the supplement.

    Default value: If a name is not provided, the file name (without extension) is used.

  • id uuid

    Unique identifier of the image.

  • classification integer

    Classification type of what the image contains.

    Possible values:

    1 = Material
    2 = Bin
    3 = Shelf
    5 = Material Family

  • hyperlink string

    Hyperlink or path to the file.

  • materialId uuid

    Unique identifier for the material.

  • origin string

    The path to the original file.

  • type integer

    The file type or extension.

Endpoints

List Images (Supplements) /api/images
get

Get a list of all supplemental images for materials, locations, or material families. View the guide on adding filters to List API calls.

Body Parameters

  • classification integer

    Classification type of what the image contains.

    Possible values:

    1 = Material
    2 = Bin
    3 = Shelf
    5 = Material Family

  • hyperlink string

    Hyperlink or path to the file.

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

  • origin string

    The path to the original file.

  • type integer

    The file type or extension.

  • countOnly boolean

    When "true", will only return a count of the amount of items in the query.

    Default value:

    false

  • limit integer

    A limit on the number of objects to be returned.

    Default value:

    1000

  • page integer

    Page numbering is zero-based and uses the value of the "limit" argument. (For example, if limit=20, then page=0 will display the hits from 1 to 20.)

  • orderBy string, array

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/images" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{
    "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) /api/images/[ID]
get

Get a supplemental image by calling its ID.

Body Parameters

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/images/[ID]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
    "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
    }
}