/large_object

Creates a LargeObject with content

post

/large_object_mp

Authorizations

auth_bearersession_secret

Body

objectobject

metadataobject

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/large_object_mp' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --form 'object=[object Object]' \
  --form 'metadata=[object Object]'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Creates a LargeObject

post

/large_object

Authorizations

auth_bearersession_secret

Body

mimeTypeanyrequired

The MIME type associated with the object.

readobjectrequired

writeobjectrequired

deleteobjectrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/large_object' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "mimeType": null,
    "read": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "write": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "delete": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    }
  }'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Creates a LargeObject from provided URL

post

/large_object/from_url

Authorizations

auth_bearersession_secret

Body

mimeTypeanyrequired

The MIME type associated with the object.

readobjectrequired

writeobjectrequired

deleteobjectrequired

fileUrlanyrequired

List with image URLs

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/large_object/from_url' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "mimeType": null,
    "read": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "write": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "delete": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "fileUrl": null
  }'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Get a LargeObject

get

/large_object/{largeObjectId}

Authorizations

auth_bearersession_secret

Path parameters

largeObjectIdanyrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://localhost:8080/api/rest/large_object/{largeObjectId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Updates a LargeObject

put

/large_object/{largeObjectId}

Authorizations

auth_bearersession_secret

Path parameters

largeObjectIdanyrequired

Body

mimeTypeanyrequired

The MIME type associated with the object.

readobjectrequired

writeobjectrequired

deleteobjectrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/large_object/{largeObjectId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "mimeType": null,
    "read": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "write": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "delete": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    }
  }'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Deletes a LargeObject

delete

/large_object/{largeObjectId}

Authorizations

auth_bearersession_secret

Path parameters

largeObjectIdanyrequired

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/large_object/{largeObjectId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}

Updates a LargeObject content

put

/large_object/{largeObjectId}/content

Authorizations

auth_bearersession_secret

Path parameters

largeObjectIdanyrequired

Body

any

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/large_object/{largeObjectId}/content' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}