Media API

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

Fetch Media DatafetchMediaData

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`versionLocator`	path	`ulid`	Yes

Response:MediaDataEntry

Security Group:mediadata

Permission:

read

MediaDataEntry

Required properties

Property	Type	Description
`locator`	`ulid`
`filename`	`string`
`updatedAt`	`datetime`
`updatedBy`	`uuid`
`createdAt`	`datetime`
`createdBy`	`uuid`
`references`	`MediaDataEntryReference[]`

Optional properties

Property	Type	Description
`versionLocator`	`ulid?`
`tag`	`string?`
`title`	`string?`

MediaDataEntryReference

Required properties

Property	Type	Description
`locator`	`ulid`
`type`	`Enum diary \| fnol \| inquiry \| policy \| producer \| producerAppointment \| producerCode \| producerLicense \| quote \| task \| transaction \| userAssociation`

Fetch File

Fetch FilefetchFile

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`versionLocator`	path	`ulid`	Yes

Response:StreamingResponseBody<string>

Security Group:mediadata

Permission:

read

Fetch All Media By Locator

Fetch All Media By LocatorfetchAllMediaDataByLocator

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:object

Security Group:mediadata

Permissions:

read,list

Fetch Latest File

Fetch Latest FilefetchLatestFile

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:StreamingResponseBody<string>

Security Group:mediadata

Permission:

read

Fetch Latest Media Data

Fetch Latest Media DatafetchLatestMediaData

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:MediaDataEntry

Security Group:mediadata

Permission:

read

Fetch Latest Media Data By Reference

Fetch Latest Media Data By ReferencefetchLatestMediaDataByReference

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`referenceLocator`	path	`ulid`	Yes
`referenceType`	path	`Enum diary \| fnol \| inquiry \| policy \| producer \| producerAppointment \| producerCode \| producerLicense \| quote \| task \| transaction \| userAssociation`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:object

Security Group:mediadata

Permissions:

read,list

Management

Create Media Data

Create Media DatacreateMediaData

POST/auxdata/{tenantLocator}/mediadata

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`filename`	query	`string`	Yes
`mimeType`	query	`string`	Yes
`title`	query	`string?`	No
`tag`	query	`string?`	No
`references`	query	`MediaDataEntryReference[]`	Yes

Request:file

Response:MediaDataEntry

Security Group:mediadata

Permission:

write

Update Media Data

Update Media DataupdateMediaData

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`filename`	query	`string?`	No
`mimeType`	query	`string?`	No
`title`	query	`string?`	No
`tag`	query	`string?`	No
`referencesToAdd`	query	`MediaDataEntryReference[]?`	No
`referencesToRemove`	query	`MediaDataEntryReference[]?`	No

Request:file

Response:MediaDataEntry

Security Group:mediadata

Permission:

write

Delete Media Data

Delete Media DatadeleteMediaData

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:void

Security Group:mediadata

Permission:

write

Media API

On this page