Rest API Documentation

REST API Documentation for Group batch, application /webconsole Version: 4.2.1.2

Endpoints (DRAFT)

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

Batch task API Doc, Delete batch task 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

POST /rest/api/batch/execute

Batch task API Doc, Execute batch task

Query 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/batch/find

Batch task API Doc, Find batch tasks

Query Params:

• name [{'type': 'string'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• size [{'type': 'integer', 'format': 'int32'}]:

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/batch/get/(id)

Batch task API Doc, Get batch task by id

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/BatchTaskBean

• Status Code: 404 Not Found.

  Content-type: /,

  Schema: /components/schemas/BatchTaskBean

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/BatchTaskBean

POST /rest/api/batch/save

Batch task API Doc, Save batch task

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/batch/schedule/find

Batch task API Doc, Find scheduled batch tasks

Query Params:

• taskId [{'type': 'string'}]:
• from [{'type': 'integer', 'format': 'int32'}]:
• size [{'type': 'integer', 'format': 'int32'}]:
• offset [{'type': 'integer', 'format': 'int32'}]:

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

DELETE /rest/api/batch/schedule/(id)

Batch task API Doc, Delete scheduled batch tasks

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

POST /rest/api/batch/schedule/(id)

Batch task API Doc, Schedule batch task by id

Query Params:

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

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