Duplicate (POST)

ENDPOINT : api/models/-uuid-

SECURITY : authenticated

Headers

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

URL Parameters

name	type	description	example
uuid	string	Pas de description	9c0e3313-1ecb-4ff4-93d9-46114936c20b

Body Parameters

key : environment_id

environment_id details

Pas de description.

name	type	example
environment_id	integer	14

key : name

name details

Pas de description.

name	type	example
name	string	alias

key : display_name

display_name details

Pas de description.

name	type	example
display_name	string	voluptas

key : type

type details

Pas de description.

name	type	example
type	string	custom

key : ref_model_uuid

ref_model_uuid details

Must be a valid UUID..

name	type	example
ref_model_uuid	string	da8952fe-c422-32bc-9c69-6afd3a1e0991

key : format_uuid

format_uuid details

Must be a valid UUID..

name	type	example
format_uuid	string	b40e3ce1-266b-3b35-b6aa-a0c0b6b14d30

key : library_uuids

library_uuids details

Must be a valid UUID..

name	type	example
library_uuids	string[]	5b9cd871-b6b8-374b-9673-d4b24afc7ab8

key : data

data details

Pas de description.

name	type	example
data	object	Pas d’example

Query Parameters

• include (string) (optional)

Comma separated list relations to other models. Available: refModel, subModels, format, libraries, outputs, environment.

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": "9b7b703b-f4ed-4e29-8396-8a8054a98613",
  "name": "Business Card - 85x55mm Recto-Verso",
  "display_name": "Business Card - 85x55mm Recto-Verso",
  "type": "base",
  "ref_model_uuid": null,
  "sub_model_uuids": [],
  "format_uuid": "9b67eb56-6add-4530-a3fb-8248674332eb",
  "library_uuids": [],
  "data": "...",
  "created_at": "2024-03-04 09:31:02",
  "updated_at": "2024-03-04 09:31:02"
}

---

Generate (POST)

ENDPOINT : api/models/-uuid-/generate

SECURITY : authenticated

Headers

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

URL Parameters

name	type	description	example
uuid	string	Pas de description	9c0e3313-1ecb-4ff4-93d9-46114936c20b

Body Parameters

key : types

types details

array of output types, possible values : preview, proof, production.

name	type	example
types	string[]	ducimus

Query Parameters

• include (string) (optional)

Comma separated list relations to other models. Available: refModel, subModels, format, libraries, outputs, environment.

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": "9b798c63-13c1-42f9-ae72-46ba5b337c1b",
    "name": "Business Card - 85x55mm Recto-Verso - proof",
    "type": "proof",
    "url": "http://localhost:82/storage/outputs/9b71dfd1-4f7f-493c-b6a2-c370194cb703/output-proof.pdf",
    "metadata": null,
    "mimetype": "application/pdf",
    "created_at": "2024-03-03T10:58:06.000000Z",
    "updated_at": "2024-03-03T10:58:06.000000Z",
    "producible_type": "MODEL",
    "producible_id": "9b71dfd1-4f7f-493c-b6a2-c370194cb703"
  },
  {
    "uuid": "9b798c64-17c7-449f-b5e1-11eb6b762ac1",
    "name": "Business Card - 85x55mm Recto-Verso - production",
    "type": "production",
    "url": "http://localhost:82/storage/outputs/9b71dfd1-4f7f-493c-b6a2-c370194cb703/output-production.pdf",
    "metadata": null,
    "mimetype": "application/pdf",
    "created_at": "2024-03-03T10:58:07.000000Z",
    "updated_at": "2024-03-03T10:58:07.000000Z",
    "producible_type": "MODEL",
    "producible_id": "9b71dfd1-4f7f-493c-b6a2-c370194cb703"
  }
]

---