Public Web API: Creating folder

Request

POST /pub/v1/nomenclature

Request body

The resource sent in the request body is Creating folder — 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	Directory for folder
docflow	string	Folder documet flow (`input`, `output`, `internal`)
name	string	Name
registrationSettings	object	Registration settings for folder creation	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 periodic reset of numbers	Optional
registrationSettings.resetSettings	object	Numbering reset settings for folder creation	Optional
registrationSettings.resetSettings.nextResetAt	date-time	Date of the nearest numbering reset	Optional
registrationSettings.resetSettings.resetPeriod	string	Unit for numbering reset Possible values: `year`, `month`, `week`, `day`	Optional
registrationSettings.resetSettings.resetPeriodCount	int64	Number of units in the numbering reset period. For example, numbering can be reset 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 folder	Response model for creating folder (Creating folder)
400	Bad Request Invalid request parameters