Create document registration
Request
POST /pub/v1/registrator/nomenclature
Request body
The resource sent in the request body is Create document registration — Request. It contains the following writable properties:
{
"directoryId": "uuid",
"docflow": "string",
"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"
}
}
Properties
Name | Type | Description | Additional |
---|---|---|---|
directoryId | uuid |
Document registration directory |
|
docflow | string |
Document flow (input,output,internal) |
|
name | string |
Name |
|
registrationSettings | object | CreateNomenclatureRegistrationSettingsRq Registration settings for creating document categorization. | Optional |
registrationSettings.editAfterRegistration | boolean |
Enable changing the number after registration |
Optional |
registrationSettings.minLength | uint64 |
Minimum length of the number, leading zeros added |
Optional |
registrationSettings.reserveEnabled | boolean |
Enable number reservation |
Optional |
registrationSettings.resetInPeriod | boolean |
Enable numbering reset in a time period |
Optional |
registrationSettings.resetSettings | object | CreateNomenclatureResetSettingsRq Numeration reset settings for creating document categorization. | Optional |
registrationSettings.resetSettings.nextResetAt | date-time |
Date of the nearest numbering reset |
Optional |
registrationSettings.resetSettings.resetPeriod | string |
Reset period, available values: "year", "month", "week", "day" |
Optional |
registrationSettings.resetSettings.resetPeriodCount | int64 |
Number of periods, e.g., every 3 weeks (3 week) |
Optional |
registrationSettings.template | string |
Number template, put "{$__index}" by default |
Optional |
registrationSettings.templateEnabled | boolean |
Enable automatic mode |
Optional |
registrationSettings.through | boolean |
Enable continuous numbering |
Optional |
registrationSettings.throughSerialId | uuid |
Continuous numbering ID |
Optional |
Authorization
This request requires the use of one of following authorisation methods:
API key
Response
The following HTTP status codes may be returned:
Status code | Description | Resource |
---|---|---|
200 | OK Response model for creating document registration |
Response model for creating document registration (Create document registration) |
400 | Bad Request Invalid request parameters |