Files
Files service should be used primarily when uploading or downloading files.
Methods
GetStatus
POST https://cca-{region}-saas-{enviroment}.infomaker.io/twirp/cca.Files/GetStatus
Method to call at an interval to check status of an ongoing upload
Request Body
| Name | Type | Description |
|---|---|---|
uploadId | string | The uploadId (Received when an upload is started) |
GetArtifact
POST https://cca-{region}-saas-{enviroment}.infomaker.io/twirp/cca.Files/GetArtifact
Method returns content (as base64 encoded) from artifact file.
Request Body
| Name | Type | Description |
|---|---|---|
uploadId | string | The uploadid (Received when an upload is started) |
name | string | Name of the file |
CreateUpload
POST https://cca-{region}-saas-{enviroment}.infomaker.io/twirp/cca.Files/CreateUpload
Initiate a new upload.
Request Body
| Name | Type | Description |
|---|---|---|
filename | string |
CreateDownload
POST https://cca-{region}-saas-{enviroment}.infomaker.io/twirp/cca.Files/CreateDownload
Initiate a new download
Request Body
| Name | Type | Description |
|---|---|---|
UUID | string | UUID of document |
type | cca.DownloadType | optional with value 'original' or 'presentation', see DownloadType enum |
GetDownloadStatus
POST https://cca-{region}-saas-{enviroment}.infomaker.io/twirp/cca.Files/GetDownloadStatus
Method to call at an interval to check status of downloadable image
Request Body
| Name | Type | Description |
|---|---|---|
downloadId | string | ID of the requested download |
api-method-response endapi-method-response
Enums
cca.DownloadType DownloadType can be passed as a parameter when downloading assets
cca.LockingMode Locking mode is passed as a parameter when saving documents
cca.ProcessingStatus
Last updated