File Upload - Simple

POST 
/api/inspect/v1/file/upload/simple

This endpoint allows users to upload files smaller than 5MB directly to the cloud. It is suitable for simple file uploads that don’t involve large files or multiple files in one request. The uploaded file can be any supported file type and is processed immediately after upload. Ensure that the file size does not exceed the 5MB limit.

Request

Query Parameters

assetID uuidrequired

The unique identifier (UUID) of the asset to which the uploaded file is associated. This parameter ensures that the file is linked to a specific asset for further processing or retrieval.

size int64required

The size of the file being uploaded, in bytes. This value helps ensure that the file does not exceed the 5MB limit and can be processed by the cloud service.

multipart/form-data

Body

file binaryrequired

The actual binary content of the file to be uploaded. Ensure that the file size is less than 5MB for successful processing.

Responses

201

201 Created. The file was successfully uploaded. The response includes the following data:

application/json

Schema

Schema

data

Details of the uploaded file.

id uuid

The unique identifier (UUID) assigned to the uploaded file. This can be used to reference the file in future operations, such as creating spot attachment or marking it as fully uploaded or retrieving it later.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

400

400 Bad Request. The request is invalid. This may occur if required parameters are missing or invalid. Ensure that all required parameters are included and valid.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

401

401 Unauthorized. Authentication is required and was not provided or is invalid. Ensure that the correct credentials or tokens are included in the request.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

403

403 Forbidden. The client does not have permission to perform this action. This might happen if the client lacks the necessary privileges to interact with the specified entity.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

404

404 Not Found. The specified entity does not exist. Verify that the reference given is correct and that the entity is available.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

500

500 Internal Server Error. An error occurred on the server while processing the request. Retry the operation or contact support if the issue persists.

application/json

Schema

Schema

errorDescription string

A detailed description of the error, providing more context or information about what went wrong. This is intended to help understand the cause of the error and how to resolve it.

error string

A code representing the specific error that occurred. This can be used to programmatically identify and handle the error.

Example (from schema)

{
  "errorDescription": "permission denied",
  "error": "Forbidden"
}

Loading...