Rest API Documentation

REST API Documentation for Group page-template, application /webconsole Version: 4.2.1.3

Endpoints (DRAFT)

POST /rest/api/pagetemplate/delete

Page Template API Doc

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

GET /rest/api/pagetemplate/get/field/(id)

Page Template API Doc, Get field by id. It looks for custom fields and default fields

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/MetadataElementPageTemplate

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/MetadataElementPageTemplate

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

Page Template API Doc, Get page template by id

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/MetadataElementPageTemplate

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/MetadataElementPageTemplate

GET /rest/api/pagetemplate/get/(id)/field/types

Page Template API Doc, Get page template fields by type id

Path Params:

• id [{'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

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

Page Template API Doc, Get fields for template by id

Path Params:

• id [{'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

GET /rest/api/pagetemplate/get/(id)/patterns

Page Template API Doc, Get patterns by template id

Path Params:

• id [{'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

GET /rest/api/pagetemplate/get/(id)/templateFields

Page Template API Doc, Get template fields

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/MetadataElementPageTemplateSearchBean

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/MetadataElementPageTemplateSearchBean

POST /rest/api/pagetemplate/save

Page Template API Doc, Save page template

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

Page Template API Doc, Search page templates

Query Params:

• name [{'type': 'string'}]:
• templateTypeId [{'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

DELETE /rest/api/pagetemplate/(id)

Page Template API Doc, Delete page template

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