/large_object

Previous/item Next/leaderboard

Last updated 1 month ago

Get a LargeObject

get

Authorizations

Path parameters

largeObjectIdanyrequired

Responses

application/json

objectoptional

application/json

get

GET /api/rest/large_object/{largeObjectId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Deletes a LargeObject

delete

Authorizations

Path parameters

largeObjectIdanyrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/rest/large_object/{largeObjectId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a LargeObject with content

post

Authorizations

Body

objectobjectoptional

metadataobjectoptional

Responses

application/json

objectoptional

application/json

post

POST /api/rest/large_object_mp HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 1839

{
  "object": {
    "contentDisposition": {
      "type": null,
      "parameters": null,
      "fileName": null,
      "creationDate": null,
      "modificationDate": null,
      "readDate": null,
      "size": null
    },
    "entity": null,
    "headers": {
      "empty": null,
      "ANY_ADDITIONAL_PROPERTY": []
    },
    "mediaType": {
      "type": null,
      "subtype": null,
      "parameters": null,
      "wildcardType": null,
      "wildcardSubtype": null
    },
    "messageBodyWorkers": {},
    "parent": {
      "contentDisposition": {
        "type": null,
        "parameters": null,
        "fileName": null,
        "creationDate": null,
        "modificationDate": null,
        "readDate": null,
        "size": null
      },
      "entity": null,
      "headers": {
        "empty": null,
        "ANY_ADDITIONAL_PROPERTY": []
      },
      "mediaType": {
        "type": null,
        "subtype": null,
        "parameters": null,
        "wildcardType": null,
        "wildcardSubtype": null
      },
      "messageBodyWorkers": {},
      "parent": null,
      "providers": {},
      "bodyParts": [
        {
          "contentDisposition": {
            "type": null,
            "parameters": null,
            "fileName": null,
            "creationDate": null,
            "modificationDate": null,
            "readDate": null,
            "size": null
          },
          "entity": null,
          "headers": {
            "empty": null,
            "ANY_ADDITIONAL_PROPERTY": []
          },
          "mediaType": {
            "type": null,
            "subtype": null,
            "parameters": null,
            "wildcardType": null,
            "wildcardSubtype": null
          },
          "messageBodyWorkers": {},
          "parent": null,
          "providers": {},
          "parameterizedHeaders": {
            "empty": null,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "value": null,
                "parameters": null
              }
            ]
          }
        }
      ],
      "parameterizedHeaders": {
        "empty": null,
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "value": null,
            "parameters": null
          }
        ]
      }
    },
    "providers": {},
    "name": null,
    "value": null,
    "content": null,
    "fileName": null,
    "simple": null,
    "formDataContentDisposition": {
      "type": null,
      "parameters": null,
      "fileName": null,
      "creationDate": null,
      "modificationDate": null,
      "readDate": null,
      "size": null,
      "name": null
    },
    "parameterizedHeaders": {
      "empty": null,
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "value": null,
          "parameters": null
        }
      ]
    }
  },
  "metadata": {
    "mimeType": null,
    "read": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "write": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    },
    "delete": {
      "wildcard": null,
      "userIds": [],
      "profileIds": []
    }
  }
}

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

Creates a LargeObject

post

Authorizations

Body

mimeTypeanyrequired

The MIME type associated with the object.

readobjectrequired

writeobjectrequired

deleteobjectrequired

Responses

application/json

objectoptional

application/json

post

POST /api/rest/large_object HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "mimeType": null,
  "read": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "write": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "delete": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  }
}

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

Creates a LargeObject from provided URL

post

Authorizations

Body

mimeTypeanyrequired

The MIME type associated with the object.

readobjectrequired

writeobjectrequired

deleteobjectrequired

fileUrlanyrequired

List with image URLs

Responses

application/json

objectoptional

application/json

post

POST /api/rest/large_object/from_url HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "mimeType": null,
  "read": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "write": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "delete": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "fileUrl": null
}

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

Updates a LargeObject

put

Authorizations

Path parameters

largeObjectIdanyrequired

Body

mimeTypeanyrequired

The MIME type associated with the object.

readobjectrequired

writeobjectrequired

deleteobjectrequired

Responses

application/json

objectoptional

application/json

put

PUT /api/rest/large_object/{largeObjectId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "mimeType": null,
  "read": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "write": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  },
  "delete": {
    "wildcard": null,
    "userIds": [],
    "profileIds": []
  }
}

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

Updates a LargeObject content

put

Authorizations

Path parameters

largeObjectIdanyrequired

Body

anyoptional

Responses

application/json

objectoptional

application/json

put

PUT /api/rest/large_object/{largeObjectId}/content HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*

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