dms-models
Operations addressed under /dms-models — 14 operations.
get-dms-model-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<DmsModelDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CmisProvider | int | no |
Name | string | no |
IsActive | bool | no |
DmsModelItems | List<DmsModelItemDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-dms-model-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.
cmisProviderPermitted 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: مفتوح كي إم |
idisActivenamecreate-dms-model
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_21 | 400 | DMS_MODEL_DEFINITION_ALSO_FOUND | DMS Model definition already found. |
ERR_DMS_25 | 400 | CANNOT_DEFINE_WITH_SPACES_FOR_NAME_FIELD | Cannot define with spaces for name field. |
create-dms-model › Request Body
cmisProviderPermitted 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: مفتوح كي إم |
namecreate-dms-model › 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.
generate-dms-model
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.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_DMS_20 | 400 | CMIS_PROVIDER_NOT_FOUND | CMIS provider cannot be found. |
generate-dms-model › 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-dms-model-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<DmsModelItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
DmsModelId | Guid | no |
CmisType | int | no |
ItemName | string | no |
ParentDmsModelItemId | Guid? | yes |
DataType | int | no |
IsMandatory | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-dms-model-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.
cmisTypePermitted values — validated against the cmis_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Custom Type | en: Custom Type · tr: Custom Type · ar: نوع مخصص |
2 | Aspects | en: Aspects · tr: Aspects · ar: جوانب |
3 | Properties | en: Properties · tr: Properties · ar: خصائص |
4 | Seed Data | no label seeded |
dataTypePermitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Guid | en: Guid · tr: Guid · ar: إرشاد |
2 | Integer | en: Integer · tr: Integer · ar: عدد صحيح |
3 | String | en: String · tr: String · ar: سلسلة |
4 | Numeric | en: Numeric · tr: Numeric · ar: رقمي |
5 | Money | en: Money · tr: Money · ar: مال |
6 | Date | en: Date · tr: Date · ar: تاريخ |
7 | TimeStamp | en: TimeStamp · tr: TimeStamp · ar: الطابع الزمني |
8 | Time | en: Time · tr: Time · ar: الوقت |
9 | BigInt | en: BigInt · tr: BigInt · ar: عدد كبير |
10 | Json | en: Json · tr: Json · ar: جيسون |
11 | Boolean | en: Boolean · tr: Boolean · ar: بوليياني |
dmsModelIdidisMandatoryitemNameparentDmsModelItemIdget-dms-model-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 DmsModelDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
CmisProvider | int | no |
Name | string | no |
IsActive | bool | no |
DmsModelItems | List<DmsModelItemDto> (collection) | 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. |
path Parameters
idget-dms-model-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.
cmisProviderPermitted 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: مفتوح كي إم |
idisActivenameupdate-dms-model
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. |
path Parameters
idupdate-dms-model › 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-dms-model
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_46 | 400 | DMS_MODEL_IS_USED | DMS Model is used. |
path Parameters
iddelete-dms-model › 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-dms-model-item-list-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 IEnumerable<DmsModelItemDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
DmsModelId | Guid | no |
CmisType | int | no |
ItemName | string | no |
ParentDmsModelItemId | Guid? | yes |
DataType | int | no |
IsMandatory | bool | 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. |
path Parameters
idget-dms-model-item-list-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.
cmisTypePermitted values — validated against the cmis_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Custom Type | en: Custom Type · tr: Custom Type · ar: نوع مخصص |
2 | Aspects | en: Aspects · tr: Aspects · ar: جوانب |
3 | Properties | en: Properties · tr: Properties · ar: خصائص |
4 | Seed Data | no label seeded |
dataTypePermitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Guid | en: Guid · tr: Guid · ar: إرشاد |
2 | Integer | en: Integer · tr: Integer · ar: عدد صحيح |
3 | String | en: String · tr: String · ar: سلسلة |
4 | Numeric | en: Numeric · tr: Numeric · ar: رقمي |
5 | Money | en: Money · tr: Money · ar: مال |
6 | Date | en: Date · tr: Date · ar: تاريخ |
7 | TimeStamp | en: TimeStamp · tr: TimeStamp · ar: الطابع الزمني |
8 | Time | en: Time · tr: Time · ar: الوقت |
9 | BigInt | en: BigInt · tr: BigInt · ar: عدد كبير |
10 | Json | en: Json · tr: Json · ar: جيسون |
11 | Boolean | en: Boolean · tr: Boolean · ar: بوليياني |
dmsModelIdidisMandatoryitemNameparentDmsModelItemIdcreate-dms-model-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_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_36 | 400 | DMS_MODEL_ITEM_ALSO_FOUND | DMS Model item already found. |
path Parameters
idcreate-dms-model-item › Request Body
cmisTypePermitted values — validated against the cmis_type parameter.
| Value | Meaning |
|---|---|
1 | Custom Type |
2 | Aspects |
3 | Properties |
4 | Seed Data |
Permitted values — validated against the cmis_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Custom Type | en: Custom Type · tr: Custom Type · ar: نوع مخصص |
2 | Aspects | en: Aspects · tr: Aspects · ar: جوانب |
3 | Properties | en: Properties · tr: Properties · ar: خصائص |
4 | Seed Data | no label seeded |
dataTypePermitted values — validated against the data_type parameter.
| Value | Meaning |
|---|---|
1 | Guid |
2 | Integer |
3 | String |
4 | Numeric |
5 | Money |
6 | Date |
7 | TimeStamp |
8 | Time |
9 | BigInt |
10 | Json |
11 | Boolean |
Permitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Guid | en: Guid · tr: Guid · ar: إرشاد |
2 | Integer | en: Integer · tr: Integer · ar: عدد صحيح |
3 | String | en: String · tr: String · ar: سلسلة |
4 | Numeric | en: Numeric · tr: Numeric · ar: رقمي |
5 | Money | en: Money · tr: Money · ar: مال |
6 | Date | en: Date · tr: Date · ar: تاريخ |
7 | TimeStamp | en: TimeStamp · tr: TimeStamp · ar: الطابع الزمني |
8 | Time | en: Time · tr: Time · ar: الوقت |
9 | BigInt | en: BigInt · tr: BigInt · ar: عدد كبير |
10 | Json | en: Json · tr: Json · ar: جيسون |
11 | Boolean | en: Boolean · tr: Boolean · ar: بوليياني |
isMandatoryitemNameparentDmsModelItemIdcreate-dms-model-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-dms-model-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 DmsModelItemDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
DmsModelId | Guid | no |
CmisType | int | no |
ItemName | string | no |
ParentDmsModelItemId | Guid? | yes |
DataType | int | no |
IsMandatory | bool | 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. |
path Parameters
iddmsModelItemIdget-dms-model-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.
cmisTypePermitted values — validated against the cmis_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Custom Type | en: Custom Type · tr: Custom Type · ar: نوع مخصص |
2 | Aspects | en: Aspects · tr: Aspects · ar: جوانب |
3 | Properties | en: Properties · tr: Properties · ar: خصائص |
4 | Seed Data | no label seeded |
dataTypePermitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Guid | en: Guid · tr: Guid · ar: إرشاد |
2 | Integer | en: Integer · tr: Integer · ar: عدد صحيح |
3 | String | en: String · tr: String · ar: سلسلة |
4 | Numeric | en: Numeric · tr: Numeric · ar: رقمي |
5 | Money | en: Money · tr: Money · ar: مال |
6 | Date | en: Date · tr: Date · ar: تاريخ |
7 | TimeStamp | en: TimeStamp · tr: TimeStamp · ar: الطابع الزمني |
8 | Time | en: Time · tr: Time · ar: الوقت |
9 | BigInt | en: BigInt · tr: BigInt · ar: عدد كبير |
10 | Json | en: Json · tr: Json · ar: جيسون |
11 | Boolean | en: Boolean · tr: Boolean · ar: بوليياني |
dmsModelIdidisMandatoryitemNameparentDmsModelItemIdupdate-dms-model-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_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_36 | 400 | DMS_MODEL_ITEM_ALSO_FOUND | DMS Model item already found. |
path Parameters
iddmsModelItemIdupdate-dms-model-item › Request Body
cmisTypePermitted values — validated against the cmis_type parameter.
| Value | Meaning |
|---|---|
1 | Custom Type |
2 | Aspects |
3 | Properties |
4 | Seed Data |
Permitted values — validated against the cmis_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Custom Type | en: Custom Type · tr: Custom Type · ar: نوع مخصص |
2 | Aspects | en: Aspects · tr: Aspects · ar: جوانب |
3 | Properties | en: Properties · tr: Properties · ar: خصائص |
4 | Seed Data | no label seeded |
dataTypePermitted values — validated against the data_type parameter.
| Value | Meaning |
|---|---|
1 | Guid |
2 | Integer |
3 | String |
4 | Numeric |
5 | Money |
6 | Date |
7 | TimeStamp |
8 | Time |
9 | BigInt |
10 | Json |
11 | Boolean |
Permitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Guid | en: Guid · tr: Guid · ar: إرشاد |
2 | Integer | en: Integer · tr: Integer · ar: عدد صحيح |
3 | String | en: String · tr: String · ar: سلسلة |
4 | Numeric | en: Numeric · tr: Numeric · ar: رقمي |
5 | Money | en: Money · tr: Money · ar: مال |
6 | Date | en: Date · tr: Date · ar: تاريخ |
7 | TimeStamp | en: TimeStamp · tr: TimeStamp · ar: الطابع الزمني |
8 | Time | en: Time · tr: Time · ar: الوقت |
9 | BigInt | en: BigInt · tr: BigInt · ar: عدد كبير |
10 | Json | en: Json · tr: Json · ar: جيسون |
11 | Boolean | en: Boolean · tr: Boolean · ar: بوليياني |
isMandatoryparentDmsModelItemIdupdate-dms-model-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-dms-model-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_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_35 | 400 | IT_IS_DEFINED_AS_A_PARENT_ON_ANOTHER_MODEL_ITEM | This record cannot be deleted because it is defined as a parent on another model item. First delete child model item. |
path Parameters
iddmsModelItemIddelete-dms-model-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.
has-dms-model-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
iddmsModelItemIdhas-dms-model-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.
has-dms-model-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-dms-model-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.