Dashboard

Download Spec

Get images for given TPP/CP

get /dashboard/images

API Key ApiKey

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "file_name": "string",
      "last_modified": "2023-06-07T17:32:28Z",
      "url": "string"
    }
  ],
  "page": null,
  "size": 123,
  "total": null
}

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[object (ImageResponse)]

required

ImageResponse

object (ImageResponse)

file_name

string

required

last_modified

string

date-time

required

url

string

required

page

integer

required

size

int

required

total

integer

required

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Upload Image for TPP/CP

post /dashboard/images

API Key ApiKey

file_name

string

required

image

string

required

Request

{
  "file_name": "string",
  "image": "string"
}

Response

Examples Schema

Successful Response

null

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Delete Image for TPP/CP

delete /dashboard/images

API Key ApiKey

file_name

string

required

Request

{
  "file_name": "string"
}

Response

Examples Schema

Successful Response

null

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?