주요 내용으로 건너뛰기

Cognite OData 서비스

Cognite는 Microsoft Power BI, Microsoft Excel, TIBCO Spotfire와 같은 OData 클라이언트를 사용하여 Cognite Data Fusion(CDF)에서 데이터를 가져올 수 있는 OData 서비스를 제공합니다.

Open Data Protocol (OData)은 RESTful API 구축 및 사용을 위한 모범 사례를 정의하는 개방형 표준입니다. OData는 다음을 제공합니다.

  • 표준화된 쿼리 구문: 다양한 데이터 원본에서 일관된 필터링, 정렬, 페이지 매김 및 예측을 지원합니다.

  • 메타데이터 지원: 클라이언트는 메타데이터 문서를 통해 데이터 구조와 유형을 검색할 수 있습니다.

  • 상호 운용성: HTTP를 지원하고 OData를 이해하는 모든 클라이언트는 OData 서비스를 사용할 수 있습니다.

Cognite는 asset-centric OData 서비스와 데이터 모델링 OData 서비스를 제공합니다. 두 서비스 모두 표준 Cognite API를 래핑하여 읽기 전용으로 OData Version 4 API를 구현합니다. 이 서비스들은 OData 요청을 해당하는 Cognite API 호출로 변환하여 OData 호환 클라이언트 및 도구를 통해 CDF 데이터와 상호 작용할 수 있도록 지원합니다.

OData 서비스 사용​

Cognite OData 서비스와 상호 작용하려면 특정 엔드포인트에 HTTP GET 요청을 합니다.

인증​

OData 서비스로 인증하려면 HTTP 요청의 인증 헤더에 전달자 토큰을 포함해야 합니다.

다음 예를 참조하십시오.

Authorization: Bearer {YourAccessToken}

설정에 적합한 인증 흐름(예: OAuth 2.0, OpenID Connect)을 사용하여 액세스 토큰을 얻을 수 있습니다. 자세한 내용은 인증 설명서를 참조하십시오.

요청 수행​

GET 요청 예​

프로젝트에서 자산을 검색하려면 다음과 같이 하십시오.

GET https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}/Assets

조건:

  • {cluster}: CDF 클러스터 이름입니다(예: westeurope-1).
  • {apiVersion}: OData 서비스 API 버전입니다(예: v1).
  • {project}: CDF 프로젝트 이름입니다.
쿼리 매개 변수​

쿼리 매개 변수를 사용하여 데이터 필터링, 정렬, 선택 및 페이지 매김을 수행합니다.

  • 필터링 - $filter 쿼리 매개 변수를 사용하여 데이터를 필터링합니다.

    예: Name이 'Pump 1'인 자산 검색: GET .../Assets?$filter=Name eq 'Pump 1'

  • 필드 선택- $select 쿼리 매개 변수를 사용하여 특정 필드를 검색합니다.

    예: 자산의 Id 및 Name만 검색: GET .../Assets?$select=Id,Name

  • 정렬 - $orderby 쿼리 매개 변수를 사용하여 결과를 정렬합니다.

    예: Name 기준 오름차순으로 자산 정렬: GET .../Assets?$orderby=Name asc

  • 관련 엔터티 확장 - $expand 쿼리 매개 변수를 사용하여 관련 엔터티를 포함합니다. 예: 자산을 상위와 함께 검색: GET .../Assets(702630644612)/Parent?$expand=Parent

    참고: 모든 엔터티와 관계가 확장을 지원하는 것은 아닙니다. 자세한 내용은 개별 서비스 설명서를 참조하십시오.

  • *쿼리 매개 변수 결합 - 여러 쿼리 매개 변수를 결합하여 요청을 구체화할 수 있습니다.

    예: Name이 'Pump'로 시작하는 자산의 Id 및 Name을 검색하여 Name 기준으로 정렬하고 처음 10개 결과를 검색: GET .../Assets?$filter=startswith(Name,'Pump')&$select=Id,Name&$orderby=Name asc&$top=10

응답 형식​

OData 서비스는 OData V4 표준에 따라 JSON 형식으로 응답을 반환합니다.

응답 예:

{
  "@odata.context": "https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}/$metadata#Assets/",
  "value": [
    {
      "Id": "12345",
      "DataSetId": null,
      "ExternalId": "WMT:VAL",
      "Name": "Pump 1",
      "Description": "Main pump"
      // other properties
    }
  ]
}
응답 페이지 매김​

OData 서비스는 대규모 결과 집합에 대해 응답을 페이지 매김할 수 있습니다. 응답에는 결과의 다음 페이지를 검색할 수 있는 URL이 있는 @odata.nextLink 속성이 포함됩니다.

예:

{
  "@odata.context": "https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}/$metadata#Assets",
  "value": [ // records ],
  "@odata.nextLink": "https://{cluster}.cognitedata.com/odata/{apiVersion}/projects/{project}/Assets?$skipToken=123"
}

제한 사항 및 지원되는 기능​

OData 서비스는 OData V4 표준 준수를 목표로 하지만, Cognite API의 기본적인 제약 조건으로 인해 일부 기능이 제한되거나 지원되지 않을 수 있습니다.

지원되는 기능 및 제한 사항에 대한 자세한 내용은 개별 서비스 설명서를 참조하십시오.

마지막으로 업데이트