Medias

Media Storage API

Documentación de la API de Files

Servidor base: https://services.leadconnectorhq.com

Endpoints

• GET /medias/files — Obtener List of Files/ Folders
• POST /medias/upload-file — Upload File into Media Storage
• DELETE /medias/{id} — Eliminar File or Folder
• POST /medias/{id} — Actualizar File/ Folder
• POST /medias/folder — Crear Folder
• PUT /medias/update-files — Bulk Update Files/ Folders
• PUT /medias/delete-files — Bulk Delete / Trash Files or Folders

GET /medias/files

Obtener List of Files/ Folders Fetches list of files and folders from the media storage

Scopes requeridos: medias.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - offset (query, string) — Number of files to skip in listing - limit (query, string) — Number of files to show in the listing - sortBy (query, string) (requerido) — Field to sorting the file listing by - sortOrder (query, string) (requerido) — Direction in which file needs to be sorted - type (query, string) (requerido) — Type - query (query, string) — Query text - altType (query, string) (requerido) — AltType - altId (query, string) (requerido) — Id de sede - parentId (query, string) — Id de parent id or folder - fetchAll (query, string) — Fetch all files or folders

Respuestas: - 200 — Respuesta exitosa

POST /medias/upload-file

Upload File into Media Storage If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB. For video files, the maximum allowed size is 500 MB.

Scopes requeridos: medias.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (multipart/form-data): - file — string - hosted — boolean - fileUrl — string - name — string - parentId — string

Respuestas: - 200 — Respuesta exitosa

DELETE /medias/{id}

Eliminar File or Folder Deletes specific file or folder from the media storage

Scopes requeridos: medias.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — - altType (query, string) (requerido) — AltType - altId (query, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa

POST /medias/{id}

Actualizar File/ Folder Updates a single file or folder by Id

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Unique identifier of the file or folder to update

Cuerpo de la peticion (application/json): - name (requerido) — string — New name for the file or folder - altType (requerido) — string — Type of entity that owns the file or folder - altId (requerido) — string — Location identifier that owns the file or folder

Respuestas: - 200 — Respuesta exitosa

POST /medias/folder

Crear Folder Creates a new folder in the media storage

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location Id - altType (requerido) — string — Type of entity (location only) - name (requerido) — string — Name of the folder to be created - parentId — string — Id of the parent folder (optional)

Respuestas: - 200 — Returns the newly created folder object

PUT /medias/update-files

Bulk Update Files/ Folders Updates metadata or status of multiple files and folders

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - altId (requerido) — string — Location identifier - altType (requerido) — string — Type of entity that owns the files - filesToBeUpdated (requerido) — array — Array of file objects to be updated - id (requerido) — string — Unique identifier of the file or folder to be updated - name — string — New name for the file or folder

Respuestas: - 200 — Respuesta exitosa

PUT /medias/delete-files

Bulk Delete / Trash Files or Folders Soft-deletes or trashes multiple files and folders in a single request

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - filesToBeDeleted (requerido) — array — Array of file objects to be deleted or trashed - _id (requerido) — string — Unique identifier of the file or folder to be deleted - altType (requerido) — string — Type of entity that owns the files - altId (requerido) — string — Location identifier - status (requerido) — string — Status to set for the files (deleted or trashed)

Respuestas: - 200 — Respuesta exitosa