Rest API Documentation

REST API Documentation for Group content-provider, application /webconsole Version: 4.2.1.2

Endpoints (DRAFT)

POST /rest/api/contentproviders/delete

Content Provider API Doc

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BasicAjaxResponse

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

Content Provider API Doc, Get content provider by id

Path Params:

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

Responses:

• Status Code: 200 Success.

  Content-type: application/json,

  Schema: /components/schemas/ContentProvider

• Status Code: 404 Not Found.

  Content-type: application/json,

  Schema: /components/schemas/ContentProvider

• Status Code: 500 Failure.

  Content-type: application/json,

  Schema: /components/schemas/ContentProvider

GET /rest/api/contentproviders/req-auth-levels

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/contentproviders/save

Content Provider API Doc, Save content provider

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

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

GET /rest/api/contentproviders/search

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

HEAD /rest/api/contentproviders/search

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

OPTIONS /rest/api/contentproviders/search

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

PATCH /rest/api/contentproviders/search

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

POST /rest/api/contentproviders/search

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

PUT /rest/api/contentproviders/search

content-provider-rest-controller

Query Params:

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

Responses:

• Status Code: 200 OK.

  Content-type: /,

  Schema: /components/schemas/BeanResponse

DELETE /rest/api/contentproviders/(id)

Content Provider API Doc, Delete content provider

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/contentproviders/(id)/createDefaultURIPatterns

Content Provider API Doc, Create default uri patterns

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