Registry regulations admin-portal

Table of Contents

1. Introduction
Registry regulations admin-portal Rest API

1. Introduction

This document describes REST API of 'Registry regulations admin-portal'

Registry regulations admin-portal Rest API

1. Description

API includes managing operations over registry regulations entities:

Forms
Business processes
Data model
Global settings

1.1. RestAPI structure

registry-regulation-management RestAPI structure

1.2. Optimistic locking

Optimistic locking is done using RFC-2616

Statements:

ETag header contains a hash sum of entity content
If-Match header instruction should be used for checking the state of the resource
If the request header does not contain ETag, then client will overwrite existing resources in any case

Client is not restricted to not use ETag’s. In this case optimistic locking mechanism won’t be used and owerwrites could happens for a resources. More details could be found here.

1.3. Version control management usecase

2. Endpoints

2.1. RegistryRegulationsMasterBusinessProcessesManagementRestAPI

2.1.1. GET /versions/master/business-processes/{businessProcessName}

Operation Id: getBusinessProcess

Description

Get business process

Parameters

Table 1. Path Parameters
Name	Description	Required	Default	Pattern
businessProcessName	Process name	X	null

Table 2. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

[String]

Content Type

text/xml
application/json

Responses

Table 3. http response codes
Code	Message	Datatype
200	OK	[String]
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

2.1.2. GET /versions/master/business-processes

Operation Id: getBusinessProcessesFromMaster

Description

Get business processes list for master version

Parameters

Table 4. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

array[BusinessProcessDetailsShort]

Content Type

application/json

Responses

Table 5. http response codes
Code	Message	Datatype
200	OK	List[BusinessProcessDetailsShort]
401	Unauthorized	<<>>
403	Forbidden	<<>>
500	Internal server error	DetailedErrorResponse

Samples

2.2. RegistryRegulationsMasterVersionFormsManagementRestAPI

2.2.1. GET /versions/master/forms/{formName}

Operation Id: getForm

Description

Get specific form full details

Parameters

Table 6. Path Parameters
Name	Description	Required	Default	Pattern
formName	Form name	X	null

Table 7. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

[String]

Content Type

application/json

Responses

Table 8. http response codes
Code	Message	Datatype
200	OK	[String]
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/master/forms/John%20Doe's%20form HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 65

{"name":"John Doe's form","title":"John Doe added new component"}

2.2.2. GET /versions/master/forms

Operation Id: getFormsFromMaster

Description

Get lest of forms for master version

Parameters

Table 9. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

array[FormDetailsShort]

Content Type

application/json

Responses

Table 10. http response codes
Code	Message	Datatype
200	OK	List[FormDetailsShort]
401	Unauthorized	<<>>
403	Forbidden	<<>>
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/master/forms HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 141

[{"name":"John Doe's form","title":"John Doe added new component","created":"2022-07-29T15:06:00.000Z","updated":"2022-07-29T15:07:00.000Z"}]

2.3. RegistryRegulationsMasterVersionManagementRestAPI

2.3.1. GET /versions/master

Operation Id: getMasterVersionInfo

Description

Acquire master version full details

Parameters

Table 11. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

MasterVersionInfoDetailed

Content Type

application/json

Responses

Table 12. http response codes
Code	Message	Datatype
200	OK	MasterVersionInfoDetailed
401	Unauthorized	<<>>
403	Forbidden	<<>>
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/master HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 219

{"id":"1","name":"JohnDoe's version candidate","description":"Version candidate to change form","author":"test_user@domain.com","latestUpdate":"2022-07-29T12:31:00.000Z","published":null,"inspector":null,"validations":null}

2.4. RegistryRegulationsMasterVersionSettingsRestAPI

2.4.1. GET /versions/master/settings

Operation Id: getSettings

Description

Get existing settings for master version

Parameters

Table 13. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

GlobalSettingsInfo

Content Type

application/json

Responses

Table 14. http response codes
Code	Message	Datatype
200	OK	GlobalSettingsInfo
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/master/settings HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 131

{"titleFull":"<Назва реєстру>","title":"mdtuddm","themeFile":"white-theme.js","supportEmail":"support@registry.gov.ua"}

2.5. RegistryRegulationsMasterVersionTablesManagementRestAPI

2.5.1. GET /versions/master/tables/{tableName}

Operation Id: getTable

Description

Get specific table full details

Parameters

Table 15. Path Parameters
Name	Description	Required	Default	Pattern
tableName	Table name	X	null

Table 16. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

DdmTable

Content Type

application/json

Responses

Table 17. http response codes
Code	Message	Datatype
200	OK	DdmTable
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/master/tables/John_Does_table HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 188

{"name":"John_Does_table","historyFlag":false,"objectReference":true,"description":"John Doe get table","columns":{},"foreignKeys":{},"primaryKey":null,"uniqueConstraints":{},"indices":{}}

2.5.2. GET /versions/master/tables

Operation Id: getTables

Description

Get tables list from master version

Parameters

Table 18. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

array[TableDetailsShort]

Content Type

application/json

Responses

Table 19. http response codes
Code	Message	Datatype
200	OK	List[TableDetailsShort]
401	Unauthorized	<<>>
403	Forbidden	<<>>
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/master/tables HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 107

[{"name":"John Doe's table","description":"John Doe get table","objectReference":true,"historyFlag":false}]

2.6. RegistryRegulationsVersionCandidateBusinessProcessesManagementRestAPI

2.6.1. POST /versions/candidates/{versionCandidateId}/business-processes/{businessProcessName}

Operation Id: createBusinessProcess

Description

Create new business process

Parameters

Table 20. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
businessProcessName	Name of the new process to be created	X	null

Table 21. Body Parameter
Name	Description	Required	Default	Pattern
body	[string]	X

Table 22. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

text/xml
application/json

Responses

Table 23. http response codes
Code	Message	Datatype
201	Created	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
409	Conflict	DetailedErrorResponse
422	Unprocessable Entity	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

POST /versions/candidates/id1/business-processes/John_Does_process HTTP/1.1
Content-Type: text/xml
Accept: text/xml
Content-Length: 983
Host: localhost:8080

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_1poh5q3" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.1.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.0.0">
  <bpmn:process id="John_Does_process" name="John Doe added new component" isExecutable="true">
    <bpmn:startEvent id="StartEvent_1" />
  </bpmn:process>
  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="John_Does_process">
      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
        <dc:Bounds x="179" y="79" width="36" height="36" />
      </bpmndi:BPMNShape>
    </bpmndi:BPMNPlane>
  </bpmndi:BPMNDiagram>
</bpmn:definitions>

HTTP/1.1 201 Created
Location: /versions/candidates/id1/business-processes/John_Does_process
Content-Type: text/xml
Content-Length: 983

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_1poh5q3" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.1.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.0.0">
  <bpmn:process id="John_Does_process" name="John Doe added new component" isExecutable="true">
    <bpmn:startEvent id="StartEvent_1" />
  </bpmn:process>
  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="John_Does_process">
      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
        <dc:Bounds x="179" y="79" width="36" height="36" />
      </bpmndi:BPMNShape>
    </bpmndi:BPMNPlane>
  </bpmndi:BPMNDiagram>
</bpmn:definitions>

2.6.2. DELETE /versions/candidates/{versionCandidateId}/business-processes/{businessProcessName}

Operation Id: deleteBusinessProcess

Description

Delete business process

Parameters

Table 24. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
businessProcessName	Process name	X	null

Table 25. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 26. http response codes
Code	Message	Datatype
204	No Content	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

DELETE /versions/candidates/id1/business-processes/John_Does_process HTTP/1.1
Host: localhost:8080

HTTP/1.1 204 No Content

2.6.3. GET /versions/candidates/{versionCandidateId}/business-processes/{businessProcessName}

Operation Id: getBusinessProcess1

Description

Get business process

Parameters

Table 27. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
businessProcessName	Process name	X	null

Table 28. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

text/xml
application/json

Responses

Table 29. http response codes
Code	Message	Datatype
200	OK	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/id1/business-processes/John_Does_process HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 983

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_1poh5q3" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.1.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.0.0">
  <bpmn:process id="John_Does_process" name="John Doe added new component" isExecutable="true">
    <bpmn:startEvent id="StartEvent_1" />
  </bpmn:process>
  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="John_Does_process">
      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
        <dc:Bounds x="179" y="79" width="36" height="36" />
      </bpmndi:BPMNShape>
    </bpmndi:BPMNPlane>
  </bpmndi:BPMNDiagram>
</bpmn:definitions>

2.6.4. GET /versions/candidates/{versionCandidateId}/business-processes

Operation Id: getBusinessProcessesBuVersionId

Description

Get business processes list

Parameters

Table 30. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null

Table 31. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

array[BusinessProcessDetailsShort]

Content Type

application/json

Responses

Table 32. http response codes
Code	Message	Datatype
200	OK	List[BusinessProcessDetailsShort]
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/id1/business-processes HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 143

[{"name":"John_Does_process","title":"John Doe added new component","created":"2022-10-31T17:03:08.537Z","updated":"2022-10-31T17:03:08.539Z"}]

2.6.5. PUT /versions/candidates/{versionCandidateId}/business-processes/{businessProcessName}

Operation Id: updateBusinessProcess

Description

Update business process

Parameters

Table 33. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
businessProcessName	Process name	X	null

Table 34. Body Parameter
Name	Description	Required	Default	Pattern
body	[string]	X

Table 35. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

text/xml
application/json

Responses

Table 36. http response codes
Code	Message	Datatype
200	OK	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
422	Unprocessable Entity	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

PUT /versions/candidates/id1/business-processes/John_Does_process HTTP/1.1
Content-Type: text/xml
Accept: text/xml
Content-Length: 983
Host: localhost:8080

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_1poh5q3" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.1.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.0.0">
  <bpmn:process id="John_Does_process" name="John Doe added new component" isExecutable="true">
    <bpmn:startEvent id="StartEvent_1" />
  </bpmn:process>
  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="John_Does_process">
      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
        <dc:Bounds x="179" y="79" width="36" height="36" />
      </bpmndi:BPMNShape>
    </bpmndi:BPMNPlane>
  </bpmndi:BPMNDiagram>
</bpmn:definitions>

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 983

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:modeler="http://camunda.org/schema/modeler/1.0" id="Definitions_1poh5q3" targetNamespace="http://bpmn.io/schema/bpmn" exporter="Camunda Modeler" exporterVersion="5.1.0" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="8.0.0">
  <bpmn:process id="John_Does_process" name="John Doe added new component" isExecutable="true">
    <bpmn:startEvent id="StartEvent_1" />
  </bpmn:process>
  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="John_Does_process">
      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
        <dc:Bounds x="179" y="79" width="36" height="36" />
      </bpmndi:BPMNShape>
    </bpmndi:BPMNPlane>
  </bpmndi:BPMNDiagram>
</bpmn:definitions>

2.7. RegistryRegulationsVersionCandidateFormsManagementRestAPI

2.7.1. DELETE /versions/candidates/{versionCandidateId}/forms/{formName}

Operation Id: deleteForm

Description

Delete existing form within version-candidate

Parameters

Table 37. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
formName	Name of the form to be deleted	X	null

Table 38. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 39. http response codes
Code	Message	Datatype
204	No Content	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

DELETE /versions/candidates/1/forms/formName HTTP/1.1
Host: localhost:8080

HTTP/1.1 204 No Content

2.7.2. POST /versions/candidates/{versionCandidateId}/forms/{formName}

Operation Id: formCreate

Description

Create new form within specific version-candidate

Parameters

Table 40. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
formName	Name of the new form to be created	X	null

Table 41. Body Parameter
Name	Description	Required	Default	Pattern
body	[string]	X

Table 42. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 43. http response codes
Code	Message	Datatype
201	Created	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
409	Conflict	DetailedErrorResponse
422	Unprocessable Entity	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

POST /versions/candidates/1/forms/formName HTTP/1.1
Content-Type: application/json
Content-Length: 65
Host: localhost:8080

{"name":"John Doe's form","title":"John Doe added new component"}

HTTP/1.1 201 Created
Location: /versions/candidates/1/forms/formName
Content-Type: application/json
Content-Length: 65

{"name":"John Doe's form","title":"John Doe added new component"}

2.7.3. GET /versions/candidates/{versionCandidateId}/forms/{formName}

Operation Id: getForm1

Description

Get full details of the specific form within version-candidate

Parameters

Table 44. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
formName	Form name	X	null

Table 45. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 46. http response codes
Code	Message	Datatype
200	OK	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/1/forms/formName HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 65

{"name":"John Doe's form","title":"John Doe added new component"}

2.7.4. GET /versions/candidates/{versionCandidateId}/forms

Operation Id: getFormsByVersionId

Description

Acquire list of forms for specific version-candidate

Parameters

Table 47. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null

Table 48. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

array[FormDetailsShort]

Content Type

application/json

Responses

Table 49. http response codes
Code	Message	Datatype
200	OK	List[FormDetailsShort]
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/1/forms HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 141

[{"name":"John Doe's form","title":"John Doe added new component","created":"2022-07-29T18:55:00.000Z","updated":"2022-07-29T18:56:00.000Z"}]

2.7.5. PUT /versions/candidates/{versionCandidateId}/forms/{formName}

Operation Id: updateForm

Description

Update existing form within version-candidate

Parameters

Table 50. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null
formName	Name of the form to be updated	X	null

Table 51. Body Parameter
Name	Description	Required	Default	Pattern
body	[string]	X

Table 52. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 53. http response codes
Code	Message	Datatype
200	OK	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
422	Unprocessable Entity	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

PUT /versions/candidates/1/forms/formName HTTP/1.1
Content-Type: application/json
Content-Length: 65
Host: localhost:8080

{"name":"John Doe's form","title":"John Doe added new component"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 65

{"name":"John Doe's form","title":"John Doe added new component"}

2.8. RegistryRegulationsVersionCandidateManagementRestAPI

2.8.1. POST /versions/candidates

Operation Id: createNewVersion

Description

Create new version-candidate from current state of master version.

Parameters

Table 54. Body Parameter
Name	Description	Required	Default	Pattern
CreateVersionRequest	CreateVersionRequest	X

Table 55. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

VersionInfoDetailed

Content Type

application/json

Responses

Table 56. http response codes
Code	Message	Datatype
201	OK	VersionInfoDetailed
401	Unauthorized	<<>>
403	Forbidden	<<>>
422	Unprocessable Entity	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

POST /versions/candidates HTTP/1.1
Content-Type: application/json
Content-Length: 87
Host: localhost:8080

{"name":"JohnDoe's version candidate","description":"Version candidate to change form"}

HTTP/1.1 201 Created
Location: /versions/candidates/1
Content-Type: application/json
Content-Length: 267

{"id":"1","name":"JohnDoe's version candidate","description":"Version candidate to change form","author":"test_user@domain.com","creationDate":"2022-08-10T11:30:00.000Z","latestUpdate":"2022-08-10T11:40:00.000Z","hasConflicts":false,"inspections":null,"validations":null}

2.8.2. POST /versions/candidates/{versionCandidateId}/decline

Operation Id: declineVersionCandidate

Description

Abandon the existing opened version-candidate. After this operation the version-candidate won’t take any changes anymore.

Parameters

Table 57. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier to abandon	X	null

Table 58. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 59. http response codes
Code	Message	Datatype
204	No Content	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

POST /versions/candidates/1/decline HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK

2.8.3. GET /versions/candidates/{versionCandidateId}/changes

Operation Id: getVersionChanges

Description

Get version changes by id

Parameters

Table 60. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null

Table 61. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

VersionChanges

Content Type

application/json

Responses

Table 62. http response codes
Code	Message	Datatype
200	OK	VersionChanges
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/1/changes HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 183

{"changedForms":[{"name":"formToBeUpdated","title":"JohnDoe's form","status":"CHANGED"}],"changedBusinessProcesses":[{"name":"newProcess","title":"JohnDoe's process","status":"NEW"}]}

2.8.4. GET /versions/candidates/{versionCandidateId}

Operation Id: getVersionDetails

Description

Acquire version-candidate full details

Parameters

Table 63. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version-candidate identifier	X	null

Table 64. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

VersionInfoDetailed

Content Type

application/json

Responses

Table 65. http response codes
Code	Message	Datatype
200	OK	VersionInfoDetailed
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/1 HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 267

{"id":"1","name":"JohnDoe's version candidate","description":"Version candidate to change form","author":"test_user@domain.com","creationDate":"2022-08-10T11:30:00.000Z","latestUpdate":"2022-08-10T11:40:00.000Z","hasConflicts":false,"inspections":null,"validations":null}

2.8.5. GET /versions/candidates

Operation Id: getVersionsList

Description

Get list of existing opened version-candidates

Parameters

Table 66. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

array[VersionInfo]

Content Type

application/json

Responses

Table 67. http response codes
Code	Message	Datatype
200	OK	List[VersionInfo]
401	Unauthorized	<<>>
403	Forbidden	<<>>
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 98

[{"id":"1","name":"JohnDoe's version candidate","description":"Version candidate to change form"}]

2.8.6. GET /versions/candidates/{versionCandidateId}/rebase

Operation Id: rebase

Description

Rebase changes from master version

Parameters

Table 68. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null

Table 69. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 70. http response codes
Code	Message	Datatype
200	OK	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/1/rebase HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK

2.8.7. POST /versions/candidates/{versionCandidateId}/submit

Operation Id: submitVersionCandidate

Description

Integrate version-candidate changes into master version of registry regulation

Version candidate submit

Each version-candidate should be inspected before submission.

Currently, the inspection process is happening on the Gerrit side. The corresponding Merge Request should be reviewed and marked as ready for merge.

Parameters

Table 71. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier to be merged into master version	X	null

Table 72. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 73. http response codes
Code	Message	Datatype
204	No Content	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
409	Conflict	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

POST /versions/candidates/1/submit HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK

2.9. RegistryRegulationsVersionCandidatesSettingsRestAPI

2.9.1. GET /versions/candidates/{versionCandidateId}/settings

Operation Id: getSettings1

Description

Get existing settings for version-candidate

Parameters

Table 74. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null

Table 75. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

GlobalSettingsInfo

Content Type

application/json

Responses

Table 76. http response codes
Code	Message	Datatype
200	OK	GlobalSettingsInfo
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

GET /versions/candidates/1/settings HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 131

{"titleFull":"<Назва реєстру>","title":"mdtuddm","themeFile":"white-theme.js","supportEmail":"support@registry.gov.ua"}

2.9.2. PUT /versions/candidates/{versionCandidateId}/settings

Operation Id: updateSettings

Description

Update existing settings for version-candidate

Parameters

Table 77. Path Parameters
Name	Description	Required	Default	Pattern
versionCandidateId	Version candidate identifier	X	null

Table 78. Body Parameter
Name	Description	Required	Default	Pattern
GlobalSettingsInfo	GlobalSettingsInfo	X

Table 79. Header Parameters
Name	Description	Required	Default	Pattern
X-Access-Token	Token used for endpoint security	X	null

Return Type

Content Type

application/json

Responses

Table 80. http response codes
Code	Message	Datatype
200	OK	<<>>
401	Unauthorized	<<>>
403	Forbidden	<<>>
404	Not Found	DetailedErrorResponse
422	Unprocessable Entity	DetailedErrorResponse
500	Internal server error	DetailedErrorResponse

Samples

PUT /versions/candidates/1/settings HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 141
Host: localhost:8080

{"titleFull":"\u003cНазва реєстру\u003e","title":"mdtuddm","themeFile":"white-theme.js","supportEmail":"support@registry.gov.ua"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 131

{"titleFull":"<Назва реєстру>","title":"mdtuddm","themeFile":"white-theme.js","supportEmail":"support@registry.gov.ua"}

2.10. UsersBulkUploadRestAPI

2.10.1. DELETE /batch-loads/users/{id}

Operation Id: deleteFile

Description

Delete file endpoint

Parameters

Table 81. Path Parameters
Name	Description	Required	Default	Pattern
id	Resource identifier	X	null

Return Type

CephFileInfoDto

Content Type

Responses

Table 82. http response codes
Code	Message	Datatype
200	OK	CephFileInfoDto

Samples

DELETE /batch-loads/users/10e23e2a-6830-42a6-bf21-d0a4a90b5706 HTTP/1.1
x-access-token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ2bnlHdVFRSTJWWkFKbHluQU40SzYtbnl4S2I2MzA2N0cyaFg0cUl5S244In0.eyJleHAiOjE2NjE5NDA3NDksImlhdCI6MTY2MTk0MDQ0OSwianRpIjoiNTg4M2I0MWUtZmIxMS00ZDhkLWE3OGMtZmJiMTg2NTBmZDllIiwiaXNzIjoiaHR0cHM6Ly9wbGF0Zm9ybS1rZXljbG9hay5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tL2F1dGgvcmVhbG1zL21kdHUtZGRtLWVkcC1jaWNkLWRhdGEtZGV2LWRldi1hZG1pbiIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiIwYTg5NGUxNy1iOGI3LTRkZTEtYmFjOS0xOWVmOGYzZjc3M2YiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJhZG1pbi1wb3J0YWwiLCJzZXNzaW9uX3N0YXRlIjoiYTc5ZTg4ZTctMTk0My00OTlhLWE1NjUtMGI5MjE1ZWNmNGUyIiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyJodHRwczovL2FkbWluLXBvcnRhbC1kYXRhLWRldi1kZXYuYXBwcy5jaWNkMi5tZHR1LWRkbS5wcm9qZWN0cy5lcGFtLmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiZGVmYXVsdC1yb2xlcy1tZHR1LWRkbS1lZHAtY2ljZC1kYXRhLWRldi1kZXYtYWRtaW4iLCJ1c2VyLW1hbmFnZW1lbnQiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJwcm9maWxlIGVtYWlsIiwic2lkIjoiYTc5ZTg4ZTctMTk0My00OTlhLWE1NjUtMGI5MjE1ZWNmNGUyIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0In0.UcHZDYKHY7Pdyd9hjFWVRuReWo907wZVYSQxq8dzFksUX-6S4FmjTz7ihx-kZiN9ekZK2Zhk4fRcNL3LiKPKxPnQlRYHxkVh502iisBvThihdVHM_bVddgzauabV-nwJsmk8pKqt80PlUvyYgOxf78ccDCxsLpshY1_10FMTY8zsWwBVVIzAf1-r3L4kw7PJ2D1uoV0OWrLduEfd_tallQE7nrB50uTyZ2XD9pEKS9YQ22LGdMeMi71282wuezV_OaIdHN2u3jh039xpoE2GBJoz71AnoJ-VIMHjA36nu3AZDqVPfkcc1hABMqLDbEFLp6hO8Sl253JAlCSftHSwQQ
Host: localhost:8080

HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

2.10.2. GET /batch-loads/users

Operation Id: getFileInfo

Description

Get file information

Parameters

Table 83. Query Parameters
Name	Description	Required	Default	Pattern
securityContext		X	null

Return Type

CephFileInfoDto

Content Type

Responses

Table 84. http response codes
Code	Message	Datatype
200	OK	CephFileInfoDto

Samples

GET /batch-loads/users HTTP/1.1
x-access-token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJYRldmanZPMXpzRF9rUlNMNGRhcXV6Rnl1Y2xMQWdzV1Z3ZjlydXZUak5vIn0.eyJleHAiOjE2NTU4ODg1NzUsImlhdCI6MTY1NTg4ODI3NSwianRpIjoiMTRkNWE1YmEtNjliZS00MmNiLTgxMDEtMzg5ODVlNTNlYzczIiwiaXNzIjoiaHR0cHM6Ly9wbGF0Zm9ybS1rZXljbG9hay5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tL2F1dGgvcmVhbG1zL21kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQ5YWNkZTg2LThhYjktNDNmNC1hNzRiLWE5YzliZjhlZWU1MyIsInR5cCI6IkJlYXJlciIsImF6cCI6Im9mZmljZXItcG9ydGFsIiwic2Vzc2lvbl9zdGF0ZSI6IjEyM2Q3ODY1LTgxYWItNDEzOS04MGQzLWE3ZjQ2OWY0Yjc5OSIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9vZmZpY2VyLXBvcnRhbC1kYXRhLXBhcmFkaXNlLWRldi5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLW1kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsInNpZCI6IjEyM2Q3ODY1LTgxYWItNDEzOS04MGQzLWE3ZjQ2OWY0Yjc5OSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZWRycG91IjoiMTExMTExMTEiLCJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLW1kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdLCJkcmZvIjoiMDEwMTAxMDEwMSIsImZ1bGxOYW1lIjoi0J_QtdGC0YDQvtCyINCf0LXRgtGAINCf0LXRgtGA0L7QstGW0YciLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0In0.llKDTm9tb23454MGdJZhY9WpiKR_7HqlfDYHRVPzqTp9gTVuu_mBi9novvRwHPceyK8iX2Pcha40W_py61qE2T8o63aoDDJs_X5K-rfiz7PQ9YQQTokQiKWakRWtYqbKODnCuKt5U15anNNpklvn0w1OYWBkgnoxPA8fdsxdk4TNiNKLZ14V9OwkkykcWKHkY5GcL2n4WzPSwtMd69IDAOkPmH9oPxz0n_V7YTtMGA3OxcLiyX4IsZcknVlWm6xVe63SNFhLoXAXMtqwvLwshRl7s4Jp-RVFHJFf2pjULcuzrILNKwWkAWlsFGMUx7-WVAGFwToaGAsgbyspEAHUJQ
Host: localhost:8080

HTTP/1.1 403 Forbidden
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 92

{"error":{"traceId":null,"code":"403","message":"Access is denied","localizedMessage":null}}

2.10.3. POST /batch-loads/users

Operation Id: handleFileUpload

Description

Store file endpoint

Parameters

Table 85. Body Parameter
Name	Description	Required	Default	Pattern
HandleFileUploadRequest	HandleFileUploadRequest	-

Table 86. Query Parameters
Name	Description	Required	Default	Pattern
securityContext		-	null

Return Type

CephFileInfoDto

Content Type

Responses

Table 87. http response codes
Code	Message	Datatype
200	OK	CephFileInfoDto

Samples

POST /batch-loads/users HTTP/1.1
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
x-access-token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJYRldmanZPMXpzRF9rUlNMNGRhcXV6Rnl1Y2xMQWdzV1Z3ZjlydXZUak5vIn0.eyJleHAiOjE2NTU4ODg1NzUsImlhdCI6MTY1NTg4ODI3NSwianRpIjoiMTRkNWE1YmEtNjliZS00MmNiLTgxMDEtMzg5ODVlNTNlYzczIiwiaXNzIjoiaHR0cHM6Ly9wbGF0Zm9ybS1rZXljbG9hay5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tL2F1dGgvcmVhbG1zL21kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQ5YWNkZTg2LThhYjktNDNmNC1hNzRiLWE5YzliZjhlZWU1MyIsInR5cCI6IkJlYXJlciIsImF6cCI6Im9mZmljZXItcG9ydGFsIiwic2Vzc2lvbl9zdGF0ZSI6IjEyM2Q3ODY1LTgxYWItNDEzOS04MGQzLWE3ZjQ2OWY0Yjc5OSIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9vZmZpY2VyLXBvcnRhbC1kYXRhLXBhcmFkaXNlLWRldi5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLW1kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsInNpZCI6IjEyM2Q3ODY1LTgxYWItNDEzOS04MGQzLWE3ZjQ2OWY0Yjc5OSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZWRycG91IjoiMTExMTExMTEiLCJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLW1kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdLCJkcmZvIjoiMDEwMTAxMDEwMSIsImZ1bGxOYW1lIjoi0J_QtdGC0YDQvtCyINCf0LXRgtGAINCf0LXRgtGA0L7QstGW0YciLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0In0.llKDTm9tb23454MGdJZhY9WpiKR_7HqlfDYHRVPzqTp9gTVuu_mBi9novvRwHPceyK8iX2Pcha40W_py61qE2T8o63aoDDJs_X5K-rfiz7PQ9YQQTokQiKWakRWtYqbKODnCuKt5U15anNNpklvn0w1OYWBkgnoxPA8fdsxdk4TNiNKLZ14V9OwkkykcWKHkY5GcL2n4WzPSwtMd69IDAOkPmH9oPxz0n_V7YTtMGA3OxcLiyX4IsZcknVlWm6xVe63SNFhLoXAXMtqwvLwshRl7s4Jp-RVFHJFf2pjULcuzrILNKwWkAWlsFGMUx7-WVAGFwToaGAsgbyspEAHUJQ
Host: localhost:8080

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=users.csv
Content-Type: multipart/form-data

test
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

HTTP/1.1 403 Forbidden
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 92

{"error":{"traceId":null,"code":"403","message":"Access is denied","localizedMessage":null}}

2.10.4. POST /batch-loads/users/imports

Operation Id: imports

Description

Start import endpoint

Parameters

Table 88. Body Parameter
Name	Description	Required	Default	Pattern
SecurityContext	SecurityContext	-

Return Type

Content Type

Responses

Table 89. http response codes
Code	Message	Datatype
200	OK	<<>>

Samples

POST /batch-loads/users/imports HTTP/1.1
x-access-token: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJYRldmanZPMXpzRF9rUlNMNGRhcXV6Rnl1Y2xMQWdzV1Z3ZjlydXZUak5vIn0.eyJleHAiOjE2NTU4ODg1NzUsImlhdCI6MTY1NTg4ODI3NSwianRpIjoiMTRkNWE1YmEtNjliZS00MmNiLTgxMDEtMzg5ODVlNTNlYzczIiwiaXNzIjoiaHR0cHM6Ly9wbGF0Zm9ybS1rZXljbG9hay5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tL2F1dGgvcmVhbG1zL21kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjQ5YWNkZTg2LThhYjktNDNmNC1hNzRiLWE5YzliZjhlZWU1MyIsInR5cCI6IkJlYXJlciIsImF6cCI6Im9mZmljZXItcG9ydGFsIiwic2Vzc2lvbl9zdGF0ZSI6IjEyM2Q3ODY1LTgxYWItNDEzOS04MGQzLWE3ZjQ2OWY0Yjc5OSIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9vZmZpY2VyLXBvcnRhbC1kYXRhLXBhcmFkaXNlLWRldi5hcHBzLmNpY2QyLm1kdHUtZGRtLnByb2plY3RzLmVwYW0uY29tIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLW1kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiZW1haWwgcHJvZmlsZSIsInNpZCI6IjEyM2Q3ODY1LTgxYWItNDEzOS04MGQzLWE3ZjQ2OWY0Yjc5OSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZWRycG91IjoiMTExMTExMTEiLCJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLW1kdHUtZGRtLWVkcC1jaWNkLWRhdGEtcGFyYWRpc2UtZGV2LW9mZmljZXItcG9ydGFsIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdLCJkcmZvIjoiMDEwMTAxMDEwMSIsImZ1bGxOYW1lIjoi0J_QtdGC0YDQvtCyINCf0LXRgtGAINCf0LXRgtGA0L7QstGW0YciLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0In0.llKDTm9tb23454MGdJZhY9WpiKR_7HqlfDYHRVPzqTp9gTVuu_mBi9novvRwHPceyK8iX2Pcha40W_py61qE2T8o63aoDDJs_X5K-rfiz7PQ9YQQTokQiKWakRWtYqbKODnCuKt5U15anNNpklvn0w1OYWBkgnoxPA8fdsxdk4TNiNKLZ14V9OwkkykcWKHkY5GcL2n4WzPSwtMd69IDAOkPmH9oPxz0n_V7YTtMGA3OxcLiyX4IsZcknVlWm6xVe63SNFhLoXAXMtqwvLwshRl7s4Jp-RVFHJFf2pjULcuzrILNKwWkAWlsFGMUx7-WVAGFwToaGAsgbyspEAHUJQ
Host: localhost:8080

HTTP/1.1 403 Forbidden
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 92

{"error":{"traceId":null,"code":"403","message":"Access is denied","localizedMessage":null}}

3. Models

3.1. BusinessProcessChangesInfo

Field Name

Required

Type

Description

Format

name

String

title

String

status

String

Enum: NEW, CHANGED, DELETED,

3.2. BusinessProcessDetailsShort

Field Name

Required

Type

Description

Format

name

String

title

String

created

Date

date-time

updated

Date

date-time

3.3. CephFileInfoDto

Field Name

Required

Type

Description

Format

String

name

String

size

Long

int64

3.4. Column

Field Name

Required

Type

Description

Format

name

String

sorting

String

Enum: ASC, DESC, NONE,

3.5. ColumnPair

Field Name

Required

Type

Description

Format

sourceColumnName

String

targetColumnName

String

3.6. CreateVersionRequest

Field Name

Required

Type

Description

Format

name

String

Name from request

description

String

Description from request

3.7. DdmColumn

Field Name

Required

Type

Description

Format

name

String

description

String

type

String

defaultValue

String

notNullFlag

Boolean

tableName

String

3.8. DdmForeignKey

Field Name

Required

Type

Description

Format

name

String

targetTable

String

columnPairs

List of ColumnPair

sourceTable

String

3.9. DdmIndex

Field Name

Required

Type

Description

Format

name

String

columns

List of Column

tableName

String

3.10. DdmPrimaryKeyConstraint

Field Name

Required

Type

Description

Format

name

String

columns

List of Column

tableName

String

3.11. DdmTable

Field Name

Required

Type

Description

Format

name

String

historyFlag

Boolean

objectReference

Boolean

description

String

columns

Map of DdmColumn

foreignKeys

Map of DdmForeignKey

primaryKey

DdmPrimaryKeyConstraint

uniqueConstraints

Map of DdmUniqueConstraint

indices

Map of DdmIndex

3.12. DdmUniqueConstraint

Field Name

Required

Type

Description

Format

name

String

columns

List of Column

tableName

String

3.13. DetailedErrorResponse

Field Name

Required

Type

Description

Format

traceId

String

Request identifier

code

String

Error code

details

String

Error details

localizedMessage

String

Localized error message

3.14. FormChangesInfo

Field Name

Required

Type

Description

Format

name

String

title

String

status

String

Enum: NEW, CHANGED, DELETED,

3.15. FormDetailsShort

Field Name

Required

Type

Description

Format

name

String

Form service name

title

String

Form name

created

Date

Form creation date

date-time

updated

Date

Form updated date

date-time

3.16. GlobalSettingsInfo

Field Name

Required

Type

Description

Format

titleFull

String

title

String

themeFile

String

supportEmail

String

3.17. HandleFileUploadRequest

Field Name

Required

Type

Description

Format

file

File

binary

securityContext

SecurityContext

3.18. Inspection

Version candidate inspections

Field Name

Required

Type

Description

Format

name

String

Name of inspection

inspector

String

Person who performed inspection

result

String

Inspection result

Enum: APPROVED, REJECTED,

resultDetails

String

Inspection result detailsN

3.19. MasterVersionInfoDetailed

Field Name

Required

Type

Description

Format

String

Last version candidate identifier

name

String

Last version candidate name

description

String

Last version candidate description

author

String

Last version candidate author

latestUpdate

Date

Last version candidate update time

date-time

published

Boolean

Last version candidate publication flag

inspector

String

Last version candidate inspector

validations

List of Validation

Last version candidate validations

3.20. SecurityContext

Field Name

Required

Type

Description

Format

accessToken

String

3.21. TableDetailsShort

Field Name

Required

Type

Description

Format

name

String

description

String

objectReference

Boolean

historyFlag

Boolean

3.22. Validation

Version candidate validations

Field Name

Required

Type

Description

Format

name

String

Validation name

type

String

Validation type

Enum: REGULATION_INTEGRITY, TEST,

result

String

Validation result

Enum: APPROVED, REJECTED,

resultDetails

String

Validation result details

3.23. VersionChanges

Field Name

Required

Type

Description

Format

changedForms

List of FormChangesInfo

changedBusinessProcesses

List of BusinessProcessChangesInfo

3.24. VersionInfo

Field Name

Required

Type

Description

Format

String

Version candidate identifier

name

String

Version candidate name

description

String

Version candidate description

3.25. VersionInfoDetailed

Field Name

Required

Type

Description

Format

String

Version candidate identifier

name

String

Version candidate name

description

String

Version candidate description

author

String

Version candidate author

creationDate

Date

Version candidate creation time

date-time

latestUpdate

Date

Version candidate update time

date-time

hasConflicts

Boolean

Version candidate conflicts flag

inspections

List of Inspection

Version candidate inspections

validations

List of Validation

Version candidate validations