Public Web API: Specification summary

Managing apps

Operation	HTTP Request	Description
POST	/pub/v1/app/{namespace}/{code}/create	Create an app item
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

Managing business processes

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 for a target
POST	/pub/v1/bpm/instance/bytarget/list	Get a list of process instances for a target
POST	/pub/v1/bpm/instance/{id}/get	Get a process instance by ID
GET	/pub/v1/bpm/instance/{id}/get	Get a process instance by ID
POST	/pub/v1/bpm/template/{namespace}/{code}/run	Start process by template ID

Managing files

Operation	HTTP Request	Description
POST	/pub/v1/disk/file/upload	File upload
GET	/pub/v1/disk/file/{id}/get-link	Get file download link by file ID
POST	/pub/v1/disk/file/{id}/get-link	Get file download link by file 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

Managing users

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

Working with metadata

Operation	HTTP Request	Description
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/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/namespaces/{namespace}/groups/{code}	Get the metadata description of a group by code
GET	/pub/v1/scheme/namespaces/{namespace}	Get workspace metadata description by code

Work with modules

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