Rest API Documentation

REST API Documentation for Group sync-config, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

GET /rest/api/syncconfig/csv/get/(id)

Synchronization Configuration API Doc, Get CSV Sync Config By ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: text/csv

• Status Code: 404 Not Found.

• Status Code: 500 Failure.

GET /rest/api/syncconfig/csv/list

Synchronization Configuration API Doc, Get All CSV Sync Configs

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/CSVConfigListResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/CSVConfigListResponse

GET /rest/api/syncconfig/csv/preview/(id)

Synchronization Configuration API Doc, Start Sync By ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

DELETE /rest/api/syncconfig/delete/(id)

Synchronization Configuration API Doc, Delete Sync Config By ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/syncconfig/get/(id)

Synchronization Configuration API Doc, Get Sync Config By ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/SynchConfigResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/SynchConfigResponse

POST /rest/api/syncconfig/save

Synchronization Configuration API Doc, Add CSV Sync Config

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

PUT /rest/api/syncconfig/save

Synchronization Configuration API Doc, Edit synchronization config

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/syncconfig/search

Synchronization Configuration API Doc, Search for Sync Config

Query Params:

• name [{'type': 'string'}]:
• type [{'type': 'string'}]:
• deepCopy [{'type': 'boolean'}]:
• from [{'type': 'integer', 'format': 'int32', 'default': -1}]:
• size [{'type': 'integer', 'format': 'int32', 'default': -1}]:
• sortBy [{'type': 'string'}]:
• orderBy [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BeanResponse

POST /rest/api/syncconfig/upload

Synchronization Configuration API Doc, Upload CSV Sync Config

Query Params:

• syncId [{'type': 'string'}]:

Body Params:

• {'content': {'application/json': {'schema': {'type': 'object', 'properties': {'file': {'type': 'string', 'format': 'binary'}}}}}} Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/syncconfig/(id)/startSynch

Synchronization Configuration API Doc, Start Sync By ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/syncconfig/(id)/testConnect

Synchronization Configuration API Doc, Test Sync Config Connection By ID

Path Params:

• id [{'type': 'string'}]:

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BasicAjaxResponse## Definitions