API docs by Redocly

Repzo API - Media Storage (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Media Storage endpoints.

Find media storage items

query Parameters
object

Query parameters for filtering media storage items

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a media storage item

Request Body schema: application/json
filename
required
string

Original filename

url
required
string

URL to access the media file

mimeType
required
string

MIME type of the file

size
required
number

File size in bytes

category
string

Media category

entityType
string

Type of entity this media is associated with

entityId
string

ID of the entity this media is associated with

isPublic
boolean

Whether the media is publicly accessible

thumbnailUrl
string

URL to thumbnail version (for images)

object

Additional metadata about the file

tags
Array of strings

Tags associated with the media

description
string

Description of the media

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a media storage item by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a media storage item

path Parameters
id
required
string
Request Body schema: application/json
filename
string

Original filename

category
string

Media category

entityType
string

Type of entity this media is associated with

entityId
string

ID of the entity this media is associated with

isPublic
boolean

Whether the media is publicly accessible

object

Additional metadata about the file

tags
Array of strings

Tags associated with the media

description
string

Description of the media

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "isPublic": true,
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a media storage item

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "filename": "string",
  • "url": "string",
  • "mimeType": "string",
  • "size": 0,
  • "category": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "uploadedBy": "string",
  • "isPublic": true,
  • "thumbnailUrl": "string",
  • "metadata": { },
  • "tags": [
    ],
  • "description": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}