RetailImageResource in Miscellaneous

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	RetailImageResource/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.0"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

Attributes

Name	Description	First Included in Instance
RecId		Miscellaneous/RetailImageResource
ResourceId		Miscellaneous/RetailImageResource
ResourceUrl		Miscellaneous/RetailImageResource
IsPartialUrl		Miscellaneous/RetailImageResource
ResourceBlob		Miscellaneous/RetailImageResource
FileName		Miscellaneous/RetailImageResource
Description		Miscellaneous/RetailImageResource
SizeInKB		Miscellaneous/RetailImageResource
InUse		Miscellaneous/RetailImageResource
IsSecuredResource		Miscellaneous/RetailImageResource
SharedStorageId		Miscellaneous/RetailImageResource
IsExternallyHosted		Miscellaneous/RetailImageResource
InstanceRelationType		Miscellaneous/RetailImageResource
ThumbnailUrl		Miscellaneous/RetailImageResource
SmallImageUrl		Miscellaneous/RetailImageResource
ThumbnailBlob		Miscellaneous/RetailImageResource
SmallImageBlob		Miscellaneous/RetailImageResource
ThumbnailSharedStorageId		Miscellaneous/RetailImageResource
SmallImageSharedStorageId		Miscellaneous/RetailImageResource
Width		Miscellaneous/RetailImageResource
Height		Miscellaneous/RetailImageResource
IsPos		Miscellaneous/RetailImageResource
IsCatalog		Miscellaneous/RetailImageResource
IsCategory		Miscellaneous/RetailImageResource
IsProduct		Miscellaneous/RetailImageResource
IsWorker		Miscellaneous/RetailImageResource
IsCustomer		Miscellaneous/RetailImageResource

RecId

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	RetailImageResource/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

ResourceId

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Media ID
dataFormat	int32

Traits

List of traits for the ResourceId attribute are listed below.

is.dataFormat.integer
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Media ID	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ResourceUrl

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	URL
dataFormat	string
isNullable	true

Traits

List of traits for the ResourceUrl attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en URL	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

IsPartialUrl

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Absolute Url
dataFormat	int32
isNullable	true

Traits

List of traits for the IsPartialUrl attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Absolute Url	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ResourceBlob

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Image Blob
dataFormat	binary
isNullable	true

Traits

List of traits for the ResourceBlob attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Image Blob	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.byte
is.dataFormat.array

FileName

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	File name
dataFormat	string
isNullable	true

Traits

List of traits for the FileName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en File name	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

Description

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Description
dataFormat	string
isNullable	true

Traits

List of traits for the Description attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Description	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

SizeInKB

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Size (KB)
dataFormat	int32
isNullable	true

Traits

List of traits for the SizeInKB attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Size (KB)	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

InUse

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Currently in use
dataFormat	int32
isNullable	true

Traits

List of traits for the InUse attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Currently in use	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsSecuredResource

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the IsSecuredResource attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

SharedStorageId

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Shared Storage Id
dataFormat	guid
isNullable	true

Traits

List of traits for the SharedStorageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shared Storage Id	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

IsExternallyHosted

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Externally hosted
dataFormat	int32
isNullable	true

Traits

List of traits for the IsExternallyHosted attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Externally hosted	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

InstanceRelationType

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the InstanceRelationType attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

ThumbnailUrl

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Thumbnail URL
dataFormat	string
isNullable	true

Traits

List of traits for the ThumbnailUrl attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Thumbnail URL	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

SmallImageUrl

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	SmallImage URL
dataFormat	string
isNullable	true

Traits

List of traits for the SmallImageUrl attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en SmallImage URL	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

ThumbnailBlob

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Thumbnail Blob
dataFormat	binary
isNullable	true

Traits

List of traits for the ThumbnailBlob attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Thumbnail Blob	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.byte
is.dataFormat.array

SmallImageBlob

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	SmallImage Blob
dataFormat	binary
isNullable	true

Traits

List of traits for the SmallImageBlob attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en SmallImage Blob	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.byte
is.dataFormat.array

ThumbnailSharedStorageId

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Shared Storage Id
dataFormat	guid
isNullable	true

Traits

List of traits for the ThumbnailSharedStorageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shared Storage Id	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

SmallImageSharedStorageId

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Shared Storage Id
dataFormat	guid
isNullable	true

Traits

List of traits for the SmallImageSharedStorageId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Shared Storage Id	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array

Width

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Width
dataFormat	int32
isNullable	true

Traits

List of traits for the Width attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Width	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Height

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Height
dataFormat	int32
isNullable	true

Traits

List of traits for the Height attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Height	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsPos

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Point of sale
dataFormat	int32
isNullable	true

Traits

List of traits for the IsPos attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Point of sale	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsCatalog

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Catalogs
dataFormat	int32
isNullable	true

Traits

List of traits for the IsCatalog attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Catalogs	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsCategory

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Categories
dataFormat	int32
isNullable	true

Traits

List of traits for the IsCategory attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Categories	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsProduct

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Products
dataFormat	int32
isNullable	true

Traits

List of traits for the IsProduct attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Products	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsWorker

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Workers
dataFormat	int32
isNullable	true

Traits

List of traits for the IsWorker attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Workers	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsCustomer

First included in: Miscellaneous/RetailImageResource (this entity)

Properties

Name	Value
displayName	Customers
dataFormat	int32
isNullable	true

Traits

List of traits for the IsCustomer attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Customers	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer