Aforza Developer Portal

AssignedToWorkflowDetailsModel

workflowId

string · uuid · readOnly · required

name

string · readOnly · required

ErrorCodeEnum

string · enum

Enum values:

ACTIVE_SPACE_PROTECTED

ARCHIVED_SPACE_PROTECTED

ASSIGNED_TO_WORKFLOW

DATABASE

DEFAULT_SPACE_PROTECTED

DEFAULT_USER_SPACE_PROTECTED

DUPLICATE_REQUEST

ENTITY_NAME_CONFLICT

ErrorResponse

statusCode

number · readOnly · required

error

string · readOnly · required

readOnly

errorCode

string · enum · readOnly

Enum values:

ACTIVE_SPACE_PROTECTED

ARCHIVED_SPACE_PROTECTED

ASSIGNED_TO_WORKFLOW

DATABASE

DEFAULT_SPACE_PROTECTED

DEFAULT_USER_SPACE_PROTECTED

DUPLICATE_REQUEST

ENTITY_NAME_CONFLICT

array · readOnly

CreateAssetRequest

file

file · required

name

string · minLength: 1 · maxLength: 256

Defaults to filename if not provided

description

string · minLength: 1 · maxLength: 512

publicTags

string

Comma separated string of tags to attach to the asset. New tags are created if they do not exist.

folderId

string

The ID of the folder to store the asset in

attributes

string

JSON encoded AttributeEntry[]

Example: JSON.stringify([{ name: 'name', value: 'value', dataType: 'STRING' }])

UserModel

userId

string · readOnly · required

isActive

boolean · readOnly · required

email

string

firstName

string

lastName

string

displayName

string

salesforceId

string

avatarUrl

string

ContentType

string · enum

Enum values:

DOCUMENT

PRESENTATION

SPREADSHEET

IMAGE

AR

AUDIO

VIDEO

NOTFOUND

VersionStatus

string · enum

Enum values:

UPLOADING

UPLOADED

COMPOSING

COMPOSED

SCANNING

SCANNED

QUARANTINED

VALIDATING

ImageMetadataModel

height

number · readOnly · required

width

number · readOnly · required

ObjectsModel

count

number · readOnly · required

countPercent

number · readOnly · required

countPercentDisplay

number · readOnly · required

countRatio

number · readOnly · required

ShareModel

count

number · readOnly · required

countPercent

number · readOnly · required

countPercentDisplay

number · readOnly · required

countRatio

number · readOnly · required

ProductModel

name

string · readOnly · required

productUuid

string · readOnly · required

object · readOnly · required

barcode

string · readOnly

brand

string · readOnly

customId

string · readOnly

subtype

string · readOnly

object · readOnly

VertexModel

x

number · readOnly · required

y

number · readOnly · required

DetectionModel

name

string · readOnly · required

productUuid

string · readOnly · required

count

number · readOnly · required

barcode

string · readOnly

brand

string · readOnly

customId

string · readOnly

subtype

string · readOnly

object · readOnly

UnknownDetectionModel

name

string · readOnly · required

count

number · readOnly · required

object · readOnly

TotalsModel

allFacings

number · readOnly · required

brandFacings

number · readOnly · required

shareOfShelfPercent

number · readOnly · required

shareOfShelfPercentDisplay

number · readOnly · required

ShareOfShelfVendorEnum

string · enum

Enum values:

NEUROLABS

PARALLELDOTS

ShareOfShelfDetailsModel

object · readOnly · required

object[] · readOnly · required

object · readOnly · required

vendor

string · enum · readOnly · required

Enum values:

NEUROLABS

PARALLELDOTS

object[] · readOnly

vendorUrl

string · readOnly

GoogleVisionAnnotationInfoModel

count

number · readOnly · required

description

string · readOnly · required

percent

number · readOnly · required

object · readOnly · required

TextDetectionDetailsModel

countLowest

number · readOnly · required

countHighest

number · readOnly · required

countTotal

number · readOnly · required

object[] · readOnly · required

fullText

string · readOnly · required

TextDetectionMatchInfoModel

phrase

string · readOnly · required

count

number · readOnly · required

matcherPercent

number · readOnly · required

totalPercent

number · readOnly · required

object · readOnly · required

TextDetectionMatcherResultModel

label

string · readOnly · required

color

string · readOnly · required

object[] · readOnly · required

TextDetectionTotalsMatcherModel

label

string · readOnly · required

percent

number · readOnly · required

percentDisplay

number · readOnly · required

total

number · readOnly · required

TextDetectionTotalsModel

all

number · readOnly · required

object[] · readOnly · required

TextDetectionMatchModel

actionName

string · readOnly · required

object[] · readOnly · required

renditionId

string · readOnly · required

object · readOnly · required

AdditionalDetailsModel

object · readOnly

object[] · readOnly

ChunkModel

tenantId

string · required

spaceId

string · required

mimeType

string · required

encoding

string · required

extension

string · required

originalName

string · required

size

number · required

chunkId

string · required

versionId

string · required

rangeStart

number · required

rangeEnd

number · required

createdById

string

object

updatedById

string

object

deletedById

string

object

createdAt

string · date-time

updatedAt

string · date-time

deletedAt

string · date-time

md5

string

crc32c

string

RenditionType

string · enum

Enum values:

ir_highlighted_products

ir_share_of_shelf

original

original_internal

resize

txt_detect_full_text

txt_detect_result

thumbnail

RenditionModel

tenantId

string · required

spaceId

string · required

mimeType

string · required

encoding

string · required

extension

string · required

originalName

string · required

size

number · required

versionId

string · required

renditionId

string · required

renditionType

string · enum · required

Enum values:

ir_highlighted_products

ir_share_of_shelf

original

original_internal

resize

txt_detect_full_text

txt_detect_result

thumbnail

createdById

string

object

updatedById

string

object

deletedById

string

object

createdAt

string · date-time

updatedAt

string · date-time

deletedAt

string · date-time

md5

string

crc32c

string

renditionDescription

string

contentUrl

string

downloadUrl

string

ParentFolderModel

folderId

string · readOnly · required

name

string · readOnly · required

ascendentLevel

number · readOnly · required

TagModel

tagId

string

tagName

string

assetCount

number

workflowCount

number

VersionModel

tenantId

string · required

spaceId

string · required

mimeType

string · required

encoding

string · required

extension

string · required

originalName

string · required

size

number · required

assetId

string · required

versionId

string · required

contentType

string · enum · required

Enum values:

DOCUMENT

PRESENTATION

SPREADSHEET

IMAGE

AR

AUDIO

VIDEO

NOTFOUND

versionStatus

string · enum · required

Enum values:

UPLOADING

UPLOADED

COMPOSING

COMPOSED

SCANNING

SCANNED

QUARANTINED

VALIDATING

additionalData

boolean · required

hasChats

boolean · required

watermarked

boolean · required

versionNumber

number · required

createdById

string

object

updatedById

string

object

deletedById

string

object

createdAt

string · date-time

updatedAt

string · date-time

deletedAt

string · date-time

md5

string

crc32c

string

object

uploadUrl

string

contentUrl

string

downloadUrl

string

imageRecognitionUrl

string

thumbnailUrl

string

iconUrl

string

object[]

SourceEnum

string · enum

Enum values:

SFDC

FIELD_MOBILE

STUDIO_WEB

STUDIO_MOBILE

AVA_WEB

AVA_MOBILE

API

ExternalLinkModel

id

string · readOnly · required

category

string · readOnly · required

label

string · readOnly · required

url

string · readOnly · required

mobileDeepLink

string · readOnly

AttributeTypeEnum

string · enum

Enum values:

IMAGE_RECOGNITION

SYSTEM_METADATA

SYSTEM_SALESFORCE

TEXT_DETECT

AttributeDataTypeEnum

string · enum

Enum values:

BOOLEAN

DATE

GEOPOINT

NUMBER

STRING

AttributeValueModel

attributeValueId

string · readOnly · required

value

string · readOnly · required

externalId

string · readOnly

AssetAttributeModel

attributeId

string · readOnly · required

name

string · readOnly · required

displayName

string · readOnly · required

attributeType

string · enum · readOnly · required

Enum values:

IMAGE_RECOGNITION

SYSTEM_METADATA

SYSTEM_SALESFORCE

TEXT_DETECT

dataType

string · enum · readOnly · required

Enum values:

BOOLEAN

DATE

GEOPOINT

NUMBER

STRING

object[] · readOnly

AssetModel

tenantId

string · required

spaceId

string · required

mimeType

string · required

encoding

string · required

extension

string · required

originalName

string · required

size

number · required

assetId

string · required

versionId

string · required

contentType

string · enum · required

Enum values:

DOCUMENT

PRESENTATION

SPREADSHEET

IMAGE

AR

AUDIO

VIDEO

NOTFOUND

versionStatus

string · enum · required

Enum values:

UPLOADING

UPLOADED

COMPOSING

COMPOSED

SCANNING

SCANNED

QUARANTINED

VALIDATING

additionalData

boolean · required

hasChats

boolean · required

watermarked

boolean · required

versionNumber

number · required

isPublic

boolean · required

object[] · required

createdById

string

object

updatedById

string

object

deletedById

string

object

createdAt

string · date-time

updatedAt

string · date-time

deletedAt

string · date-time

md5

string

crc32c

string

object

uploadUrl

string

contentUrl

string

downloadUrl

string

imageRecognitionUrl

string

thumbnailUrl

string

iconUrl

string

object[]

name

string

description

string

folderId

string

object[]

isFavourite

boolean

meta

string[]

source

string · enum

Enum values:

SFDC

FIELD_MOBILE

STUDIO_WEB

STUDIO_MOBILE

AVA_WEB

AVA_MOBILE

API

studioWebUrl

string

object[]

CreateAssetChunkRequest

file

file · required

OrderDirection

string · enum

Enum values:

ASCENDING

DESCENDING

FindOrderBy

name

string · enum

Enum values:

ASCENDING

DESCENDING

description

string · enum

Enum values:

ASCENDING

DESCENDING

contentType

string · enum

Enum values:

ASCENDING

DESCENDING

size

string · enum

Enum values:

ASCENDING

DESCENDING

createdAt

string · enum

Enum values:

ASCENDING

DESCENDING

updatedAt

string · enum

Enum values:

ASCENDING

DESCENDING

deletedAt

string · enum

Enum values:

ASCENDING

DESCENDING

MatchEnum

string · enum

Enum values:

ANY

ALL

Return assets that match ALL of the given tags or ANY of the given tags.

Default: ALL

FindWhereTags

tagIds

string[]

tagNames

string[]

match

string · enum

Return assets that match ALL of the given tags or ANY of the given tags.

Enum values:

ANY

ALL

Default: ALL

DateRange

from

string · date-time

to

string · date-time

NumberRange

from

number

to

number

QueryAssetsWhere

name

string

object

createdById

string

Can be used with createdByIds. Created by user ids are combined into a single array of unique values.

createdByIds

string[]

Can be used with createdById. Created by user ids are combined into a single array of unique values.

contentType

string[]

Enum values:

DOCUMENT

PRESENTATION

SPREADSHEET

IMAGE

AR

AUDIO

VIDEO

NOTFOUND

source

string[]

Enum values:

SFDC

FIELD_MOBILE

STUDIO_WEB

STUDIO_MOBILE

AVA_WEB

AVA_MOBILE

API

object

spaceIds

string[]

Restricts the query to these spaces. The user must be a member of every space, otherwise a 400 is returned. Cannot be used together with queryAllUsersSpaces: true.

queryAllUsersSpaces

boolean

When true, queries all spaces the user is an active member of. When omitted or false, the active space is used unless spaceIds is populated. Cannot be true together with spaceIds.

QueryAssetsRequest

object

Default: {"createdAt":"DESC"}

skip

number · min: 0

Default: 0

limit

number · min: 0 · max: 250

Default: 50

noCount

boolean

When true, the total matching count is not computed; the response count is -1.

Default: false

object

AssetSummary

spaceId

string · required

mimeType

string · required

extension

string · required

originalName

string · required

size

number · required

assetId

string · required

versionId

string · required

contentType

string · enum · required

Enum values:

DOCUMENT

PRESENTATION

SPREADSHEET

IMAGE

AR

AUDIO

VIDEO

NOTFOUND

object

createdAt

string · date-time

updatedAt

string · date-time

contentUrl

string

downloadUrl

string

thumbnailUrl

string

name

string

description

string

object[]

source

string · enum

Enum values:

SFDC

FIELD_MOBILE

STUDIO_WEB

STUDIO_MOBILE

AVA_WEB

AVA_MOBILE

API

studioWebUrl

string

QueryAssetsResponse

object[] · required

count

number · required

Total matching assets. -1 when the request set noCount to true (count was skipped).

Schemas

AssignedToWorkflowDetailsModel

ErrorCodeEnum

ErrorResponse

CreateAssetRequest

UserModel

ContentType

VersionStatus

ImageMetadataModel

ObjectsModel

ShareModel

ProductModel

VertexModel

DetectionModel

UnknownDetectionModel

TotalsModel

ShareOfShelfVendorEnum

ShareOfShelfDetailsModel

GoogleVisionAnnotationInfoModel

TextDetectionDetailsModel

TextDetectionMatchInfoModel

TextDetectionMatcherResultModel

TextDetectionTotalsMatcherModel

TextDetectionTotalsModel

TextDetectionMatchModel

AdditionalDetailsModel

ChunkModel

RenditionType

RenditionModel

ParentFolderModel

TagModel

VersionModel

SourceEnum

ExternalLinkModel

AttributeTypeEnum

AttributeDataTypeEnum

AttributeValueModel

AssetAttributeModel

AssetModel

CreateAssetChunkRequest

OrderDirection

FindOrderBy

MatchEnum

FindWhereTags

DateRange

NumberRange

QueryAssetsWhere

QueryAssetsRequest

AssetSummary

QueryAssetsResponse