document-items
Operations addressed under /document-items — 10 operations.
get-document-item-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<DocumentItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
IsUnique | bool | no |
IsActive | bool | no |
TemplateTypeId | Guid? | yes |
TemplateDesignId | Guid? | yes |
DocumentItemDetails | List<DocumentItemDetailDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-document-item-list › 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.
codedescriptionidisActiveisUniquenametemplateDesignIdtemplateTypeIdcreate-document-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 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_DMS_13 | 400 | DOCUMENT_ITEM_ALSO_FOUND | Document item already found. |
create-document-item › Request Body
codeisUniquedescriptionnametemplateDesignIdtemplateTypeIdcreate-document-item › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-document-item-detail-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<DocumentItemDetailDto>.
| Field | Declared type | Nullable |
|---|---|---|
DocumentItemId | Guid | no |
MimeType | int? | yes |
MimeTypeValue | string | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-document-item-detail-list › 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.
documentItemIdidmimeTypePermitted 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 |
get-document-item-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 DocumentItemDto.
| Field | Declared type | Nullable |
|---|---|---|
Code | string | no |
Name | string | no |
Description | string | no |
IsUnique | bool | no |
IsActive | bool | no |
TemplateTypeId | Guid? | yes |
TemplateDesignId | Guid? | yes |
DocumentItemDetails | List<DocumentItemDetailDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_14 | 400 | DOCUMENT_ITEM_NOT_FOUND | Document Item cannot be found. |
ERR_DMS_16 | 400 | DOCUMENT_ITEM_IS_PASSIVE | Document item is passive. |
path Parameters
idget-document-item-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.
codedescriptionidisActiveisUniquenametemplateDesignIdtemplateTypeIdupdate-document-item
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_14 | 400 | DOCUMENT_ITEM_NOT_FOUND | Document Item cannot be found. |
path Parameters
idupdate-document-item › Request Body
isActiveisUniquedescriptionnametemplateDesignIdtemplateTypeIdupdate-document-item › 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-item
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_14 | 400 | DOCUMENT_ITEM_NOT_FOUND | Document Item cannot be found. |
ERR_DMS_45 | 400 | DOCUMENT_ITEM_IS_USED | Document Item is used. |
path Parameters
iddelete-document-item › 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-item-detail
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_DMS_14 | 400 | DOCUMENT_ITEM_NOT_FOUND | Document Item cannot be found. |
ERR_DMS_16 | 400 | DOCUMENT_ITEM_IS_PASSIVE | Document item is passive. |
ERR_DMS_18 | 400 | DOCUMENT_ITEM_DETAIL_ALSO_FOUND | Document Item detail already found. |
path Parameters
idcreate-document-item-detail › Request Body
mimeTypePermitted 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-item-detail › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-document-item-detail-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 DocumentItemDetailDto.
| Field | Declared type | Nullable |
|---|---|---|
DocumentItemId | Guid | no |
MimeType | int? | yes |
MimeTypeValue | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_14 | 400 | DOCUMENT_ITEM_NOT_FOUND | Document Item cannot be found. |
ERR_DMS_19 | 400 | DOCUMENT_ITEM_DETAIL_NOT_FOUND | Document Item detail cannot be found. |
path Parameters
iddocumentItemDetailIdget-document-item-detail-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
delete-document-item-detail
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_14 | 400 | DOCUMENT_ITEM_NOT_FOUND | Document Item cannot be found. |
ERR_DMS_19 | 400 | DOCUMENT_ITEM_DETAIL_NOT_FOUND | Document Item detail cannot be found. |
path Parameters
iddocumentItemDetailIddelete-document-item-detail › 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.
has-document-item-usage
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.
path Parameters
idhas-document-item-usage › 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.