Platform
/
File Uploads

Platform (v1-2025-04-18)

The Platform API contains tenant level configuration and settings used throughout Rhythm. This includes Saved Queries, Custom Fields, and Forms.

Download OpenAPI description
platform-v1.json
platform-v1.yaml
Languages
Servers
Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/

https://platform.api.rhythmsoftware.com/

360 Screens

360 Screens

Operations

Custom Fields

Custom Fields

Operations

Custom Objects

Custom Objects

Operations

Custom Query Definitions

Custom Query Definitions

Operations

Custom Record Actions

Custom Record Actions

Operations

Customization Config Settings

Customization Config Settings

Operations

Directory Entry Comments

Directory Entry Comments

Operations

Email Activities

Email Activities

Operations

Email Integrations

Email Integrations

Operations

File Uploads

File Uploads

Operations

Uploads a file to a temporary staging location

Request

This method uploads a file to a temporary staging location

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service that you are posting on behalf of

filenamestringrequired

The name of the file you're attempting to upload

Headers
Content-Typestring
curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/staging/{tenantId}/{service}/{filename}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: string'

Responses

The file upload was saved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Content-Lengthstring
Content-Typestring
Datestring
Body*/*
object(Empty Schema)

Retrieves a previously uploaded file

Request

This method retrieves a file that was previously uploaded

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service containing the record this file is related to

idstringrequired

The id of the record this file is related to

fileidstringrequired

The id of the uploaded file

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/image'

Responses

The file was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Content-Dispositionstring
Content-Lengthstring
Content-Typestring
Datestring
Body*/*
object(Empty Schema)

Gets a presigned URL to update for uploading a public image

Request

This method retrieves a file that was previously uploaded

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service containing the record this file is related to

idstringrequired

The id of the record this file is related to

fileidstringrequired

The id of the uploaded file

Query
isPublicboolean

Should this be a public signed url

contentTypestring

The content type of the file being generate

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

Responses

The file upload was saved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Body*/*
download_urlstring(Download Url)

The pre-signed url to use to download the temporary fiel once it has been uploaded

signed_urlstring(Signed Url)

The pre-signed url to upload the file

urlstring(Url)

The S3 location of the file

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

Request

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.

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service containing the record this file is related to

idstringrequired

The id of the record this file is related to

fileidstringrequired

The id of the uploaded file

Query
filenamestring

An optional filename to enforce for the file

expiresstring

An optional signed url expire time in seconds, default - 60 (1 minute), max - 259200 (72 hours)

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/signedUrl/{service}/{id}/{fileid}?expires=string&filename=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The file upload was saved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

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

Request

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.

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service that you are posting on behlaf of

filenamestringrequired

The name of the file you're attempting to upload

Query
contentTypestring

The content type of the file being generate

publicboolean

Whether this should be a public file

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/signedUrlRequest/{service}/{filename}?contentType=string&public=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The file upload was saved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
download_urlstring(Download Url)

The pre-signed url to use to download the temporary fiel once it has been uploaded

signed_urlstring(Signed Url)

The pre-signed url to upload the file

urlstring(Url)

The S3 location of the file

Response
application/json
{
  "download_url": "string",
  "signed_url": "string",
  "url": "string"
}

Retrieves a previously uploaded file

Request

This method retrieves a file that was previously uploaded

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service containing the record this file is related to

idstringrequired

The id of the record this file is related to

fileidstringrequired

The id of the uploaded file

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/{service}/{id}/{fileid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The file was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Content-Dispositionstring
Content-Lengthstring
Content-Typestring
Datestring
Body*/*
object(Empty Schema)

Retrieves a previously uploaded file

Request

This method retrieves a file that was previously uploaded

Path
tenantIdstringrequired

The id of the tenant being accessed

servicestringrequired

The service containing the record this file is related to

idstringrequired

The id of the record this file is related to

fileidstringrequired

The id of the uploaded file

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/platform/platform-v1/fileUploads/{tenantId}/{service}/{id}/{fileid}/image' \
  -H 'access_token: YOUR_API_KEY_HERE'

Responses

The file was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Content-Dispositionstring
Content-Lengthstring
Content-Typestring
Datestring
Body*/*
object(Empty Schema)

Page Layouts

Page Layouts

Operations

Query Delivery Schedules

Query Delivery Schedules

Operations

Query User Profiles

Query User Profiles

Operations

Record Alert Rule Sets

Record Alert Rule Sets

Operations

Record Alerts

Record Alerts

Operations

Saved Queries

Saved Queries

Operations

Saved Reports

Saved Reports

Operations

Saved Searches

Saved Searches

Operations

Service Configurations

Service Configurations

Operations

Service Metadata

Service Metadata

Operations

Task Assignment Roles

Task Assignment Roles

Operations

Task Queues

Task Queues

Operations

Task Types

Task Types

Operations

Tasks

Tasks

Operations

Web Form Drafts

Web Form Drafts

Operations

Web Forms

Web Forms

Operations

Workflows

Workflows

Operations