Jump to

• Request
• Response

Get List of Product Family Menu Item Image Definitions

get

/rest/v16/allProductFamilySetups/{varName}/productFamilies/{prodFamVarName}/attributes/{attributeVarName}/menuItems/{menuItem_Id}/images

Use this endpoint to retrieve a list of definitions for Product Family attribute menu item images.

Request

Supported Media Types

• application/json

Path Parameters

• attributeVarName(required): string
  Variable Name of the Attribute
• menuItem_Id(required): integer
  Primary Key of the Resource
• prodFamVarName(required): string
  Variable Name of the Product Family.
• varName(required): string
  Variable Name of All Product Families '_allProductFamilies'

Query Parameters

• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return.
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : configMenuItemImages-collection

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/configMenuItemImages"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Config Menu Item Images
  Title: Config Menu Item Images

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/configMenuItemImages"
    }
}

Nested Schema : Config Menu Item Images

Type: object

Title: Config Menu Item Images

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Primary Key of the Resource
• imageUrl1: string
  Title: Image URL 1

  Image URL 1

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the Resource",
            "title":"Id"
        },
        "imageUrl1":{
            "type":"string",
            "description":"Image URL 1",
            "title":"Image URL 1"
        }
    },
    "title":"Config Menu Item Images"
}

Back to Top