Public Web API: Response model for changing folder (Modify folder)

Methods

PUT — Modify folder

Resource

{
    "error": "string",
    "item": {
        "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 `success == false`	Optional
item	object	Folder	Optional
item.createdAt	date-time	When the folder was created	Optional
item.createdBy	uuid	Folder created by	Optional
item.deletedAt	date-time	In case foldere is deleted, if absent - active	Optional
item.directoryId	uuid	Directory storing the folder	Optional
item.docflow	string	Folder documet flow (`input`, `output`, `internal`)	Optional
item.id	uuid	Identifier	Optional
item.name	string	Name	Optional
item.registrationSettings	object	Folder registration settings	Optional
item.registrationSettings.editAfterRegistration	boolean	Enable changing the number after registration	Optional
item.registrationSettings.minLength	uint64	Minimum length of the number, leading zeros added	Optional
item.registrationSettings.reserveEnabled	boolean	Enable number reservation	Optional
item.registrationSettings.resetInPeriod	boolean	Enable periodic reset of numbers	Optional
item.registrationSettings.resetSettings	object	Numbering reset settings	Optional
item.registrationSettings.resetSettings.nextResetAt	date-time	Date of the nearest numbering reset	Optional
item.registrationSettings.resetSettings.resetPeriod	string	Unit for numbering reset Possible values: `year`, `month`, `week`, `day`	Optional
item.registrationSettings.resetSettings.resetPeriodCount	int64	Number of units in the numbering reset period. For example, numbering can be reset every 3 weeks (`3 week`)	Optional
item.registrationSettings.template	string	Number template, put `{$__index}` by default	Optional
item.registrationSettings.templateEnabled	boolean	Enable automatic mode	Optional
item.registrationSettings.through	boolean	Enable continuous numbering	Optional
item.registrationSettings.throughSerialId	uuid	Continuous numbering ID	Optional
item.serialId	uuid	Counter ID	Optional
item.updatedAt	date-time	When the folder was changed	Optional
item.updatedBy	uuid	Folder changed by	Optional
success	boolean	Successful request flag	Optional