folders
Operations addressed under /folders — 9 operations.
create-folder
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<string>, 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 string. 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 | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_4 | 400 | FOLDER_IS_ALSO_FOUND | Folder is already found. |
create-folder › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
idcheck-folder
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 bool, a scalar rather than an object. There is no field tree below because there are no fields: the body is the JSON literal true or false. This is a complete answer read from the declaration, not a gap.
query Parameters
pathcheck-folder › 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.
get-root-folder
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 RootFolderDto.
| Field | Declared type | Nullable |
|---|---|---|
FolderId | string | no |
FolderName | string | no |
Properties | List<IProperty> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_9 | 400 | PARENT_FOLDER_NOT_FOUND | Parent folder cannot be found. |
get-root-folder › 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.
folderIdfolderNamepropertiesadd-folder-to-folder
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_DMS_47 | 400 | ROOT_FOLDER_CANNOT_BE_MOVED | Root folder cannot be moved. |
path Parameters
folderIdadd-folder-to-folder › 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.
delete-folder
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_DMS_6 | 400 | FOLDER_HAS_CHILDREN | Folder has children. |
path Parameters
folderIddelete-folder › 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.
get-folder-children
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 List<FolderChildrenTreeDto>.
| Field | Declared type | Nullable |
|---|---|---|
FolderId | string | no |
FolderName | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_7 | 400 | CHILDREN_FOLDER_NOT_FOUND | Children folder cannot be found. |
path Parameters
idget-folder-children › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
folderIdfolderNamesearch-document-in-folder
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 List<SearchDocumentResultDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | string | no |
Name | string | no |
CreationDate | DateTime | no |
LastModificationDate | DateTime | no |
Member names are the service's declaration names.
path Parameters
idtermsearch-document-in-folder › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
delete-folder-hierarchy
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
iddelete-folder-hierarchy › 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.
get-parent-folder-tree
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 ParentFolderTreeDto.
| Field | Declared type | Nullable |
|---|---|---|
FolderId | string | no |
FolderName | string | no |
ParentItem | ParentFolderTreeDto | no |
Documents | List<DocumentInfo> (collection) | no |
Member names are the service's declaration names.
path Parameters
idget-parent-folder-tree › 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.
folderIdfolderName