/webconsole - field

Rest API Documentation

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

Endpoints (DRAFT)

POST /rest/api/fields/delete

Field API Doc

Query Params:

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

Responses:

  • Status Code: 200 OK.

    Content-type: /,

    Schema: /components/schemas/BasicAjaxResponse

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

Field API Doc, Get field by id

Path Params:

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

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/CustomFieldBean

  • Status Code: 404 Not Found.

    Content-type: application/json

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/CustomFieldBean

GET /rest/api/fields/get/(id)/templates

Field API Doc, Search custom fields

Path Params:

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

Responses:

  • Status Code: 200 Success.

    Content-type: application/json,

    Schema: /components/schemas/BeanResponse

  • Status Code: 404 Not Found.

    Content-type: application/json

  • Status Code: 500 Failure.

    Content-type: application/json,

    Schema: /components/schemas/BeanResponse

POST /rest/api/fields/save

Field API Doc, Save custom fields

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/fields/search

Field API Doc, Search custom fields

Query Params:

  • name [{'type': 'string'}]:
  • typeId [{'type': 'string'}]:
  • size [{'type': 'integer', 'format': 'int32'}]:
  • from [{'type': 'integer', 'format': 'int32'}]:
  • 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

DELETE /rest/api/fields/(id)

Field API Doc, Delete custom fields

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