Model Settings - Update

Updates time series model settings - either the model name or default type ID.

PATCH https://{environmentFqdn}/timeseries/modelSettings?api-version=2018-11-01-preview

URI Parameters

Name In Required Type Description
environmentFqdn
path True
  • string

Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager.

api-version
query True
  • string

Version of the API to be used with the client request. Currently supported version is "2018-11-01-preview".

Request Header

Name Required Type Description
x-ms-client-request-id
  • string

Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request.

x-ms-client-session-id
  • string

Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests.

Request Body

Name Type Description
defaultTypeId
  • string

Default type id of the model that new instances will automatically belong to.

name
  • string

Model display name which is shown in the UX and mutable by the user. Initial value is "DefaultModel".

Responses

Name Type Description
200 OK

Successful operation returns new full model settings.

Headers

  • x-ms-request-id: string
Other Status Codes

Unexpected error.

Headers

  • x-ms-request-id: string

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ModelSettingsUpdateName

Sample Request

PATCH https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/modelSettings?api-version=2018-11-01-preview
{
  "name": "Thermostats"
}

Sample Response

{
  "modelSettings": {
    "name": "Thermostats",
    "timeSeriesIdProperties": [
      {
        "name": "DeviceId",
        "type": "String"
      }
    ],
    "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C"
  }
}

Definitions

ModelSettingsResponse

Response containing full time series model settings which include model name, Time Series ID properties and default type ID.

TimeSeriesIdProperty

A definition of a single property that can be used in time series ID properties defined during environment creation.

TimeSeriesIdPropertyTypes

The type of the property. Currently, only "String" is supported.

TimeSeriesModelSettings

Time series model settings including model name, Time Series ID properties and default type ID.

TsiError

Information about an API error.

TsiErrorBody

A particular API error with an error code and a message.

TsiErrorDetails

Additional error information.

UpdateModelSettingsRequest

Request to update model settings. One of "name" or "defaultTypeId" must be set.

ModelSettingsResponse

Response containing full time series model settings which include model name, Time Series ID properties and default type ID.

Name Type Description
modelSettings

Model settings including model name, Time Series ID properties and default type ID.

TimeSeriesIdProperty

A definition of a single property that can be used in time series ID properties defined during environment creation.

Name Type Description
name
  • string

The name of the property.

type

The type of the property. Currently, only "String" is supported.

TimeSeriesIdPropertyTypes

The type of the property. Currently, only "String" is supported.

Name Type Description
String
  • string

TimeSeriesModelSettings

Time series model settings including model name, Time Series ID properties and default type ID.

Name Type Description
defaultTypeId
  • string

Default type ID of the model that new time series instances will automatically belong to.

name
  • string

Time series model display name which is shown in the UX. Examples: "Temperature Sensors", "MyDevices".

timeSeriesIdProperties

Time series ID properties defined during environment creation.

TsiError

Information about an API error.

Name Type Description
error

A particular API error with an error code and a message.

TsiErrorBody

A particular API error with an error code and a message.

Name Type Description
code
  • string

Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.

details

Contains additional error information. May be null.

innerError

Contains more specific error that narrows down the cause. May be null.

message
  • string

Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.

target
  • string

Target of the particular error (for example, the name of the property in error). May be null.

TsiErrorDetails

Additional error information.

Name Type Description
code
  • string

Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.

message
  • string

Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.

UpdateModelSettingsRequest

Request to update model settings. One of "name" or "defaultTypeId" must be set.

Name Type Description
defaultTypeId
  • string

Default type id of the model that new instances will automatically belong to.

name
  • string

Model display name which is shown in the UX and mutable by the user. Initial value is "DefaultModel".