# Media API



<EndpointIndex
  names={[
  	'fetchMediaData',
  	'fetchFile',
  	'fetchAllMediaDataByLocator',
  	'fetchLatestFile',
  	'fetchLatestMediaData',
  	'fetchLatestMediaDataByReference',
  	'createMediaData',
  	'updateMediaData',
  	'deleteMediaData',
  ]}
  titles={{
  	fetchMediaData: 'Fetch Media Data',
  	fetchFile: 'Fetch File',
  	fetchAllMediaDataByLocator: 'Fetch All Media By Locator',
  	fetchLatestFile: 'Fetch Latest File',
  	fetchLatestMediaData: 'Fetch Latest Media Data',
  	fetchLatestMediaDataByReference: 'Fetch Latest Media Data By Reference',
  	createMediaData: 'Create Media Data',
  	updateMediaData: 'Update Media Data',
  	deleteMediaData: 'Delete Media Data',
  }}
/>

Fetch [#fetch]

Fetch Media Data [#fetch-media-data]

<ApiEndpoint name="fetchMediaData" title="Fetch Media Data" />

<ApiSchema name="MediaDataEntry" />

<ApiSchema name="MediaDataEntryReference" />

Fetch File [#fetch-file]

<ApiEndpoint name="fetchFile" title="Fetch File" />

Fetch All Media By Locator [#fetch-all-media-by-locator]

<ApiEndpoint name="fetchAllMediaDataByLocator" title="Fetch All Media By Locator" />

Fetch Latest File [#fetch-latest-file]

<ApiEndpoint name="fetchLatestFile" title="Fetch Latest File" />

Fetch Latest Media Data [#fetch-latest-media-data]

<ApiEndpoint name="fetchLatestMediaData" title="Fetch Latest Media Data" />

Fetch Latest Media Data By Reference [#fetch-latest-media-data-by-reference]

<ApiEndpoint name="fetchLatestMediaDataByReference" title="Fetch Latest Media Data By Reference" />

Management [#management]

Create Media Data [#create-media-data]

<ApiEndpoint name="createMediaData" title="Create Media Data" />

Update Media Data [#update-media-data]

<ApiEndpoint name="updateMediaData" title="Update Media Data" />

Delete Media Data [#delete-media-data]

<ApiEndpoint name="deleteMediaData" title="Delete Media Data" />


## API Reference

GET /auxdata/{tenantLocator}/mediadata/{locator}/versions/{versionLocator} — fetchMediaData
Tags: media-data-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
  versionLocator (ulid, path, required)
Responses:
  200 — OK

GET /auxdata/{tenantLocator}/mediadata/{locator}/versions/{versionLocator}/file — fetchFile
Tags: media-data-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
  versionLocator (ulid, path, required)
Responses:
  200 — OK

GET /auxdata/{tenantLocator}/mediadata/{locator}/list — fetchAllMediaDataByLocator
Tags: media-data-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
  offset (integer, query)
  count (integer, query)
  extended (boolean, query)
Responses:
  200 — OK

GET /auxdata/{tenantLocator}/mediadata/{locator}/file — fetchLatestFile
Tags: media-data-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 — OK

GET /auxdata/{tenantLocator}/mediadata/{locator} — fetchLatestMediaData
Tags: media-data-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 — OK

GET /auxdata/{tenantLocator}/mediadata/search/{referenceType}/{referenceLocator}/list — fetchLatestMediaDataByReference
Tags: media-data-controller
Permissions: read, list
Parameters:
  tenantLocator (uuid, path, required)
  referenceLocator (ulid, path, required)
  referenceType (Enum diary | fnol | inquiry | policy | producer | producerAppointment | producerCode | producerLicense | quote | task | transaction | userAssociation, path, required)
  offset (integer, query)
  count (integer, query)
  extended (boolean, query)
Responses:
  200 — OK

POST /auxdata/{tenantLocator}/mediadata — createMediaData
Tags: media-data-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  filename (string, query, required)
  mimeType (string, query, required)
  title (string, query)
  tag (string, query)
  references (MediaDataEntryReference[], query, required)
Responses:
  200 — OK

PATCH /auxdata/{tenantLocator}/mediadata/{locator} — updateMediaData
Tags: media-data-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
  filename (string, query)
  mimeType (string, query)
  title (string, query)
  tag (string, query)
  referencesToAdd (MediaDataEntryReference[], query)
  referencesToRemove (MediaDataEntryReference[], query)
Responses:
  200 — OK

DELETE /auxdata/{tenantLocator}/mediadata/{locator} — deleteMediaData
Tags: media-data-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 — OK

MediaDataEntry
Properties:
  locator (ulid, required)
  versionLocator (ulid)
  filename (string, required)
  title (string)
  tag (string)
  references (MediaDataEntryReference[], required)
  createdAt (datetime, required)
  createdBy (uuid, required)
  updatedAt (datetime, required)
  updatedBy (uuid, required)

MediaDataEntryReference
Properties:
  type (Enum diary | fnol | inquiry | policy | producer | producerAppointment | producerCode | producerLicense | quote | task | transaction | userAssociation, required)
  locator (ulid, required)