Public Web API: Response model for getting folder (Getting list of folders)

Methods

GET — Getting list of folders

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 `success == false`	Optional
result[]	array	Context with data	Optional
result[].createdAt	date-time	When the folder was created	Optional
result[].createdBy	uuid	Folder created by	Optional
result[].deletedAt	date-time	In case foldere is deleted, if absent - active	Optional
result[].directoryId	uuid	Directory storing the folder	Optional
result[].docflow	string	Folder documet flow (`input`, `output`, `internal`)	Optional
result[].id	uuid	Identifier	Optional
result[].name	string	Name	Optional
result[].registrationSettings	object	Folder registration settings	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 periodic reset of numbers	Optional
result[].registrationSettings.resetSettings	object	Numbering reset settings	Optional
result[].registrationSettings.resetSettings.nextResetAt	date-time	Date of the nearest numbering reset	Optional
result[].registrationSettings.resetSettings.resetPeriod	string	Unit for numbering reset Possible values: `year`, `month`, `week`, `day`	Optional
result[].registrationSettings.resetSettings.resetPeriodCount	int64	Number of units in the numbering reset period. For example, numbering can be reset 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	When the folder was changed	Optional
result[].updatedBy	uuid	Folder changed by	Optional
success	boolean	Successful request flag	Optional