Get (GET)

ENDPOINT : api/media/-uuid-

SECURITY : authenticated

Description : Gets a media instance.

Headers

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

URL Parameters

name	type	description	example
uuid	string	Pas de description	8d1bcaea-4667-377f-8e55-27ff887bc491

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};
fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

{
  "uuid": "9b7b5799-3464-44fd-94cc-b27629993516",
  "collection_name": "image.wheat_application/ogg",
  "name": "LightCyan East Vivianne Christa",
  "file_name": "image-logo.jpg",
  "mime_type": "image/jpeg",
  "type": "image",
  "extension": "jpg",
  "human_readable_size": "30.87 KB",
  "urls": {
    "original": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/image-logo.jpg",
    "thumb": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-thumb.jpg",
    "preview": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-preview.jpg"
  },
  "size": 31606,
  "data": [],
  "library_uuid": "9b7b5798-b378-44c0-b996-f3c590c52415",
  "media_type_id": 2,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:09"
}

---

Create (POST)

ENDPOINT : api/media

SECURITY : authenticated

Description : Creates a media while uploading a file. Library must be specified in library_uuid body parameter. For a single file upload, use file body parameter. For a multi-file upload, use files (if you use Postman, you should name the field “files[]”).

** /!\ When using files**, the response for each file is wrapped either in an accepted or in a rejected superior layer.

Headers

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

Body Parameters

key : name

name details

Pas de description.

name	type	example
name	string	iusto

key : data

data details

Pas de description.

name	type	example
data	object	Pas d’example

key : file

file details

This field is required when files is not present. Must be a file..

name	type	example
file	file	Pas d’example

key : files

files details

Must be a file..

name	type	example
files	file[]

key : media_type_id

media_type_id details

Though usually unrequired, there exists a media_type_id body field. Available media types are :  

media_type_id	media_type_name	compatible library types
2	IMAGE	8 - GRAPHICS
3	PDF	8 - GRAPHICS
4	FONT	4 - FONT
5	VECTOR	5 - VECTOR
6	COLOR	6 - COLOR
7	CUSTOMIZATION	7 - CUSTOMIZATION
9	VECTOR_FILE	8 - GRAPHICS
.

name	type	example
media_type_id	string	Pas d’example

key : library_uuid

library_uuid details

Pas de description.

name	type	example
library_uuid	string	doloremque

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};
fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

{
  "uuid": "9b7b5799-3464-44fd-94cc-b27629993516",
  "collection_name": "image.wheat_application/ogg",
  "name": "LightCyan East Vivianne Christa",
  "file_name": "image-logo.jpg",
  "mime_type": "image/jpeg",
  "type": "image",
  "extension": "jpg",
  "human_readable_size": "30.87 KB",
  "urls": {
    "original": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/image-logo.jpg",
    "thumb": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-thumb.jpg",
    "preview": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-preview.jpg"
  },
  "size": 31606,
  "data": [],
  "library_uuid": "9b7b5798-b378-44c0-b996-f3c590c52415",
  "media_type_id": 2,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:09"
}

Example response:

• Status : 200

Show Response

{
  "created": [
    {
      "uuid": "9d84c792-8692-470b-8b64-6f8211aada70",
      "collection_name": "font.helvetica",
      "name": "arialce.ttf",
      "file_name": "arialce.ttf",
      "mime_type": "font/sfnt",
      "type": "other",
      "extension": "ttf",
      "human_readable_size": "22.57 KB",
      "urls": {
        "original": "http://localhost:82/storage/media/9d84c792-8692-470b-8b64-6f8211aada70/arialce.ttf"
      },
      "size": 23112,
      "data": {
        "full_name": "ArialCE",
        "family_id": "Arial CE:1135402788",
        "version": "001.005",
        "type": "TrueType",
        "postscript_name": "ArialCE",
        "name": "Arial CE",
        "variant": "regular",
        "weight": 500,
        "style": "normal",
        "ascent": 716,
        "descent": -199,
        "win_ascent": 924,
        "win_descent": 223,
        "fav_ascent": null,
        "fav_descent": null
      },
      "library_uuid": "9d7eda46-1b8b-4dbe-ba13-3836f75f1343",
      "media_type_id": 4,
      "created_at": "2024-11-18 13:21:35",
      "updated_at": "2024-11-18 13:21:35"
    },
    {
      "uuid": "9d84c792-a121-4470-83c0-9530b5939174",
      "collection_name": "font.helvetica",
      "name": "helvetica.ttf",
      "file_name": "helvetica.ttf",
      "mime_type": "font/sfnt",
      "type": "other",
      "extension": "ttf",
      "human_readable_size": "61.97 KB",
      "urls": {
        "original": "http://localhost:82/storage/media/9d84c792-a121-4470-83c0-9530b5939174/helvetica.ttf"
      },
      "size": 63460,
      "data": {
        "full_name": "Helvetica",
        "family_id": "Agfa:Helvetica:1998",
        "version": "19: 14459: 1998",
        "type": "TrueType",
        "postscript_name": "Helvetica",
        "name": "Helvetica",
        "variant": "regular",
        "weight": 400,
        "style": "normal",
        "ascent": 1470,
        "descent": -424,
        "win_ascent": 1944,
        "win_descent": 624,
        "fav_ascent": null,
        "fav_descent": null
      },
      "library_uuid": "9d7eda46-1b8b-4dbe-ba13-3836f75f1343",
      "media_type_id": 4,
      "created_at": "2024-11-18 13:21:35",
      "updated_at": "2024-11-18 13:21:35"
    }
  ],
  "rejected": [
    {
      "filename": "outofplace.pdf",
      "mime_type": "application/pdf",
      "size": 1395727,
      "error": {
        "id": "media_uncompatible_type",
        "category": "crud",
        "message": "Inside a typed library (%s), media must have a compatible type (%s).",
        "parameters": [
          "FONT",
          "PDF"
        ]
      }
    }
  ]
}

---

Upload (POST)

ENDPOINT : api/media/upload

SECURITY : authenticated

Description : Creates a batch of objects from a CSV file. The CSV must have the same headers as object data. Environment ID can be guessed from the uploader’s access environment, specified inside the request’s body, or specified in the uploaded file as “environment_id”.

The endpoint behavior changes according to HTTP method :

• POST : Create if resource key specified, do nothing if existing resource found.

** /!\ Only Media without files can be created through this endpoint !** Use create endpoint with files payload option in order to upload multiple media with files.

** /!\ Only MediaType #7 CUSTOMIZATION is currently supported **

** /!\ media_type_id body parameter is optional only when the library type is unambiguous (customizations, fonts, colors). ** Otherwise, it must be supplied in the body or into the uploaded file as its own separate field. Since customizations is the only type currently supported, you may safely consider this field as optional.

Customizations dataframe :

Click to expand

Header	Description
FN	Nom formaté (prénom + nom)
TITLE	Fonction de la personne
FIRSTNAME	Prénom
LASTNAME	Nom de famille
NICKNAME	Surnom
ROLE	Position hiérarchique
CATEGORIES	Catégories applicables à la vCard (séparées par des virgules)
ORG	Nom de l’organisation ou de l’entreprise
BU	Business Unit
KIND	Type d’objet représenté par la vCard (ex. individual, org, location, application).
EMAIL1	Adresse électronique de l’objet. (type=internet)
EMAIL2	Adresse électronique de l’objet. (type=internet)
EMAIL3	Adresse électronique de l’objet. (type=internet)
EMAIL4	Adresse électronique de l’objet. (type=internet)
TEL1	Téléphone 1 (type=voice)
TEL2	Téléphone 2 (type=cell)
TEL3	Téléphone 3 (type=work)
TEL4	Téléphone 4 (type=voice)
ADDR1_LINE1	Adresse 1 (type=work) Ligne 1
ADDR1_LINE2	Adresse 1 (type=work) Ligne 2
ADDR1_LINE3	Adresse 1 (type=work) Ligne 3
ADDR1_ZIPCODE	Adresse 1 (type=work) Code postal
ADDR1_CITY	Adresse 1 (type=work) Ville
ADDR1_COUNTRY	Adresse 1 (type=work) Pays
ADDR2_LINE1	Adresse 2 (type=home) Ligne 1
ADDR2_LINE2	Adresse 2 (type=home) Ligne 2
ADDR2_LINE3	Adresse 2 (type=home) Ligne 3
ADDR2_ZIPCODE	Adresse 2 (type=home) Code postal
ADDR2_CITY	Adresse 2 (type=home) Ville
ADDR2_COUNTRY	Adresse 2 (type=home) Pays
ADDR3_LINE1	Adresse 3 (type=intl) Ligne 1
ADDR3_LINE2	Adresse 3 (type=intl) Ligne 2
ADDR3_LINE3	Adresse 3 (type=intl) Ligne 3
ADDR3_ZIPCODE	Adresse 3 (type=intl) Code postal
ADDR3_CITY	Adresse 3 (type=intl) Ville
ADDR3_COUNTRY	Adresse 3 (type=intl) Pays
URL	Site internet
GEO	Latitude et Longitude
GENDER	Genre de l’individu (”,‘M’,‘F’,‘O’,‘N’,‘U’)
BDAY	Date de naissance au format AAAAMMJJ
LOGO	Url vers le logo de l’entreprise
PHOTO	Url vers la photo de l’individu
CUSTOM1	Champ libre
CUSTOM2	Champ libre
CUSTOM3	Champ libre
CUSTOM4	Champ libre
CUSTOM5	Champ libre
CUSTOM6	Champ libre
CUSTOM7	Champ libre
CUSTOM8	Champ libre
CUSTOM9	Champ libre
CUSTOM10	Champ libre
CUSTOM11	Champ libre
CUSTOM12	Champ libre
CUSTOM13	Champ libre
CUSTOM14	Champ libre
CUSTOM15	Champ libre
CALURI	Url vers le calendrier de l’individu
REV	Date de la version de la personnalisation
LANG	Langue de l’individu
KEY	Clé publique de chiffrement
TZ	Fuseau horaire courant de l’individu
UID	Identifiant unique

Headers

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

Body Parameters

key : file

file details

Must be a file..

name	type	example
file	file	Pas d’example

key : library_uuid

library_uuid details

Pas de description.

name	type	example
library_uuid	string	dolor

key : media_type_id

media_type_id details

Pas de description.

name	type	example
media_type_id	string	Pas d’example

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};
fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

{
  "data": [
    {
      "uuid": "9bfc10de-dab8-4480-bd8c-9b85e987cc42",
      "collection_name": "color.grey_palette",
      "name": "white",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "255,255,255",
        "cmyk": "0,0,0,0"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10de-e4ba-44b7-9c9c-6c6ea3f64ae9",
      "collection_name": "color.grey_palette",
      "name": "Seasalt",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "248,249,250",
        "cmyk": "1,0,0,2"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10de-ee82-4e61-874d-79db034a5cd4",
      "collection_name": "color.grey_palette",
      "name": "Anti-flash white",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "233,236,239",
        "cmyk": "3,1,0,6"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10de-f820-4956-b0a1-51474cb3a103",
      "collection_name": "color.grey_palette",
      "name": "Platinium",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "222,226,230",
        "cmyk": "3,2,0,10"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-022c-4d8d-935d-09157cae3f72",
      "collection_name": "color.grey_palette",
      "name": "French gray",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "206,212,218",
        "cmyk": "6,3,0,15"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-0c67-4e03-9b2c-7549aaaf1ddc",
      "collection_name": "color.grey_palette",
      "name": "Dark french gray",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "173,181,189",
        "cmyk": "8,4,0,26"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-1623-42bc-adab-b1b655def5c7",
      "collection_name": "color.grey_palette",
      "name": "Slate gray",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "108,117,125",
        "cmyk": "14,6,0,51"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-204b-408e-add5-6992518cbdf0",
      "collection_name": "color.grey_palette",
      "name": "Outer space",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "73,80,87",
        "cmyk": "16,8,0,66"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-2a8d-4394-a02c-a17d6b1dbf46",
      "collection_name": "color.grey_palette",
      "name": "Onyx",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "52,58,64",
        "cmyk": "19,9,0,75"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-347a-4fdc-9d49-0be2c6ebd9d4",
      "collection_name": "color.grey_palette",
      "name": "Eerie black",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "33,37,41",
        "cmyk": "20,10,0,84"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    },
    {
      "uuid": "9bfc10df-3dea-4665-87a2-1705b3aadf32",
      "collection_name": "color.grey_palette",
      "name": "Black",
      "file_name": null,
      "mime_type": null,
      "type": "other",
      "extension": "",
      "human_readable_size": "0 KB",
      "urls": [],
      "size": 0,
      "data": {
        "rgb": "0,0,0",
        "cmyk": "0,0,0,100"
      },
      "library_uuid": "c24e62f5-411c-46ee-87f0-d9a58e77330a",
      "media_type_id": 6,
      "created_at": "2024-05-07 08:06:11",
      "updated_at": "2024-05-07 08:06:11"
    }
  ],
  "links": {
    "first": "http://192.168.10.170:82/api/libraries/c24e62f5-411c-46ee-87f0-d9a58e77330a/media?page=1",
    "last": "http://192.168.10.170:82/api/libraries/c24e62f5-411c-46ee-87f0-d9a58e77330a/media?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "http://192.168.10.170:82/api/libraries/c24e62f5-411c-46ee-87f0-d9a58e77330a/media?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "http://192.168.10.170:82/api/libraries/c24e62f5-411c-46ee-87f0-d9a58e77330a/media",
    "per_page": 15,
    "to": 11,
    "total": 11
  }
}

---

Duplicate (POST)

ENDPOINT : api/media/-uuid-

SECURITY : authenticated

Description : Pas de description

Headers

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

URL Parameters

name	type	description	example
uuid	string	Pas de description	4fd36fd9-7ab1-3531-8909-e490f0307b06

Body Parameters

key : name

name details

Pas de description.

name	type	example
name	string	nobis

key : data

data details

Pas de description.

name	type	example
data	object	Pas d’example

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};
fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

{
  "uuid": "9b7b5799-3464-44fd-94cc-b27629993516",
  "collection_name": "image.wheat_application/ogg",
  "name": "LightCyan East Vivianne Christa",
  "file_name": "image-logo.jpg",
  "mime_type": "image/jpeg",
  "type": "image",
  "extension": "jpg",
  "human_readable_size": "30.87 KB",
  "urls": {
    "original": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/image-logo.jpg",
    "thumb": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-thumb.jpg",
    "preview": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-preview.jpg"
  },
  "size": 31606,
  "data": [],
  "library_uuid": "9b7b5798-b378-44c0-b996-f3c590c52415",
  "media_type_id": 2,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:09"
}

---

Delete Selection (DELETE)

ENDPOINT : api/media/select

SECURITY : authenticated

Description : Returns a list of deleted elements. Accepts a list of keys (IDs, UUIDs) in a keys body parameter, in order to filter the results without resorting to extensive query parameters.

Only deletes media of type Customization.

Headers

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

Body Parameters

key : keys

keys details

Must be a valid UUID..

name	type	example
keys	string[]	53cd7abf-3191-3be1-a6e7-b9b4924c13d3

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};
fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

[
  {
    "found": [
      {
        "uuid": "9d7ae8a2-9791-46f9-9a54-11478bbb0bfa",
        "collection_name": "customization.persos",
        "name": "name media",
        "file_name": null,
        "mime_type": null,
        "type": "other",
        "extension": "",
        "human_readable_size": "416 B",
        "urls": [],
        "size": 416,
        "data": [
          {
            "key": "FN",
            "value": "Bernard VILEMIN",
            "params": []
          },
          {
            "key": "TITLE",
            "value": "RESPONSABLE",
            "params": []
          },
          {
            "key": "FIRSTNAME",
            "value": "Bernard",
            "params": []
          },
          {
            "key": "LASTNAME",
            "value": "VILEMIN",
            "params": []
          },
          {
            "key": "TEL3",
            "value": "066666666666",
            "params": []
          }
        ],
        "library_uuid": "9c98d225-6c4e-465b-accf-8acb2107b5d6",
        "media_type_id": 7,
        "created_at": "2024-11-13 15:35:45",
        "updated_at": "2024-11-13 15:35:45"
      }
    ],
    "missing": [
      "c24e62f5-411c-46ee-87f0-d9a58e77330a"
    ]
  }
]

---

Update (PATCH)

ENDPOINT : api/media/-uuid-

SECURITY : authenticated

Description : Updates a media. Can handle “library_uuid” parameer in order to move to another library, provided it has a compatible type.

Headers

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

URL Parameters

name	type	description	example
uuid	string	Pas de description	ff1e7f6d-0255-3736-85ab-75e2e30dba44

Body Parameters

key : name

name details

Pas de description.

name	type	example
name	string	odio

key : data

data details

Pas de description.

name	type	example
data	object	Pas d’example

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};
fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

{
  "uuid": "9b7b5799-3464-44fd-94cc-b27629993516",
  "collection_name": "image.wheat_application/ogg",
  "name": "LightCyan East Vivianne Christa",
  "file_name": "image-logo.jpg",
  "mime_type": "image/jpeg",
  "type": "image",
  "extension": "jpg",
  "human_readable_size": "30.87 KB",
  "urls": {
    "original": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/image-logo.jpg",
    "thumb": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-thumb.jpg",
    "preview": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-preview.jpg"
  },
  "size": 31606,
  "data": [],
  "library_uuid": "9b7b5798-b378-44c0-b996-f3c590c52415",
  "media_type_id": 2,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:09"
}

---

Delete (DELETE)

ENDPOINT : api/media/-uuid-

SECURITY : authenticated

Description : Deletes a media.

Headers

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

URL Parameters

name	type	description	example
uuid	string	Pas de description	7838dbf3-f737-3c67-ba2d-6dc0ecf308ef

Example Request :

Bash

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

Javascript

const url = new URL(
    "https://---API_SERVER---/api/environments"
);
const headers = {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};
fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response:

• Status : 200

Show Response

{
  "uuid": "9b7b5799-3464-44fd-94cc-b27629993516",
  "collection_name": "image.wheat_application/ogg",
  "name": "LightCyan East Vivianne Christa",
  "file_name": "image-logo.jpg",
  "mime_type": "image/jpeg",
  "type": "image",
  "extension": "jpg",
  "human_readable_size": "30.87 KB",
  "urls": {
    "original": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/image-logo.jpg",
    "thumb": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-thumb.jpg",
    "preview": "http://localhost:82/storage/9b7b5799-3464-44fd-94cc-b27629993516/conversions/image-logo-preview.jpg"
  },
  "size": 31606,
  "data": [],
  "library_uuid": "9b7b5798-b378-44c0-b996-f3c590c52415",
  "media_type_id": 2,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:09"
}

---