다음을 통해 공유

Time Series Hierarchies - Execute Batch

서비스:
Time Series Insights
API 버전:
2020-07-31

여러 시계열 계층 정의에 대해 일괄 처리, 생성, 업데이트, 삭제 작업을 실행합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
environmentFqdn
 path True

string

환경별 FQDN(예: 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com). 환경 가져오기 API, Azure Portal 또는 Azure Resource Manager의 응답에서 이 도메인 이름을 가져올 수 있습니다.
api-version
 query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 지원되는 버전은 "2020-07-31"입니다.

요청 헤더

Name 필수 형식 Description
x-ms-client-request-id

string

선택적 클라이언트 요청 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 간 작업을 추적할 수 있도록 하고 고객이 특정 요청과 관련하여 지원에 문의할 수 있도록 허용합니다.
x-ms-client-session-id

string

선택적 클라이언트 세션 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 전반의 관련 작업 그룹을 추적할 수 있도록 하고 고객이 특정 요청 그룹에 대한 지원에 문의할 수 있도록 허용합니다.

요청 본문

Name 형식 Description
delete

HierarchiesRequestBatchGetDelete

"delete"는 ID 또는 이름으로 특정 계층을 가져오는 동안 설정해야 합니다.
get

HierarchiesRequestBatchGetDelete

"get"은 ID 또는 이름으로 특정 계층을 가져오는 동안 설정해야 합니다.
put

TimeSeriesHierarchy[]

"put"은 계층 구조를 만들거나 업데이트하는 동안 설정해야 합니다.

응답

Name 형식 Description
200 OK

HierarchiesBatchResponse

작업이 성공했습니다.

헤더

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

TsiError

예기치 않은 오류입니다.

헤더

x-ms-request-id: string

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

HierarchiesBatchDeleteByIds
HierarchiesBatchDeleteByNames
HierarchiesBatchGetByIds
HierarchiesBatchGetByNames
HierarchiesBatchPut

HierarchiesBatchDeleteByIds

샘플 요청

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

{
  "delete": {
    "hierarchyIds": [
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchDeleteByNames

샘플 요청

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

{
  "delete": {
    "names": [
      "WindFarm"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "delete": [
    null
  ]
}

HierarchiesBatchGetByIds

샘플 요청

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

{
  "get": {
    "hierarchyIds": [
      "6e292e54-9a26-4be1-9034-607d71492707",
      "a28fd14c-6b98-4ab5-9301-3840f142d30e"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchGetByNames

샘플 요청

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

{
  "get": {
    "names": [
      "Location",
      "ManufactureDate"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "get": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      }
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      }
    }
  ]
}

HierarchiesBatchPut

샘플 요청

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

{
  "put": [
    {
      "id": "6e292e54-9a26-4be1-9034-607d71492707",
      "name": "Location",
      "source": {
        "instanceFieldNames": [
          "state",
          "city"
        ]
      }
    },
    {
      "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
      "name": "ManufactureDate",
      "source": {
        "instanceFieldNames": [
          "year",
          "month"
        ]
      }
    }
  ]
}

샘플 응답

상태 코드:
200 
{
  "put": [
    {
      "hierarchy": {
        "id": "6e292e54-9a26-4be1-9034-607d71492707",
        "name": "Location",
        "source": {
          "instanceFieldNames": [
            "state",
            "city"
          ]
        }
      },
      "error": null
    },
    {
      "hierarchy": {
        "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e",
        "name": "ManufactureDate",
        "source": {
          "instanceFieldNames": [
            "year",
            "month"
          ]
        }
      },
      "error": null
    }
  ]
}

정의

Name Description
HierarchiesBatchRequest

계층 배치에 대해 단일 작업을 수행하도록 요청합니다. 정확히 "get", "put" 또는 "delete" 중 하나를 설정해야 합니다.
HierarchiesBatchResponse

시계열 계층 배치에 대한 단일 작업의 응답입니다. "get", "put" 또는 "delete" 중 하나만 설정됩니다.
HierarchiesRequestBatchGetDelete

여러 시계열 계층을 가져오거나 삭제하도록 요청합니다. "hierarchyIds" 또는 "names" 중 정확히 하나를 설정해야 합니다.
Source

시계열 계층 트리 수준을 만드는 방법에 대한 정의입니다.
TimeSeriesHierarchy

시계열 계층 구조는 시계열 인스턴스를 트리로 구성합니다.
TimeSeriesHierarchyOrError

특정 시계열 계층 구조에 대한 일괄 처리 작업의 결과입니다. 계층 구조는 작업이 성공하면 설정되고 오류 개체는 작업이 실패할 때 설정됩니다.
TsiError

API 오류에 대한 정보입니다.
TsiErrorBody

오류 코드 및 메시지가 있는 특정 API 오류입니다.
TsiErrorDetails

추가 오류 정보입니다.

HierarchiesBatchRequest

Object

계층 배치에 대해 단일 작업을 수행하도록 요청합니다. 정확히 "get", "put" 또는 "delete" 중 하나를 설정해야 합니다.

Name 형식 Description
delete

HierarchiesRequestBatchGetDelete

"delete"는 ID 또는 이름으로 특정 계층을 가져오는 동안 설정해야 합니다.
get

HierarchiesRequestBatchGetDelete

"get"은 ID 또는 이름으로 특정 계층을 가져오는 동안 설정해야 합니다.
put

TimeSeriesHierarchy[]

"put"은 계층 구조를 만들거나 업데이트하는 동안 설정해야 합니다.

HierarchiesBatchResponse

Object

시계열 계층 배치에 대한 단일 작업의 응답입니다. "get", "put" 또는 "delete" 중 하나만 설정됩니다.

Name 형식 Description
delete

TsiErrorBody[]

요청의 "delete" 배열 위치별로 해당하는 오류 개체 목록입니다. 작업이 성공하면 null입니다.
get

TimeSeriesHierarchyOrError[]

요청의 "get" 배열에 대한 위치별로 해당하는 계층 구조 또는 오류 개체의 목록입니다. Hierarchy 객체는 조작이 성공하면 설정되고 error 객체는 조작이 실패하면 설정됩니다.
put

TimeSeriesHierarchyOrError[]

요청의 "put" 배열에 대한 위치별로 해당하는 계층 구조 또는 오류 개체의 목록입니다. Hierarchy 객체는 조작이 성공하면 설정되고 error 객체는 조작이 실패하면 설정됩니다.

HierarchiesRequestBatchGetDelete

Object

여러 시계열 계층을 가져오거나 삭제하도록 요청합니다. "hierarchyIds" 또는 "names" 중 정확히 하나를 설정해야 합니다.

Name 형식 Description
hierarchyIds

string[]

계층 ID 목록입니다.
names

string[]

계층 이름 목록입니다.

Source

Object

시계열 계층 트리 수준을 만드는 방법에 대한 정의입니다.

Name 형식 Description
instanceFieldNames

string[]

이 계층 구조에 속하는 모든 시계열 인스턴스에서 설정해야 하는 인스턴스 필드 이름 목록입니다. 인스턴스 필드의 순서는 계층 구조의 수준을 정의합니다.

TimeSeriesHierarchy

Object

시계열 계층 구조는 시계열 인스턴스를 트리로 구성합니다.

Name 형식 Description
id

string

대/소문자를 구분하는 고유 계층 식별자입니다. 계층 구조 개체를 만드는 동안 null일 수 있으며 서버는 가져오기 및 삭제 작업에서 null이 아닌 ID를 생성합니다.
name

string

사용자가 지정한 형식의 고유 이름입니다. 변경 가능하며 null이 아닙니다.
source

Source

시계열 계층 트리 수준을 만드는 방법에 대한 정의입니다.

TimeSeriesHierarchyOrError

Object

특정 시계열 계층 구조에 대한 일괄 처리 작업의 결과입니다. 계층 구조는 작업이 성공하면 설정되고 오류 개체는 작업이 실패할 때 설정됩니다.

Name 형식 Description
error

TsiErrorBody

오류 개체 - 작업이 실패할 때 설정됩니다.
hierarchy

TimeSeriesHierarchy

시계열 계층 개체 - 작업이 성공할 때 설정됩니다.

TsiError

Object

API 오류에 대한 정보입니다.

Name 형식 Description
error

TsiErrorBody

오류 코드 및 메시지가 있는 특정 API 오류입니다.

TsiErrorBody

Object

오류 코드 및 메시지가 있는 특정 API 오류입니다.

Name 형식 Description
code

string

서비스별 오류 코드를 정의하는 언어 독립적, 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details

TsiErrorDetails[]

추가 오류 정보를 포함합니다. null일 수 있습니다.
innerError

TsiErrorBody

원인을 좁히는 보다 구체적인 오류를 포함합니다. null일 수 있습니다.
message

string

사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.
target

string

특정 오류의 대상입니다(예: 오류의 속성 이름). null일 수 있습니다.

TsiErrorDetails

Object

추가 오류 정보입니다.

Name 형식 Description
code

string

서비스별 오류 코드를 정의하는 언어 독립적, 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
message

string

사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.