次の方法で共有

Items - Update GraphQLApi Definition

サービス:
GraphQLApi
API バージョン:
v1

指定した .

この API は、実行時間の長い操作 (LRO)をサポートします。

GraphQLApi の定義を更新しても、その秘密度ラベルには影響しません。

権限

呼び出し元には、GraphQLApi の 読み取りと書き込みの アクセス許可が必要です。

必要な委任されたスコープ

GraphQLApi.ReadWrite.All または Item.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

アイデンティティ 支援
ユーザー イエス
サービス プリンシパルとマネージド ID はい (SQL 分析エンドポイントを使用した定義ペイロードを除く)

インターフェイス

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition
省略可能なパラメーターを含む: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/GraphQLApis/{GraphQLApiId}/updateDefinition?updateMetadata={updateMetadata}

URI パラメーター

名前 / 必須 型 説明
GraphQLApiId
 path True

string (uuid)

GraphQLApi ID。
workspaceId
 path True

string (uuid)

ワークスペース ID。
updateMetadata
 query

boolean

true に設定され、.platform ファイルが定義の一部として提供されると、.platform ファイル内のメタデータを使用して項目のメタデータが更新されます。

要求本文

名前 必須 型 説明
definition True

GraphQLApiPublicDefinition

GraphQL パブリック定義オブジェクトの API。 定義を作成するには、 GraphQLApi 定義を参照してください。

応答

名前 型 説明
200 OK

要求は正常に完了しました。
202 Accepted

要求は受け入れ済み。 更新の定義が進行中です。

ヘッダー

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

一般的なエラー コード:

  • OperationNotSupportedForItem - 要求された項目に対する操作はサポートされていません。

  • CorruptedPayload - 指定されたペイロードが破損しています。

例

Update a GraphQLApi public definition example

要求のサンプル

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphQLApis/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "ew0KICAiZXhlY3V0YW..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

応答のサンプル

状態コード:
200
状態コード:
202 
Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

定義

名前 説明
ErrorRelatedResource

エラー関連のリソース詳細オブジェクト。
ErrorResponse

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
GraphQLApiPublicDefinition

GraphQL パブリック定義オブジェクトの API。 定義を作成するには、 GraphQLApi 定義を参照してください。
GraphQLApiPublicDefinitionPart

GraphQL 定義パーツ オブジェクトの API。
PayloadType

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。
UpdateGraphQLApiDefinitionRequest

GraphQL パブリック定義要求ペイロードの API を更新します。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

GraphQLApiPublicDefinition

Object

GraphQL パブリック定義オブジェクトの API。 定義を作成するには、 GraphQLApi 定義を参照してください。

名前 型 説明
format

string

項目定義の形式。
parts

GraphQLApiPublicDefinitionPart[]

定義パーツの一覧。

GraphQLApiPublicDefinitionPart

Object

GraphQL 定義パーツ オブジェクトの API。

名前 型 説明
path

string

GraphQL 定義パーツのパスの API。
payload

string

GraphQL 定義パーツペイロードの API。
payloadType

PayloadType

ペイロードの種類。

PayloadType

列挙

定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。

値 説明
InlineBase64

インライン ベース 64。

UpdateGraphQLApiDefinitionRequest

Object

GraphQL パブリック定義要求ペイロードの API を更新します。

名前 型 説明
definition

GraphQLApiPublicDefinition

GraphQL パブリック定義オブジェクトの API。 定義を作成するには、 GraphQLApi 定義を参照してください。