Response model for getting document registration (Get the document registration list)
Methods
- GET — Get the document registration list
Resource
{
"error": "string",
"result": [
{
"createdAt": "date-time",
"createdBy": "uuid",
"deletedAt": "date-time",
"directoryId": "uuid",
"docflow": "string",
"id": "uuid",
"name": "string",
"registrationSettings": {
"editAfterRegistration": "boolean",
"minLength": "uint64",
"reserveEnabled": "boolean",
"resetInPeriod": "boolean",
"resetSettings": {
"nextResetAt": "date-time",
"resetPeriod": "string",
"resetPeriodCount": "int64"
},
"template": "string",
"templateEnabled": "boolean",
"through": "boolean",
"throughSerialId": "uuid"
},
"serialId": "uuid",
"updatedAt": "date-time",
"updatedBy": "uuid"
}
],
"success": "boolean"
}
Properties
Name | Type | Description | Additional |
---|---|---|---|
error | string |
Error text if |
Optional |
result[] | array |
Context with data |
Optional |
result[].createdAt | date-time |
In case of document registration creation |
Optional |
result[].createdBy | uuid |
Who created the document registration |
Optional |
result[].deletedAt | date-time |
In case document registration is deleted, if absent - active |
Optional |
result[].directoryId | uuid |
Directory for document registration |
Optional |
result[].docflow | string |
Document flow (input,output,internal) |
Optional |
result[].id | uuid |
Identifier |
Optional |
result[].name | string |
Name |
Optional |
result[].registrationSettings | object | RegistrationSettings Registration settings for document categorization. | Optional |
result[].registrationSettings.editAfterRegistration | boolean |
Enable changing the number after registration |
Optional |
result[].registrationSettings.minLength | uint64 |
Minimum length of the number, leading zeros added |
Optional |
result[].registrationSettings.reserveEnabled | boolean |
Enable number reservation |
Optional |
result[].registrationSettings.resetInPeriod | boolean |
Enable numbering reset in a time period |
Optional |
result[].registrationSettings.resetSettings | object | ResetSettings numbering reset settings. | Optional |
result[].registrationSettings.resetSettings.nextResetAt | date-time |
Date of the nearest numbering reset |
Optional |
result[].registrationSettings.resetSettings.resetPeriod | string |
Reset period, available values: "year", "month", "week", "day" |
Optional |
result[].registrationSettings.resetSettings.resetPeriodCount | int64 |
Number of periods, e.g., every 3 weeks (3 week) |
Optional |
result[].registrationSettings.template | string |
Number template, put "{$__index}" by default |
Optional |
result[].registrationSettings.templateEnabled | boolean |
Enable automatic mode |
Optional |
result[].registrationSettings.through | boolean |
Enable continuous numbering |
Optional |
result[].registrationSettings.throughSerialId | uuid |
Continuous numbering ID |
Optional |
result[].serialId | uuid |
Counter ID |
Optional |
result[].updatedAt | date-time |
In case of document registration change |
Optional |
result[].updatedBy | uuid |
Who changed the document registration |
Optional |
success | boolean |
Successful request flag |
Optional |