documents
Operations addressed under /documents — 8 operations.
aurax-bff-redirect-get-document-by-path
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 DocumentDto.
| Field | Declared type | Nullable |
|---|---|---|
FileName | string | no |
ContentType | string | no |
FileStream | string | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-document-by-path › 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-create-document-by-path
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 ItemUIDto.
| Field | Declared type | Nullable |
|---|---|---|
Cwd | FileDto | no |
Error | object | no |
Details | object | no |
Files | List<FileDto> (collection) | no |
Member names are the service's declaration names.
aurax-bff-create-document-by-path › 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-convert-document
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 string, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.
What the service's own documentation says (the handler that serves this route): The Syncfusion.EJ2.AspNet.Core NuGet package has dependencies, Newtonsoft.Json for JSON serialization and Syncfusion.Licensing for validating Syncfusion license key. https://ej2.syncfusion.com/aspnetcore/documentation/maps/getting-started
Source: the service's own XML documentation comment, read from its source.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_44 | 400 | EJ2_DOCUMENT_EDITOR_DOES_NOT_SUPPORT_THIS_FILE_FORMAT | EJ2 DocumentEditor does not support this file format. File extension: {0} |
aurax-bff-redirect-convert-document › 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-download-document
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route's declared response type is FileStreamResult, which is not a DTO declaration, so there is no member structure in the code to publish. This is what the code says, not a measurement of what the endpoint answers.
aurax-bff-download-document › 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.
search-item
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 ItemUIDto.
| Field | Declared type | Nullable |
|---|---|---|
Cwd | FileDto | no |
Error | object | no |
Details | object | no |
Files | List<FileDto> (collection) | no |
Member names are the service's declaration names.
search-item › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-bff-upload-document
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 UploadDocumentDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | string | no |
Errors | List<Error> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_AURAX_25 | 400 | UPLOAD_DOCUMENT_EXCEPTION |
ERR_AURAX_42 | 400 | UPLOAD_DOCUMENT_CAN_NOT_BE_NULL |
aurax-bff-upload-document › 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-upload-document-by-path
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
aurax-bff-upload-document-by-path › 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-document-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-document-by-id; this entry declares none of its own.
Response body, read from the service source
The route declares its response as DocumentDto.
| Field | Declared type | Nullable |
|---|---|---|
FileName | string | no |
ContentType | string | no |
FileStream | string | no |
Member names are the service's declaration names.
path Parameters
idaurax-bff-redirect-get-document-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
contentTypefileNamefileStream