documents
Operations addressed under /documents — 21 operations.
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.
query Parameters
pathget-document-by-path › 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.
contentTypefileNamefileStreamcreate-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 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_1 | 400 | DOCUMENT_IS_ALSO_FOUND | Document is already found. |
ERR_DMS_22 | 400 | DMS_MODEL_NOT_FOUND | DMS Model cannot be found. |
ERR_DMS_27 | 400 | DMS_MODEL_ITEM_NOT_FOUND | DMS model item cannot be found. |
create-document › Request Body
aspectPropertiescontentcustomTypePropertiesdescriptiondocumentNamefolderPathmimeTypePermitted values — validated against the mime_type parameter.
| Value | Meaning |
|---|---|
1 | image/png |
2 | text/plain |
3 | application/pdf |
4 | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
5 | application/msword |
6 | application/rtf |
7 | text/xml |
8 | image/jpeg |
9 | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
10 | application/vnd.ms-excel |
Permitted values — validated against the mime_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | image/png | en: image/png · tr: image/png · ar: image/png |
2 | text/plain | en: text/plain · tr: text/plain · ar: text/plain |
3 | application/pdf | no label seeded |
4 | application/vnd.openxmlformats-officedocument.wordprocessingml.document | no label seeded |
5 | application/msword | no label seeded |
6 | application/rtf | no label seeded |
7 | text/xml | no label seeded |
8 | image/jpeg | en: image/jpeg · tr: image/jpeg · ar: image/jpeg |
9 | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | en: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet · tr: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
10 | application/vnd.ms-excel | en: application/vnd.ms-excel · tr: application/vnd.ms-excel |
create-document › 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 |
iddocument-base-query
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the document-base-query service definition through POST /documents/base-query.
Response body, read from the service source
The route declares its response as List<DocumentQueryDto>.
| Field | Declared type | Nullable |
|---|---|---|
Properties | Dictionary<string, object> | no |
Member names are the service's declaration names.
document-base-query › 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.
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} |
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.
copy-document
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
copy-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.
move-document-by-path
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_32 | 400 | DOCUMENT_NOT_FOUND | Document cannot be found. |
ERR_DMS_5 | 400 | FOLDER_NOT_FOUND | Folder cannot be found. |
move-document-by-path › Request Body
namepathtargetPathmove-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.
document-query
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<DocumentQueryDto>.
| Field | Declared type | Nullable |
|---|---|---|
Properties | Dictionary<string, object> | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_22 | 400 | DMS_MODEL_NOT_FOUND | DMS Model cannot be found. |
ERR_DMS_27 | 400 | DMS_MODEL_ITEM_NOT_FOUND | DMS model item cannot be found. |
ERR_DMS_43 | 400 | PARAMETERS_MUST_BE_DEFINED | Parameter must be defined. |
ERR_DMS_49 | 400 | DMS_QUERY_NOT_FOUND | not published in this snapshot |
ERR_DMS_50 | 400 | DMS_MODEL_ITEM_MAP_NOT_FOUND | Parent path must start with a '/'! |
ERR_DMS_51 | 400 | DMS_MANDATORY_MODEL_ITEM_MAP_NOT_FOUND | not published in this snapshot |
ERR_DMS_52 | 400 | DMS_SESSION_QUERY_ERROR | Alfresco session query error occurred |
document-query › 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.
idpropertiesupload-document
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_1 | 400 | DOCUMENT_IS_ALSO_FOUND | Document is already found. |
ERR_DMS_22 | 400 | DMS_MODEL_NOT_FOUND | DMS Model cannot be found. |
ERR_DMS_27 | 400 | DMS_MODEL_ITEM_NOT_FOUND | DMS model item cannot be found. |
ERR_DMS_49 | 400 | DOCUMENT_STREAM_IS_BROKEN | not published in this snapshot |
upload-document › Request Body
aspectPropertiescmisProviderPermitted values — validated against the cmis_provider parameter.
| Value | Meaning |
|---|---|
1 | Alfresco |
2 | OpenKM |
Permitted values — validated against the cmis_provider parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Alfresco | en: Alfresco · tr: Alfresco · ar: الفريسو |
2 | OpenKM | en: OpenKM · tr: OpenKM · ar: مفتوح كي إم |
contentcustomTypePropertiesdocumentNamefolderPathmimeTypePermitted values — validated against the mime_type parameter.
| Value | Meaning |
|---|---|
1 | image/png |
2 | text/plain |
3 | application/pdf |
4 | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
5 | application/msword |
6 | application/rtf |
7 | text/xml |
8 | image/jpeg |
9 | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
10 | application/vnd.ms-excel |
Permitted values — validated against the mime_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | image/png | en: image/png · tr: image/png · ar: image/png |
2 | text/plain | en: text/plain · tr: text/plain · ar: text/plain |
3 | application/pdf | no label seeded |
4 | application/vnd.openxmlformats-officedocument.wordprocessingml.document | no label seeded |
5 | application/msword | no label seeded |
6 | application/rtf | no label seeded |
7 | text/xml | no label seeded |
8 | image/jpeg | en: image/jpeg · tr: image/jpeg · ar: image/jpeg |
9 | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | en: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet · tr: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
10 | application/vnd.ms-excel | en: application/vnd.ms-excel · tr: application/vnd.ms-excel |
versionTypePermitted values — validated against the version_type parameter.
| Value | Meaning |
|---|---|
0 | New |
1 | Major |
2 | Minor |
Permitted values — validated against the version_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | New | en: New · tr: New · ar: جديد |
1 | Major | en: Major · tr: Major · ar: رئيسي |
2 | Minor | en: Minor · tr: Minor · ar: ثانوي |
descriptionupload-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.
add-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_22 | 400 | DMS_MODEL_NOT_FOUND | DMS Model cannot be found. |
ERR_DMS_27 | 400 | DMS_MODEL_ITEM_NOT_FOUND | DMS model item cannot be found. |
path Parameters
idadd-to-folder › Request Body
aspectPropertiescustomTypePropertiesfolderIdadd-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.
cancel-checkout-document
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 |
|---|---|
ERR_DMS_99 | 400 |
path Parameters
idcancel-checkout-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.
checkout-document
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 | Message |
|---|---|---|
ERR_DMS_21 | 400 | DMS Model definition already found. |
path Parameters
idcheckout-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.
delete-document-content-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
iddelete-document-content-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.
create-document-from-source
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-document-from-source › 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.
move-document
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_48 | 400 | DOCUMENT_NAME_ALREADY_EXISTS | Any document with this name already exists. |
path Parameters
idmove-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.
update-content
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idupdate-content › 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.
update-document-property-by-id
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_22 | 400 | DMS_MODEL_NOT_FOUND | DMS Model cannot be found. |
ERR_DMS_27 | 400 | DMS_MODEL_ITEM_NOT_FOUND | DMS model item cannot be found. |
path Parameters
idupdate-document-property-by-id › Request Body optional
aspectPropertiescmisProviderPermitted values — validated against the cmis_provider parameter.
| Value | Meaning |
|---|---|
1 | Alfresco |
2 | OpenKM |
Permitted values — validated against the cmis_provider parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Alfresco | en: Alfresco · tr: Alfresco · ar: الفريسو |
2 | OpenKM | en: OpenKM · tr: OpenKM · ar: مفتوح كي إم |
customTypePropertiesdescriptionversionTypePermitted values — validated against the version_type parameter.
| Value | Meaning |
|---|---|
0 | New |
1 | Major |
2 | Minor |
Permitted values — validated against the version_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | New | en: New · tr: New · ar: جديد |
1 | Major | en: Major · tr: Major · ar: رئيسي |
2 | Minor | en: Minor · tr: Minor · ar: ثانوي |
update-document-property-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.
get-document-version-history-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 List<DocumentVersionDto>.
| Field | Declared type | Nullable |
|---|---|---|
VersionSeriesId | string | no |
Name | string | no |
Version | string | no |
CreatedBy | string | no |
IsLatestVersion | bool? | yes |
IsMajorVersion | bool? | yes |
IsVersionable | bool | no |
Member names are the service's declaration names.
path Parameters
idget-document-version-history-by-id › 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.
createdByidisLatestVersionisMajorVersionisVersionablenameversionversionSeriesIdcreate-document-version
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idcreate-document-version › Request Body
contentfileNamemimeTypePermitted values — validated against the mime_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | image/png | en: image/png · tr: image/png · ar: image/png |
2 | text/plain | en: text/plain · tr: text/plain · ar: text/plain |
3 | application/pdf | no label seeded |
4 | application/vnd.openxmlformats-officedocument.wordprocessingml.document | no label seeded |
5 | application/msword | no label seeded |
6 | application/rtf | no label seeded |
7 | text/xml | no label seeded |
8 | image/jpeg | en: image/jpeg · tr: image/jpeg · ar: image/jpeg |
9 | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | en: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet · tr: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
10 | application/vnd.ms-excel | en: application/vnd.ms-excel · tr: application/vnd.ms-excel |
versionCommentcreate-document-version › 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-document-all-version
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
iddelete-document-all-version › 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-document-by-version
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.
path Parameters
idversionget-document-by-version › 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.
contentTypefileNamefileStreamdelete-document-by-version
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idversiondelete-document-by-version › 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.