Aller au contenu

Library Media

List (GET)

ENDPOINT : api/libraries/-library_uuid-/media

SECURITY : authenticated

Headers

Terminal window
Authorization: Bearer JWT_TOKEN
Content-Type: application/json
Accept: application/json

URL Parameters

nametypedescriptionexample
library_uuidstringPas de description25ec73a8-d80e-411b-a930-1021533e40b4

Query Parameters

  • paginate optional

    Pagination 0 for no pagination, 1 for pagination

    nametypedescriptionexample
    paginateintegerPaginated or not. Paginated by default.1
  • filters[-field-][-operator-] optional

    to see operators, see the operators

    nametypedescriptionexample
    filters[-field-][-operator-]stringFilters -field- where -operator- matches the string value.null

    example URL construct :

    Terminal window
    https://---API_SERVER---/api/libraries/-library_uuid-/media?filters[name][$contains]=<value>
  • sort[-order-] optional

    to see sort param, see the params

    nametypedescriptionexample
    sort[-order-]stringSorts a string value field in -order-, following ‘asc’ or ‘desc’ direction (ex: field%3Adesc).null

    example URL construct :

    Terminal window
    https://---API_SERVER---/api/libraries/-library_uuid-/media?sort[0]=name%3Aasc&sort[1]=updated_at%3Adesc

Example Request :

curl --request GET
--get "https://---API_SERVER---/api/formats?paginate=1"
--header "Content-Type: application/json"
--header "Accept: application/json"

Example response:

  • **Status**: 200

Create (POST)

ENDPOINT : api/libraries/-library_uuid-/media

SECURITY : authenticated

Headers

Terminal window
Authorization: Bearer JWT_TOKEN
Content-Type: multipart/form-data
Accept: application/json

URL Parameters

nametypedescriptionexample
library_uuidstringPas de description25ec73a8-d80e-411b-a930-1021533e40b4

Body Parameters

key : name
key : data
key : file
key : files
key : media_type_id

Example Request :

curl --request POST
--get "https://---API_SERVER---/api/formats?paginate=1"
--header "Content-Type: multipart/form-data"
--header "Accept: application/json"

Example response:

  • **Status**: 200