API docs by Redocly

Repzo API - Media (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Media endpoints.

Find media

query Parameters
object

Query parameters for filtering media

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create media

Request Body schema: application/json
name
required
string

Name of the media

description
string

Description of the media

url
required
string

URL of the media

document_type
required
string
Enum: "html" "csv" "json" "image" "pdf" "ppt" "pptx" "xls" "xlsx" "doc" "docx" "images" "zip" "pt"

Type of media document

parent_document_type
string
Enum: "clients" "asset" "assetUnit" "workorder" "clientLocation" "clientContact" "commentsThread" "workorderRequest" "workorderPortal" "invoice" "products" "productvariations" "representatives" "productcategories" "productSubCategory" "speciality" "line" "banner" "intgAvailableApps"

Type of parent document

parent_document_key
string

Key of parent document

disabled
boolean

Whether the media is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get media by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update media

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

Name of the media

description
string

Description of the media

url
string

URL of the media

document_type
string
Enum: "html" "csv" "json" "image" "pdf" "ppt" "pptx" "xls" "xlsx" "doc" "docx" "images" "zip" "pt"

Type of media document

parent_document_type
string
Enum: "clients" "asset" "assetUnit" "workorder" "clientLocation" "clientContact" "commentsThread" "workorderRequest" "workorderPortal" "invoice" "products" "productvariations" "representatives" "productcategories" "productSubCategory" "speciality" "line" "banner" "intgAvailableApps"

Type of parent document

parent_document_key
string

Key of parent document

disabled
boolean

Whether the media is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the media

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove media

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "description": "string",
  • "url": "string",
  • "document_type": "html",
  • "parent_document_type": "clients",
  • "parent_document_key": "string",
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}