Appearance
File
User-specific files and other files related functionality: Image processing, preview etc.
Salaxy API v03, Finland only. 6 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.
The reference wins
These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.
GET /v03/api/files
Returns list of files for the current owner.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
$search | query | string | ||
$filter | query | string | Specifies the logic to pull back a subset of records. | |
$orderby | query | string | Specifies the values used to sort the collection of entries. | |
$select | query | string | The $select system query option allows the clients to requests a limited set of properties for each entry. | |
$top | query | number | Specifies the subset of entries by count. | |
$skip | query | number | Specifies the count of entries to skip. | |
$count | query | boolean | Indicates whether or not to include a total entry count. |
Response: PageResultOfFileListItem
Try it: interactive reference
GET /v03/api/files/{id}
Gets a single object based on identier
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Unique identifier for the object |
Response: BlobFile
Try it: interactive reference
GET /v03/api/files/{id}/content
Gets the content for a single file.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Response: string
Try it: interactive reference
GET /v03/api/files/type/{type}
Gets all the Files of specific type for this user.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
type | path | BlobFileType | yes |
Response: BlobFile[]
Try it: interactive reference
GET /v03/api/files/{id}/stream
Gets the file stream / blob for a single file
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
Response: string
Try it: interactive reference
GET /v03/api/files/{id}/preview
Gets the preview image (currently always PNG) for the file, if available.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Identifier of the file that potentially has preview |
Response: string
Try it: interactive reference

