Public Web API: Specification summary

Operation	HTTP request	Description
POST	/pub/v1/app/{namespace}/{code}/create	App item is created
POST	/pub/v1/app/{namespace}/{code}/import	Data import from a file
POST	/pub/v1/app/{namespace}/{code}/{id}/update	Edit an app item
GET	/pub/v1/app/{namespace}/{code}/list	Get a list of app items
POST	/pub/v1/app/{namespace}/{code}/list	Get a list of app items
GET	/pub/v1/app/{namespace}/{code}/{id}/get	Get an app item by ID
POST	/pub/v1/app/{namespace}/{code}/{id}/get	Get an app item by ID
GET	/pub/v1/app/list	Get app list
GET	/pub/v1/app/{namespace}/{code}/settings/status	Get app status
POST	/pub/v1/app/{namespace}/{code}/import/status	Get import status
POST	/pub/v1/app/{namespace}/{code}/{id}/set-status	Set app item status

Operation	HTTP request	Description
GET	/pub/v1/bpm/instance/bytemplateid/{id}/list	Get a list of process instances
POST	/pub/v1/bpm/instance/bytemplateid/{id}/list	Get a list of process instances
GET	/pub/v1/bpm/instance/bytarget/list	Get a list of process instances by target
POST	/pub/v1/bpm/instance/bytarget/list	Get a list of process instances by target
GET	/pub/v1/bpm/instance/{id}/get	Get a process instance by ID
POST	/pub/v1/bpm/instance/{id}/get	Get a process instance by ID
POST	/pub/v1/bpm/template/{namespace}/{code}/run	Start process by workspace and code

Operation	HTTP request	Description
PATCH	/pub/v1/disk/files/deleted	Bulk file deletion
POST	/pub/v1/disk/files	Bulk file initialization
POST	/pub/v1/disk/uploads/from-link	Bulk file upload via links
POST	/pub/v1/disk/links/upload	Bulk receiving of file upload links
POST	/pub/v1/disk/links/download	Bulk retrieval of file download links
POST	/pub/v1/disk/directory	Directory is created
POST	/pub/v1/disk/directory/list	Get a list of directories
GET	/pub/v1/disk/directory/list	Get a list of directories
POST	/pub/v1/disk/file/{id}/get-link	Get file download link by file ID
GET	/pub/v1/disk/file/{id}/get-link	Get file download link by file ID
GET	/pub/v1/disk/directory/{id}	Get information about a directory by ID
POST	/pub/v1/disk/directory/{id}/upload	Load a file to a directory
POST	/pub/v1/disk/file/move	Moving a file to a directory
POST	/pub/v1/disk/file/upload	Upload a temporary file

Operation	HTTP request	Description
GET	/pub/v1/user/list	Get a list of users
POST	/pub/v1/user/list	Get a list of users

Operation	HTTP request	Description
POST	/pub/v1/scheme/groups/{id}/add-items	Adding org chart items to group
POST	/pub/v1/scheme/namespaces/{namespace}/groups	Create a group’s metadata description
DELETE	/pub/v1/scheme/groups/{id}	Delete a group
POST	/pub/v1/scheme/groups/{id}/remove-items	Deleting org chart items from group
PUT	/pub/v1/scheme/groups/{id}	Edit group data
GET	/pub/v1/scheme/groups/{id}	Get a group metadata description instance by ID
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/doctemplates	Get a list of an app’s document templates’ metadata descriptions
GET	/pub/v1/scheme/namespaces/{namespace}/doctemplates	Get a list of document templates’ metadata descriptions
GET	/pub/v1/scheme/groups/{id}/parent-groups	Get a list of groups the specified group is included in
GET	/pub/v1/scheme/groups/list	Get a list of metadata descriptions of filtered groups
POST	/pub/v1/scheme/groups/list	Get a list of metadata descriptions of filtered groups
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/groups	Get a list of metadata descriptions of groups and roles by app
GET	/pub/v1/scheme/modules	Get a list of modules’ metadata descriptions
GET	/pub/v1/scheme/namespaces/{namespace}/pages	Get a list of pages’ metadata descriptions
GET	/pub/v1/scheme/groups/{id}/positions	Get a list of positions included in a group
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/processes	Get a list of process templates’ metadata descriptions by app
GET	/pub/v1/scheme/solutions	Get a list of solutions’ metadata descriptions
GET	/pub/v1/scheme/groups/{id}/sub-groups	Get a list of sub-groups of a specified group
GET	/pub/v1/scheme/groups/{id}/users	Get a list of users included in a group
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}	Get app metadata description by code
GET	/pub/v1/scheme/namespaces/{namespace}/apps	Get list of app metadata descriptions
GET	/pub/v1/scheme/namespaces/{namespace}/processes	Get list of process tempalte metadata descriptions
GET	/pub/v1/scheme/namespaces	Get list of workspace metadata descriptions
GET	/pub/v1/scheme/modules/{id}	Get metadata descriptions of a module by ID
GET	/pub/v1/scheme/namespaces/{namespace}/processes/{code}	Get process template metadata description by code
GET	/pub/v1/scheme/namespaces/{namespace}/groups	Get the list of metadata descriptions of groups
GET	/pub/v1/scheme/doctemplates/{id}	Get the metadata description of a document template by ID
GET	/pub/v1/scheme/pages/{id}	Get the metadata description of a page by ID
GET	/pub/v1/scheme/solutions/{code}	Get the metadata description of a solution by code
GET	/pub/v1/scheme/namespaces/{namespace}	Get workspace metadata description by code
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/exportable	Whether the app can be exported using its code
GET	/pub/v1/scheme/modules/{id}/exportable	Whether the module can be exported using its ID
GET	/pub/v1/scheme/solutions/{code}/exportable	Whether the solution can be exported using its code
GET	/pub/v1/scheme/namespaces/{code}/exportable	Whether the workspace can be exported using its code

Operation	HTTP request	Description
GET	/pub/v1/integration/{code}/voip/bindings	Get the mappings of internal numbers and BRIX users set in the telephony module
PUT	/pub/v1/integration/{code}/voip/bindings	Update the mappings of internal numbers and BRIX users in the telephony module

Operation	HTTP request	Description
POST	/pub/v1/contracts/{namespace}/{code}/create	Create an item of the default app of a contract
POST	/pub/v1/contracts/{namespace}/{code}/{id}/update	Edit a contract item
GET	/pub/v1/contracts/{namespace}/{code}/{id}/get	Get a contract item by ID
GET	/pub/v1/contracts/{namespace}/{code}/list	Get a list of contract items
POST	/pub/v1/contracts/{namespace}/{code}/list	Get a list of contract items

Operation	HTTP request	Description
GET	/pub/v1/reports/{namespace}/{code}/list	Get a list of report items
POST	/pub/v1/reports/{namespace}/{code}/list	Get a list of report items

Operation	HTTP request	Description
PATCH	/pub/v1/marketing/segment/{id}/subscribers/add	Add subscribers to the static segment
PUT	/pub/v1/marketing/segment	Create a static segment of subscribers
PATCH	/pub/v1/marketing/segment/{id}/subscribers/remove	Delete subscribers from the static segment
POST	/pub/v1/marketing/segment/{id}/subscribers	Get a list of segment subscribers
POST	/pub/v1/marketing/segment	Get a list of segments
POST	/pub/v1/marketing/subscriber	Get a list of subscribers
GET	/pub/v1/marketing/segment/{id}	Get the segment by ID

Operation	HTTP request	Description
POST	/pub/v1/nomenclature/directory	Creating document categorization directory
POST	/pub/v1/nomenclature	Creating folder
GET	/pub/v1/nomenclature/directory	Getting list of document categorization directories
GET	/pub/v1/nomenclature	Getting list of folders
PUT	/pub/v1/nomenclature/directory/{id}	Modify document categorization directory
PUT	/pub/v1/nomenclature/{id}	Modify folder

Public Web API

Managing apps

Managing business processes

Managing files

Managing users

Working with metadata

Work with modules

Working with contracts

Working with reports

Work with marketing

Work with document registration