File Uploads

Returns an AWS S3 pre-signed URL for use in uploading a file from a web application

This method contacts S3 and generates a "presigned URL." This URL can be used to post a file. The return value is the URL to post.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service that you are posting on behlaf of
filename required	string The name of the file you're attempting to upload

query Parameters

contentType	string The content type of the file being generate
public	boolean Whether this should be a public file

Responses

200The file upload was saved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

post/fileUploads/{tenantId}/signedUrlRequest/{service}/{filename}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  'https://platform.api.756794052567.rhythmsoftware.com/fileUploads/:tenantId/signedUrlRequest/:service/:filename?contentType=string&public=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"url": "string",
"signed_url": "string",
"download_url": "string"
}

Uploads a file to a temporary staging location

This method uploads a file to a temporary staging location

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service that you are posting on behalf of
filename required	string The name of the file you're attempting to upload

header Parameters

Content-Type

string

Responses

200The file upload was saved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

put/fileUploads/staging/{tenantId}/{service}/{filename}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X PUT \
  https://platform.api.756794052567.rhythmsoftware.com/fileUploads/staging/:tenantId/:service/:filename \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: string'

Retrieves a previously uploaded file

This method retrieves a file that was previously uploaded

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service containing the record this file is related to
id required	string The id of the record this file is related to
fileid required	string The id of the uploaded file

Responses

200The file was retrieved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The specified file does not exist

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

get/fileUploads/{tenantId}/{service}/{id}/{fileid}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://platform.api.756794052567.rhythmsoftware.com/fileUploads/:tenantId/:service/:id/:fileid \
  -H 'Authorization: YOUR_API_KEY_HERE'

Returns an AWS S3 pre-signed URL for use in downloading a file from a web application

This method contacts S3 and generates a "presigned URL." This URL can be used to post a file. The return value is the URL to post.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service containing the record this file is related to
id required	string The id of the record this file is related to
fileid required	string The id of the uploaded file

query Parameters

filename	string An optional filename to enforce for the file
expires	string An optional signed url expire time in seconds, default - 60 (1 minute), max - 259200 (72 hours)

Responses

200The file upload was saved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

get/fileUploads/{tenantId}/signedUrl/{service}/{id}/{fileid}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://platform.api.756794052567.rhythmsoftware.com/fileUploads/:tenantId/signedUrl/:service/:id/:fileid?filename=string&expires=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Retrieves a previously uploaded file

This method retrieves a file that was previously uploaded

Request

Security:

querystring-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service containing the record this file is related to
id required	string The id of the record this file is related to
fileid required	string The id of the uploaded file

Responses

200The file was retrieved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The specified file does not exist

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

get/fileUploads/{tenantId}/{service}/{id}/{fileid}/image

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://platform.api.756794052567.rhythmsoftware.com/fileUploads/:tenantId/:service/:id/:fileid/image \
  -H 'access_token: YOUR_API_KEY_HERE'

Gets a presigned URL to update for uploading a public image

This method retrieves a file that was previously uploaded

Request

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service containing the record this file is related to
id required	string The id of the record this file is related to
fileid required	string The id of the uploaded file

query Parameters

isPublic	boolean Should this be a public signed url
contentType	string The content type of the file being generate

Responses

200The file upload was saved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The specified file does not exist

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

get/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/presignedUrlForUpload

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://platform.api.756794052567.rhythmsoftware.com/fileUploads/:tenantId/public/:service/:id/:fileid/presignedUrlForUpload?isPublic=true&contentType=string'

Retrieves a previously uploaded file

This method retrieves a file that was previously uploaded

Request

path Parameters

tenantId required	string The id of the tenant being accessed
service required	string The service containing the record this file is related to
id required	string The id of the record this file is related to
fileid required	string The id of the uploaded file

Responses

200The file was retrieved successfully

400You supplied an invalid request

401Unauthorized

403Forbidden

404The specified file does not exist

429Limit exceeded... unable to add file upload based on tenant limits.

500General server error

get/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/image

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://platform.api.756794052567.rhythmsoftware.com/fileUploads/:tenantId/public/:service/:id/:fileid/image