แก้ไข

แชร์ผ่าน

GraphQLApi definition

  • บทความ

This article provides a breakdown of the definition structure for GraphQLApi items.

Note

GraphQLApi is also known as API for GraphQL.

Supported formats

GraphQLApi items support the json format.

Definition parts

The definition of an GraphQLApi item is made out of a single part, and is constructed as follows:

Example of payload content decoded from Base64

  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/graphqlApi/definition/1.0.0/schema.json",
  "datasources": [
    {
      "artifactType": "SqlDbNative",
      "objects": [
        {
          "actions": {
            "Query": "Enabled",
            "Query_by_pk": "Enabled",
            "Create": "Enabled",
            "Update": "Enabled",
            "Delete": "Enabled"
          },
          "fieldMappings": {
            "AuthorID": "AuthorID",
            "FirstName": "FirstName",
            "LastName": "LastName"
          },
          "graphqlType": "Authors",
          "relationships": [],
          "sourceObject": "dbo.Authors",
          "sourceObjectType": "Table"
        }
      ],
      "sourceArtifactId": "2c66ff1a-1e0b-494a-9eaa-089b2f8590d0",
      "sourceWorkspaceId": "fdea524a-75eb-4321-af1d-f83d5ec61176"
    }
  ]
}

Definition example

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