Public Web API: Response model for creating document registration (Create document registration)

Methods

POST — Create document registration

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	Nomenclature document categorization.	Optional
item.createdAt	date-time	In case of document registration creation	Optional
item.createdBy	uuid	Who created the document registration	Optional
item.deletedAt	date-time	In case document registration is deleted, if absent - active	Optional
item.directoryId	uuid	Directory for document registration	Optional
item.docflow	string	Document flow (input,output,internal)	Optional
item.id	uuid	Identifier	Optional
item.name	string	Name	Optional
item.registrationSettings	object	RegistrationSettings Registration settings for document categorization.	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 numbering reset in a time period	Optional
item.registrationSettings.resetSettings	object	ResetSettings numbering reset settings.	Optional
item.registrationSettings.resetSettings.nextResetAt	date-time	Date of the nearest numbering reset	Optional
item.registrationSettings.resetSettings.resetPeriod	string	Reset period, available values: "year", "month", "week", "day"	Optional
item.registrationSettings.resetSettings.resetPeriodCount	int64	Number of periods, e.g., 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	In case of document registration change	Optional
item.updatedBy	uuid	Who changed the document registration	Optional
success	boolean	Successful request flag	Optional