Update Microsoft Health Bot Management API.md

This commit is contained in:
sharonlai 2017-10-10 15:49:34 +03:00 коммит произвёл GitHub
Родитель 0873ab8a4d
Коммит 92eeffd009
1 изменённых файлов: 23 добавлений и 22 удалений

Просмотреть файл

@ -37,7 +37,8 @@ An exemplary JWT token payload before encoding is shown here:
The JWT token is placed in the authorization header, according to the following example:
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnROYW1lIjoibXlUZW5hbnQiLCJpYXQiOiIxNTA3MDU2OTAwIn0.MN4DcxO2mLsltEYNpXbC6T6Bjxj3-rxIAObngZIw4-U
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnROYW1lIjoibXlUZW5hbnQiLCJpYXQiOiIxNTA3MDU2OTAwIn0.MN4DcxO2mLsltEYNpXbC6T6Bjxj3-rxIAObngZIw4-U
It is recommended to implement the JWT tokens with standard libraries, for example: Node.js "jsonwebtoken" library.
@ -45,30 +46,30 @@ It is recommended to implement the JWT tokens with standard libraries, for examp
### Export Scenarios
| URL | https://healthbot.microsoft.com/api/account/<tenantName>/scenarios |
| --- | --- |
| Method | GET |
| Special headers | Authorization: Bearer <JWT Token> |
| Request Parameters | None |
| Response | An array of JSON objects in the response body. Every object represents a Health Bot scenario |
| Examples | GET [https://healthbot.microsoft.com/api/account/healthagentprod/scenarios HTTP/1.1](https://healthbot.microsoft.com/api/account/healthagentprod/scenarios)
Authorization: BearereyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnROYW1lIjoiaGVhbHRoYWdlbnRwcm9kIiwiaWF0IjoxNTA2OTYwODAwfQ.x9oyA4kgfIgV5R1CpvMQeUYuP6FSlI65lx7Og8nMuWw
Host: healthbot.microsoft.com HTTP/1.1 200 OK
**URL: **https://healthbot.microsoft.com/api/account/<tenantName>/scenarios
**Method:** GET
**Special headers:** Authorization: Bearer <JWT Token>
**Request Parameters:** None
**Response:** An array of JSON objects in the response body. Every object represents a Health Bot scenario
**Examples:**
GET https://healthbot.microsoft.com/api/account/healthagentprod/scenarios HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnROYW1lIjoiaGVhbHRoYWdlbnRwcm9kIiwiaWF0IjoxNTA2OTYwODAwfQ.x9oyA4kgfIgV5R1CpvMQeUYuP6FSlI65lx7Og8nMuWw
Host: healthbot.microsoft.com
HTTP/1.1 200 OK
[exported scenarios will appear in the response body] |
| Comments | N/A |
**Comments:** N/A
### Import Scenarios
| URL | https://healthbot.microsoft.com/api/account/<tenantName>/scenarios |
| --- | --- |
| Method | POST |
| Special headers | Authorization: Bearer <JWT Token>. Content-type: application/jsoncontent-type: application/json |
| Request Parameters | An array of JSON objects in request body. Every object represents a Health Bot scenario |
| Response | 200 OK in case of success |
| Examples | POST [https://healthbot.microsoft.com/api/account/healthagentprod/scenarios HTTP/1.1](https://healthbot.microsoft.com/api/account/healthagentprod/scenarios)
**URL:** https://healthbot.microsoft.com/api/account/<tenantName>/scenarios
**Method:** POST
**Special headers:** Authorization: Bearer <JWT Token> , Content-type: application/json
**Request Parameters:** An array of JSON objects in request body. Every object represents a Health Bot scenario
**Response:** 200 OK in case of success
**Examples:**
POST https://healthbot.microsoft.com/api/account/healthagentprod/scenarios HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZW5hbnROYW1lIjoiaGVhbHRoYWdlbnRwcm9kIiwiaWF0IjoxNTA2OTYxMzAwfQ.YGayhOc0fOaLRK4cWzRIhSsNH0zWOTy7Pe2PWSY5-cE
Host: healthbot.microsoft.com
content-type: application/json
Content-Length: 51116
[scenarios in request body] |
| Comments | When posting new scenarios, they will be added to the existing scenarios in the scenario editor. Scenario with the same name will be overridden. |
Content-type: application/jsonContent-Length: 51116
[scenarios in request body]
**Comments:** When posting new scenarios, they will be added to the existing scenarios in the scenario editor. Scenario with the same name will be overridden.