UploadCategory

Category for file uploads. Can also be used to restrict access for certain roles.

Operations

GET/v1/upload-categories/specGET/v1/upload-categoriesPOST/v1/upload-categoriesGET/v1/upload-categories/{uploadCategoryId}PATCH/v1/upload-categories/{uploadCategoryId}

---

OpenAPI Spec

GET

/v1/upload-categories/spec

Get OpenAPI 3.1.0 spec for UploadCategory API

Responses

Returns OpenAPI 3.1.0 spec for UploadCategory API

Content-Type

application/json

{

}

GET

/v1/upload-categories/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List UploadCategories

GET

/v1/upload-categories

List UploadCategories

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

Minimum0

Default0

size

Typenumber

Minimum1

Maximum20

Default10

deactivatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"name": "string",

"color": "string",

"order": 1,

"deactivatedAt": "string",

"roleIds": [

0

],

"additionalProperties": "string"

}

]

}

GET

/v1/upload-categories

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

deactivatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new UploadCategory

POST

/v1/upload-categories

Create a new UploadCategory

Authorizations

apiKey

TypeHTTP (bearer)

Request Body

application/json

{

"name": "string",

"color": "string",

"order": 1,

"roleIds": [

0

]

}

Responses

UploadCategory found

Content-Type

application/json

{

"id": 0,

"name": "string",

"color": "string",

"order": 1,

"deactivatedAt": "string",

"roleIds": [

0

],

"additionalProperties": "string"

}

POST

/v1/upload-categories

Playground

Server

Authorization

apiKey

Body

Samples

cURL

JavaScript

PHP

Python

---

Get a UploadCategory

GET

/v1/upload-categories/{uploadCategoryId}

Get a UploadCategory by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

uploadCategoryId*

Typeinteger

Required

Format"int32"

Responses

UploadCategory found

Content-Type

application/json

{

"id": 0,

"name": "string",

"color": "string",

"order": 1,

"deactivatedAt": "string",

"roleIds": [

0

],

"additionalProperties": "string"

}

GET

/v1/upload-categories/{uploadCategoryId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

uploadCategoryId*

Samples

cURL

JavaScript

PHP

Python

---

Update a UploadCategory

PATCH

/v1/upload-categories/{uploadCategoryId}

Update a UploadCategory by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

uploadCategoryId*

Typeinteger

Required

Format"int32"

Request Body

application/json

{

"name": "string",

"color": "string",

"order": 1,

"deactivatedAt": "string",

"roleIds": [

0

]

}

Responses

UploadCategory found

Content-Type

application/json

{

"id": 0,

"name": "string",

"color": "string",

"order": 1,

"deactivatedAt": "string",

"roleIds": [

0

],

"additionalProperties": "string"

}

PATCH

/v1/upload-categories/{uploadCategoryId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

uploadCategoryId*

Body

Samples

cURL

JavaScript

PHP

Python

---