Time Series Instances - Execute Batch

Service:

Time Series Insights

API Version:

2020-07-31

Birden çok zaman serisi örneğinde toplu alma, oluşturma, güncelleştirme, silme işlemini yürütür.

POST https://{environmentFqdn}/timeseries/instances/$batch?api-version=2020-07-31

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
environmentFqdn	path	True	string	Ortam başına FQDN, örneğin 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Bu etki alanı adını Ortamları Al API'sinin, Azure portal veya Azure Resource Manager yanıtından alabilirsiniz.
api-version	query	True	string	İstemci isteğiyle kullanılacak API'nin sürümü. Şu anda desteklenen sürüm :"2020-07-31".

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string	İsteğe bağlı istemci istek kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında işlemi izlemesine ve müşterinin belirli bir istekle ilgili desteğe başvurmasına olanak tanır.
x-ms-client-session-id		string	İsteğe bağlı istemci oturum kimliği. Hizmet bu değeri kaydeder. Hizmetin hizmetler arasında bir grup ilgili işlemi izlemesine ve müşterinin belirli bir istek grubuyla ilgili desteğe başvurmasına olanak tanır.

İstek Gövdesi

Name	Tür	Description
delete	InstancesRequestBatchGetOrDelete	Silinecek zaman serisi örnekleri. Zaman serisi kimliği veya adı belirtilebilir.
get	InstancesRequestBatchGetOrDelete	Döndürülecek zaman serisi kimlikleri veya zaman serisi örneklerinin adları.
put	TimeSeriesInstance[]	Oluşturulacak veya güncelleştirilecek zaman serisi örnekleri.
update	TimeSeriesInstance[]	Güncelleştirilecek zaman serisi örneği. Örnek yoksa bir hata döndürülür.

Yanıtlar

Name	Tür	Description
200 OK	InstancesBatchResponse	Başarılı bir işlem. Headers x-ms-request-id: string
Other Status Codes	TsiError	Beklenmeyen hata. Headers x-ms-request-id: string

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

InstancesBatchDeleteByIds

InstancesBatchDeleteByNames

InstancesBatchGetByIds

InstancesBatchGetByNames

InstancesBatchPut

InstancesBatchUpdate

InstancesBatchDeleteByIds

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

Sample Response

Status code:

200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

Sample Response

Status code:

200

{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

Sample Response

Status code:

200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

Sample Response

Status code:

200

{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Sample Response

Status code:

200

{
  "put": [
    {
      "error": null
    }
  ]
}

InstancesBatchUpdate

Sample Request

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/$batch?api-version=2020-07-31

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

Sample Response

Status code:

200

{
  "update": [
    {
      "error": null
    }
  ]
}

Tanımlar

Name	Description
InstanceOrError	Belirli bir zaman serisi örneğindeki toplu işlemin sonucu. İşlem başarılı olduğunda (yerleştirme işlemi dışında) örnek nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.
InstancesBatchRequest	Bir örnek grubu üzerinde tek bir işlem gerçekleştirme isteği. Tam olarak "get", "put", "update" veya "delete" değerlerinden biri ayarlanmalıdır.
InstancesBatchResponse	Bir grup örnek üzerinde tek bir işlemin yanıtı. İstek temelinde yalnızca "get", "put", "update" veya "delete" ayarlanacaktır.
InstancesRequestBatchGetOrDelete	Zaman serisi kimliklerine veya zaman serisi adlarına göre örnekleri alma veya silme isteği. Tam olarak "timeSeriesIds" veya "names" değerlerinden biri ayarlanmalıdır.
TimeSeriesInstance	Zaman serisi örnekleri, zaman serisinin kendileridir. Çoğu durumda deviceId veya assetId, ortamdaki varlığın benzersiz tanımlayıcısıdır. Örnekler, örnek alanları olarak adlandırılan açıklayıcı bilgilerle ilişkilendirilmiştir. Örnek alanları en azından hiyerarşi bilgilerini içerir. Ayrıca üretici, operatör veya son hizmet tarihi gibi yararlı, açıklayıcı veriler de içerebilir.
TsiError	API hatası hakkında bilgi.
TsiErrorBody	Hata kodu ve ileti içeren belirli bir API hatası.
TsiErrorDetails	Ek hata bilgileri.

InstanceOrError

Belirli bir zaman serisi örneğindeki toplu işlemin sonucu. İşlem başarılı olduğunda (yerleştirme işlemi dışında) örnek nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.

Name	Tür	Description
error	TsiErrorBody	Hata nesnesi - işlem başarısız olduğunda ayarlanır.
instance	TimeSeriesInstance	Zaman serisi örneği nesnesi - işlemin başarılı olduğu zaman ayarlanır (yerleştirme işlemi dışında).

InstancesBatchRequest

Bir örnek grubu üzerinde tek bir işlem gerçekleştirme isteği. Tam olarak "get", "put", "update" veya "delete" değerlerinden biri ayarlanmalıdır.

Name	Tür	Description
delete	InstancesRequestBatchGetOrDelete	Silinecek zaman serisi örnekleri. Zaman serisi kimliği veya adı belirtilebilir.
get	InstancesRequestBatchGetOrDelete	Döndürülecek zaman serisi kimlikleri veya zaman serisi örneklerinin adları.
put	TimeSeriesInstance[]	Oluşturulacak veya güncelleştirilecek zaman serisi örnekleri.
update	TimeSeriesInstance[]	Güncelleştirilecek zaman serisi örneği. Örnek yoksa bir hata döndürülür.

InstancesBatchResponse

Bir grup örnek üzerinde tek bir işlemin yanıtı. İstek temelinde yalnızca "get", "put", "update" veya "delete" ayarlanacaktır.

Name	Tür	Description
delete	TsiErrorBody[]	İstekteki "sil" dizisinin konumuna göre karşılık gelen hata nesnelerinin listesi. Null, örneğin silindiği veya mevcut olmadığı anlamına gelir. İşlem başarısız olduğunda (örneğin, bu zaman serisi örneğiyle ilişkili olaylar olduğunda) hata nesnesi ayarlanır.
get	InstanceOrError[]	İstekteki "get" dizisinin konumuna göre karşılık gelen örnek veya hata nesnelerinin listesi. İşlem başarılı olduğunda örnek nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.
put	InstanceOrError[]	İstekteki "put" dizisinin konumuna göre karşılık gelen hata nesnelerinin listesi. İşlem başarısız olduğunda hata nesnesi ayarlanır.
update	InstanceOrError[]	İstekteki "update" dizisinin konumuna göre karşılık gelen hata nesnelerinin listesi. İşlem başarılı olduğunda örnek nesnesi ayarlanır ve işlem başarısız olduğunda hata nesnesi ayarlanır.

InstancesRequestBatchGetOrDelete

Zaman serisi kimliklerine veya zaman serisi adlarına göre örnekleri alma veya silme isteği. Tam olarak "timeSeriesIds" veya "names" değerlerinden biri ayarlanmalıdır.

Name	Tür	Description
names	string[]	Döndürülecek veya silinecek zaman serisi örneklerinin adları listesi.
timeSeriesIds	TimeSeriesId[]	Döndürülecek veya silinecek zaman serisi örneklerinin zaman serisi kimliklerinin listesi.

TimeSeriesInstance

Zaman serisi örnekleri, zaman serisinin kendileridir. Çoğu durumda deviceId veya assetId, ortamdaki varlığın benzersiz tanımlayıcısıdır. Örnekler, örnek alanları olarak adlandırılan açıklayıcı bilgilerle ilişkilendirilmiştir. Örnek alanları en azından hiyerarşi bilgilerini içerir. Ayrıca üretici, operatör veya son hizmet tarihi gibi yararlı, açıklayıcı veriler de içerebilir.

Name	Tür	Description
description	string	Bu isteğe bağlı alan, örnekle ilgili açıklama içerir.
hierarchyIds	string[]	Örneğin ait olduğu zaman serisi hiyerarşi kimlikleri kümesi. Null olabilir.
instanceFields		Kullanıcı tanımlı örnek özelliklerini içeren anahtar-değer çiftleri kümesi. Null olabilir. Desteklenen özellik değeri türleri şunlardır: bool, dize, long, double ve iç içe veya null olamaz.
name	string	Bir ortamda benzersiz olan örneğin isteğe bağlı adı. Adlar, zaman serisi örneğinin değiştirilebilir diğer adı veya görünen adı olarak görev yapar. Değiştirilebilir, null olabilir.
timeSeriesId	TimeSeriesId[]	Örneği benzersiz olarak tanımlayan Zaman Serisi Kimliği. Bir ortamdaki Zaman Serisi Kimliği özellikleriyle eşleşir. Sabit, hiçbir zaman null.
typeId	string	Bu, bu örneğin ait olduğu türü temsil eder. Hiçbir zaman null.

TsiError

API hatası hakkında bilgi.

Name	Tür	Description
error	TsiErrorBody	Hata kodu ve ileti içeren belirli bir API hatası.

TsiErrorBody

Hata kodu ve ileti içeren belirli bir API hatası.

Name	Tür	Description
code	string	Hizmete özgü bir hata kodunu tanımlayan dilden bağımsız, insan tarafından okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha belirgin bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	TsiErrorDetails[]	Ek hata bilgileri içerir. Null olabilir.
innerError	TsiErrorBody	Nedeni daraltan daha belirgin bir hata içerir. Null olabilir.
message	string	Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardımcı olmak için tasarlanmıştır ve son kullanıcıların etkilenmesi için uygun değildir.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı). Null olabilir.

TsiErrorDetails

Ek hata bilgileri.

Name	Tür	Description
code	string	Hizmete özgü bir hata kodunu tanımlayan dilden bağımsız, insan tarafından okunabilir dize. Bu kod, yanıtta belirtilen HTTP hata kodu için daha belirgin bir gösterge görevi görür. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
message	string	Hatanın insan tarafından okunabilir, dilden bağımsız gösterimi. Geliştiricilere yardımcı olmak için tasarlanmıştır ve son kullanıcıların etkilenmesi için uygun değildir.