Image Entity Types: GetImageUploadUrlInput and ImageDefintion

[This topic is pre-release documentation and is subject to change.]

Image data is typically uploaded into Azure blobs and associated with primary entity types, such as Profile and Interaction, to enrich the user-interface experience. The type GetImageUploadUrlInput contains the information to associate an uploaded image to an existing type; whereas ImageDefintion contains the full details needed to retrieve that image.

GetImageUploadUrlInput properties

Properties

Property JSON type Description
entityType string Entity type that the image is associated with, currently ["Profile"
entityTypeName string Name of the specific type to associate the image to
relativePath string Relative path used to store/retrieve/reference the image

JSON example

{ 
    "entityType": "Profile1", 
    "entityTypeName":"Contact1", 
    "relativePath":"myimages/image1.jpeg" 
}


ImageDefintion properties

Properties

Property JSON type Description
contentUrl string Shared Access Signature (SAS) URI of the blob with create and write permissions
imageExists Bool True if the image exists at the specified blob location, otherwise False
relativePath string Relative path used to store/retrieve/reference the image

JSON example

{   
    "contentUrl":
        "https://storageaccountname.blob.core.windows.net/images/entitytypeimage/<hubGuid>/<EntityType>/<EntityTypeName>/<RelativePath>", 
    "imageExists":"false", 
    "relativePath":"myimages/image1.jpeg" }