Image

Definition

JSON

image.json

{
  "id": 0,
  "filename": "",
  "filepath": "",
  "status": 0,
  "createdAt": "",
  "updatedAt": "",
}

Typescript

image.ts

export interface IImage {
    id: number;
    filename: string;
    filepath: string;
    status: number;
    createdAt: Date | null;
    updatedAt: Date | null;
}

Get Images

Curl

curl -X GET "${baseUrl}/image/?filter=${filter}&orderBy=${orderBy}&page=${page}&pageSize=${pageSize}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Typescript

const response = await fetch("${baseUrl}/image/?filter=${filter}&orderBy=${orderBy}&page=${page}&pageSize=${pageSize}", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Get Image

Curl

curl -X GET "${baseUrl}/image/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Typescript

const response = await fetch("${baseUrl}/image/${id}", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Apply Image.ID

Curl

curl -X POST "${baseUrl}/apply/image/id/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Typescript

const response = await fetch("${baseUrl}/apply/image/id/", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
  body: JSON.stringify(payload),
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Create Image

Curl

curl -X POST "${baseUrl}/image/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @image.json

info

image.json

{
  "filename": "",
  "filepath": "",
  "status": 0,
}

tip

success status: 201

Typescript

const response = await fetch("${baseUrl}/image/", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
  body: JSON.stringify(payload),
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Update Image

Curl

#!/bin/bash
curl -X PUT "${baseUrl}/image/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @image.json

info

image.json

{
  "filename": "",
  "filepath": "",
  "status": 0,
}

Typescript

const response = await fetch("${baseUrl}/image/${id}", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
  body: JSON.stringify(payload),
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Patch Image

Curl

curl -X PATCH "${baseUrl}/image/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -H "Attrs: filename,filepath,status" \
   -d @image.json

info

image.json

{
  "filename": "",
  "filepath": "",
  "status": 0,
}

Typescript

const response = await fetch("${baseUrl}/image/${id}", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
    "Attrs": "${attrs}",
  },
  body: JSON.stringify(payload),
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Update Image Status

Curl

curl -X PATCH "${baseUrl}/image/${id}/status/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @image.json

info

image.json

{
  "status": 0
}

Typescript

const response = await fetch("${baseUrl}/image/${id}/status/", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
  body: JSON.stringify(payload),
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}

Destroy Image

Curl

curl -X DELETE "${baseUrl}/image/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Typescript

const response = await fetch("${baseUrl}/image/${id}", {
  method: "DELETE",
  headers: {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`,
  },
})

const data = await response.json();

if (!response.ok) {
  throw new Error(data);
}