Media API

Endpoint Index

Action	Endpoint
Fetch Media Data	GET /auxdata/{tenantLocator}/mediadata/{locator}/versions/{versionLocator}
Fetch File	GET /auxdata/{tenantLocator}/mediadata/{locator}/versions/{versionLocator}/file
Fetch All Media By Locator	GET /auxdata/{tenantLocator}/mediadata/{locator}/list
Fetch Latest File	GET /auxdata/{tenantLocator}/mediadata/{locator}/file
Fetch Latest Media Data	GET /auxdata/{tenantLocator}/mediadata/{locator}
Fetch Latest Media Data By Reference	GET /auxdata/{tenantLocator}/mediadata/search/{referenceType}/{referenceLocator}/list
Create Media Data	POST /auxdata/{tenantLocator}/mediadata
Update Media Data	PATCH /auxdata/{tenantLocator}/mediadata/{locator}
Delete Media Data	DELETE /auxdata/{tenantLocator}/mediadata/{locator}

Fetch

Fetch Media Data

fetchMediaData

GET /auxdata/{tenantLocator}/mediadata/{locator}/versions/{versionLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
versionLocator	path	string	required

Response:MediaDataEntry
Security Group:mediadata   Permission:read

MediaDataEntry

required
locator string
filename string
updatedAt datetime
updatedBy uuid
createdAt datetime
createdBy uuid
references MediaDataEntryReference[]

optional
versionLocator string?
tag string?
title string?

MediaDataEntryReference

required
locator string
type Enum diary | fnol | policy | quote | task | transaction | userAssociation

Fetch File

fetchFile

GET /auxdata/{tenantLocator}/mediadata/{locator}/versions/{versionLocator}/file

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
versionLocator	path	string	required

Response:StreamingResponseBody<string>
Security Group:mediadata   Permission:read

Fetch All Media By Locator

fetchAllMediaDataByLocator

GET /auxdata/{tenantLocator}/mediadata/{locator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:object
Security Group:mediadata   Permissions:read,list

Fetch Latest File

fetchLatestFile

GET /auxdata/{tenantLocator}/mediadata/{locator}/file

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:StreamingResponseBody<string>
Security Group:mediadata   Permission:read

Fetch Latest Media Data

fetchLatestMediaData

GET /auxdata/{tenantLocator}/mediadata/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:MediaDataEntry
Security Group:mediadata   Permission:read

Fetch Latest Media Data By Reference

fetchLatestMediaDataByReference

GET /auxdata/{tenantLocator}/mediadata/search/{referenceType}/{referenceLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
referenceLocator	path	string	required
referenceType	path	Enum diary | fnol | policy | quote | task | transaction | userAssociation	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:object
Security Group:mediadata   Permissions:read,list

Management

Create Media Data

createMediaData

POST /auxdata/{tenantLocator}/mediadata

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
filename	query	string	required
mimeType	query	string	required
title	query	string?	optional
tag	query	string?	optional
references	query	MediaDataEntryReference[]	required

Request:file
Response:MediaDataEntry
Security Group:mediadata   Permission:write

Update Media Data

updateMediaData

PATCH /auxdata/{tenantLocator}/mediadata/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
filename	query	string?	optional
mimeType	query	string?	optional
title	query	string?	optional
tag	query	string?	optional
referencesToAdd	query	MediaDataEntryReference[]?	optional
referencesToRemove	query	MediaDataEntryReference[]?	optional

Request:file
Response:MediaDataEntry
Security Group:mediadata   Permission:write

Delete Media Data

deleteMediaData

DELETE /auxdata/{tenantLocator}/mediadata/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:void
Security Group:mediadata   Permission:write