List (GET)

ENDPOINT : api/libraries

SECURITY : authenticated

Description : Pas de description

Headers

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

Query Parameters

• include (string) (optional)

Comma separated list relations to other models. Available: models, mediaType, media, environments.

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

{
  "data": [
    {
      "uuid": "9b7b5798-b67e-444c-b30e-4e3d21db3426",
      "name": "Everything",
      "metadata": null,
      "model_uuids": [],
      "media_type_id": 1,
      "created_at": "2024-03-04 08:22:09",
      "updated_at": "2024-03-04 08:22:10"
    },
    {
      "uuid": "9b7b5798-be64-4a64-9295-b6aed1444be1",
      "name": "User variables",
      "metadata": null,
      "model_uuids": [],
      "media_type_id": 7,
      "created_at": "2024-03-04 08:22:09",
      "updated_at": "2024-03-04 08:22:12"
    },
    {
      "uuid": "9b7b5798-c142-4291-8798-8e5f48c5f267",
      "name": "Images & PDFs",
      "metadata": null,
      "model_uuids": [],
      "media_type_id": 8,
      "created_at": "2024-03-04 08:22:09",
      "updated_at": "2024-03-04 08:22:12"
    },
    {
      "uuid": "9b7b5798-c659-425a-a0d0-6110b54e1973",
      "name": "Images",
      "metadata": null,
      "model_uuids": [],
      "media_type_id": 2,
      "created_at": "2024-03-04 08:22:09",
      "updated_at": "2024-03-04 08:22:12"
    }
  ],
  "links": {
    "first": "http://localhost:82/api/libraries?page=1",
    "last": "http://localhost:82/api/libraries?page=3",
    "prev": null,
    "next": "http://localhost:82/api/libraries?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "http://localhost:82/api/libraries?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "http://localhost:82/api/libraries?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "http://localhost:82/api/libraries?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "http://localhost:82/api/libraries?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "http://localhost:82/api/libraries",
    "per_page": 15,
    "to": 15,
    "total": 40
  }
}

---

Get (GET)

ENDPOINT : api/libraries/-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	25ec73a8-d80e-411b-a930-1021533e40b4

Query Parameters

• include (string) (optional)

Comma separated list relations to other models. Available: models, mediaType, media, environments.

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": "9b7b5798-c142-4291-8798-8e5f48c5f267",
  "name": "Images & PDFs",
  "metadata": null,
  "model_uuids": [],
  "media_type_id": 8,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:12"
}

---

Create (POST)

ENDPOINT : api/libraries

SECURITY : authenticated

Description : Creates a library. Requires a media_type_id body field. See details below.

Headers

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

Body Parameters

key : environment_ids

environment_ids details

Pas de description.

name	type	example
environment_ids	integer[]	13

key : name

name details

Pas de description.

name	type	example
name	string	illo

key : metadata

metadata details

Pas de description.

name	type	example
metadata	object	Pas d’example

key : model_uuids

model_uuids details

Must be a valid UUID..

name	type	example
model_uuids	string[]	aef8fd12-2734-3583-a60e-b386a0b6d3e3

key : media_type_id

media_type_id details

Requires a media_type_id body field. Available media types are :  

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

name	type	example
media_type_id	string	Pas d’example

Query Parameters

• include (string) (optional)

Comma separated list relations to other models. Available: models, mediaType, media, environments.

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": "9b7b5798-c142-4291-8798-8e5f48c5f267",
  "name": "Images & PDFs",
  "metadata": null,
  "model_uuids": [],
  "media_type_id": 8,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:12"
}

---

Update (PATCH)

ENDPOINT : api/libraries/-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	25ec73a8-d80e-411b-a930-1021533e40b4

Body Parameters

key : environment_ids

environment_ids details

Pas de description.

name	type	example
environment_ids	integer[]	18

key : name

name details

Pas de description.

name	type	example
name	string	qui

key : metadata

metadata details

Pas de description.

name	type	example
metadata	object	Pas d’example

key : model_uuids

model_uuids details

Must be a valid UUID..

name	type	example
model_uuids	string[]	e111df10-5f61-3b9f-9257-63ceee4ce356

key : media_type_id

media_type_id details

Pas de description.

name	type	example
media_type_id	string	Pas d’example

Query Parameters

• include (string) (optional)

Comma separated list relations to other models. Available: models, mediaType, media, environments.

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": "9b7b5798-c142-4291-8798-8e5f48c5f267",
  "name": "Images & PDFs",
  "metadata": null,
  "model_uuids": [],
  "media_type_id": 8,
  "created_at": "2024-03-04 08:22:09",
  "updated_at": "2024-03-04 08:22:12"
}

---