Get Comment Attachment Upload URL

POST 
/organizations/:organizationId/work-orders/:workOrderId/attachments/upload-url

Get a pre-signed URL for uploading work order COMMENT attachments. NOTE: General work order attachments use AWS Amplify Storage directly from frontend.

Request

Path Parameters

organizationId stringrequired

Organization ID

workOrderId stringrequired

Work Order ID

application/json

Body

required

filename stringrequired

Name of the file to upload

contentType stringrequired

MIME type of the file

size numberrequired

Size of the file in bytes

Responses

200

application/json

Schema

Schema

uploadUrl stringrequired

Pre-signed URL for upload

key stringrequired

S3 key of the file

expiresIn numberrequired

URL expiration time in seconds

Example (from schema)

{
  "uploadUrl": "string",
  "key": "string",
  "expiresIn": 0
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...