Item Lifecycle - Create Item

서비스:

Workload Development

API 버전:

v1

새 항목을 만들기 위해 Microsoft Fabric에서 호출합니다.
항목을 만들 때 Fabric은 기본 유효성 검사를 수행하고, 프로비전 상태로 항목을 만들고, 이 API를 호출하여 워크로드에 알립니다. 워크로드는 필수 유효성 검사를 수행하고, 항목 메타데이터를 저장하고, 필요한 리소스를 할당하고, 항목 관계 및 ETag를 사용하여 패브릭 항목 메타데이터 캐시를 업데이트해야 합니다.

이 API는 SubjectAndApp 인증을 수락해야 합니다.

권한을

사용 권한은 Microsoft Fabric에서 확인합니다.

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
itemId	path	True	string (uuid)	항목 ID입니다.
itemType	path	True	string	항목 유형입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.

요청 헤더

Name	필수	형식	Description
ActivityId	True	string	사용자가 워크로드와 상호 작용할 때 요청과 시스템의 상관 관계를 지정하기 위한 고유 ID입니다.
RequestId	True	string	패브릭이 요청을 로그와 상호 연결하는 데 도움이 되는 전역적으로 고유한 ID입니다. 문제를 보고할 때 이 ID를 제공합니다.
Authorization	True	string	워크로드가 요청 원본의 유효성을 검사하고, 사용자 컨텍스트를 제공하고, 다른 서비스를 호출할 수 있도록 하는 이중 토큰 권한 부여 헤더입니다. 이 헤더의 형식은 SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	요청을 만드는 클라이언트의 테넌트 ID입니다.

요청 본문

Name	필수	형식	Description
displayName	True	string maxLength: 256	항목 표시 이름입니다. 256자를 초과할 수 없습니다.
creationPayload		object	워크로드 및 항목 유형과 관련된 만들기 페이로드입니다. 항목 편집기 또는 패브릭 자동화 API 매개 변수로 전달됩니다.
description		string	항목 설명입니다.

응답

Name	형식	Description
200 OK		성공적으로 만들어졌습니다.
Other Status Codes	ErrorResponse	오류 조건의 경우 워크로드는 응답 본문에 자세한 오류 정보가 포함된 적절한 HTTP 오류 상태 코드(4xx, 5xx)를 반환해야 합니다.

예제

Create item example

샘플 요청

HTTP

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111

{
  "displayName": "Forecast 1",
  "description": "The 1st forecast item",
  "creationPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

샘플 응답

상태 코드:

200

정의

Name	Description
CreateItemRequest	항목 요청 콘텐츠를 만듭니다.
ErrorExtendedInformation	확장된 오류 정보입니다.
ErrorResponse	오류 응답입니다.
ErrorSource	오류의 소스입니다.
NameValuePair	이름-값 쌍입니다.

CreateItemRequest

Object

항목 요청 콘텐츠를 만듭니다.

Name	형식	Description
creationPayload	object	워크로드 및 항목 유형과 관련된 만들기 페이로드입니다. 항목 편집기 또는 패브릭 자동화 API 매개 변수로 전달됩니다.
description	string	항목 설명입니다.
displayName	string maxLength: 256	항목 표시 이름입니다. 256자를 초과할 수 없습니다.

ErrorExtendedInformation

Object

확장된 오류 정보입니다.

Name	형식	Description
additionalParameters	NameValuePair[]	오류와 관련된 추가 매개 변수 목록입니다.
errorCode	string	오류 코드입니다.
message	string	오류 메시지입니다.
messageParameters	string[]	지역화된 메시지의 서식을 지정하기 위한 매개 변수 목록입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 코드입니다.
isPermanent	boolean	오류가 영구적인지 아니면 작업을 다시 시도 할 수 있는지 여부를 나타냅니다.
message	string	오류 메시지입니다.
messageParameters	string[]	지역화된 메시지의 서식을 지정하기 위한 매개 변수 목록입니다.
moreDetails	ErrorExtendedInformation[]	추가 오류 세부 정보 목록입니다.
source	ErrorSource	오류 원본입니다.

ErrorSource

열거형

오류의 소스입니다.

값	Description
System
User
External

NameValuePair

Object

이름-값 쌍입니다.

Name	형식	Description
name	string	이름입니다.
value	string	값입니다.