Media

Search media by tags (optionally scoped to an entity)

Searches on tags (TEXT[] + GIN). match_all=true (default) requires that all tags match. Can be restricted to an entity.

get/media/search

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/media/search
  • Auth: HTTP bearer

Query parameters

tagsstring

Comma-separated list of tags (lowercase)

match_allboolean

If true (default), all tags must match; else any

entity_type'PLACE' | 'ESTATE' | 'ROOM' | 'EQUIPMENT' | 'LEASE' | 'OWNER' | 'CONTACT' | 'LESSEE' | 'CONDITION_REPORT' | 'LEASE_NOTICE' | 'MANDATE'

Business entity type supported for media

entity_idstring uuid

Response

OK

idstring uuid nullable
urlstring nullable
media_typestring nullable

MIME type (e.g. application/pdf, image/jpeg)

file_sizeinteger nullable
security_level'STANDARD' | 'SENSITIVE' | 'CRITICAL'

Security/encryption level. CRITICAL and SENSITIVE may trigger SSE-C encrypted storage; STANDARD is unencrypted.

encryption_key_idstring nullable

SSE-C key identifier if the media is encrypted (secure mode)

checksumstring nullable

SHA-256 of the source content for integrity verification

tagsstring[] nullable

Tags normalized to lowercase; max 32 tags; each tag <= 64 chars, [a-z0-9_-]

rolesMediaRole[] nullable

Roles associated with this media for different entities

created_atstring date-time nullable
updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.