file-storages
Operations addressed under /file-storages — 5 operations.
aurax-bff-redirect-get-file-storage-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<FileStorageDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Name | string | no |
Description | string | no |
ProtocolType | int | no |
ConnectionString | string | no |
IsActive | bool? | yes |
Member names are the service's declaration names.
aurax-bff-redirect-get-file-storage-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-create-file-storage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_FILE_1 | 400 | THERE_IS_ALREADY_FILE_STORAGE_WITH_THIS_NAME | There is already file storage with this name |
aurax-bff-redirect-create-file-storage › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-file-storage-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as FileStorageDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Name | string | no |
Description | string | no |
ProtocolType | int | no |
ConnectionString | string | no |
IsActive | bool? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_FILE_2 | 400 | FILE_STORAGE_ID_IS_NOT_FOUND | File storage ID is not found |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-file-storage-by-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-update-file-storage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_FILE_2 | 400 | FILE_STORAGE_ID_IS_NOT_FOUND | File storage ID is not found |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-file-storage › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-delete-file-storage
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_FILE_2 | 400 | FILE_STORAGE_ID_IS_NOT_FOUND | File storage ID is not found |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-delete-file-storage › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.