Preview

Previews
- Previews Manage
GET kb/previews
GET kb/previews/{id}
POST kb/previews
PUT kb/previews/{id}
DELETE kb/previews/{id}
Model
Preview JSON Format

Preview is represented as simple flat JSON objects with the following keys:

Name Type Description
entityName string
data string
id guid
Endpoint
Get the list of Previews

GET kb/previews

Parameters:
No Parameters
Response:

An array of   Preview

Example

Sample Request:

curl https://api15.comm100.io/v4/kb/previews \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"entityName":"","data":"","id":"374a8ce3-c445-4636-85a1-7c948b1ef0dd"}]
Get a single Preview

GET kb/previews/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/kb/previews/374a8ce3-c445-4636-85a1-7c948b1ef0dd \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"entityName":"","data":"","id":"374a8ce3-c445-4636-85a1-7c948b1ef0dd"}
Create a new Preview

POST kb/previews

Parameters:
Name Type In Required Description
entityName string body yes
data string body yes
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/kb/previews \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"entityName":"","data":""}'

Response:

 HTTP/1.1 201 Created

{"entityName":"","data":"","id":"374a8ce3-c445-4636-85a1-7c948b1ef0dd"}
Update the Preview

PUT kb/previews/{id}

Parameters:
Name Type In Required Description
entityName string body yes
data string body yes
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/kb/previews/374a8ce3-c445-4636-85a1-7c948b1ef0dd \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"entityName":"","data":""}'

Response:

 HTTP/1.1 200 OK

{"entityName":"","data":"","id":"374a8ce3-c445-4636-85a1-7c948b1ef0dd"}
Remove the Preview

DELETE kb/previews/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/kb/previews/374a8ce3-c445-4636-85a1-7c948b1ef0dd \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content