Share via

Configuration service

This service enables you to provide configuration information to Microsoft.

Add a configuration

PUT /configurations?api-version=1

Adds a configuration with the specified Microsoft product, using the specified context.

Parameters

Type Name Required Description Schema
Query api-version Yes The supported API version. Must be set to 1. Integer (int32)

HTTP headers

Name Value
Content-Type application/json
Authorization Bearer <access token issued by your identity solution>
Accept application/json

Request body

Name Required Description Schema
productId Yes The Microsoft-defined identifier of the product for which the configuration is added. See Product identifiers. String (uuid)
partnerId Yes The Microsoft-defined identifier of the partner adding the configuration. String (uuid)
customerId Yes The Microsoft-defined identifier of the customer for which the configuration is added. String (uuid)
ehrInstanceId No The Microsoft-defined identifier of the EHR instance for which the configuration is added. String
data No A JSON string containing configuration data to add. The data should contain all the identifiers the product needs to understand the type of configuration data being added. Stringified JSON

Sample request

PUT /configurations?api-version=1
{
    "productId": "7ceade5e-e98d-4ae7-a839-c3c4aa32162c",
    "partnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 
    "customerId": "b6726eaf-f57c-4f15-b1af-d317ac7279bc", 
    "ehrInstanceId": "4fa0d8ac-693a-4bf1-845e-22b815987e2a",
    "data": "{\"data\":\"test\"}"
}

Response codes

Code Description Links
200 Success. Data successfully added. No links
400 Invalid request. Input validation failed. o links
401 Not authorized. The access token is missing or invalid. No links
403 Forbidden. The caller is not authorized to call the API. No links
500 Internal server error. Any other exceptional scenario where the application isn't able to complete the request. No links
5xx The HTTP status is propagated from the handler application to the caller application for transparency of the problem. No links

Response body

{
    "message": "Data successfully added."
}

Response body properties

Name Description Schema
message Success message. String
  • Last updated on