Git - Get Status

Service:
Core
API-versie:
v1

Retourneert de Git status van items in de werkruimte, die kunnen worden doorgevoerd in Git.
Deze API ondersteunt langlopende bewerkingen (LRO).

De status geeft wijzigingen in items aan sinds de laatste werkruimte en externe vertakkingssynchronisatie. Als de externe en werkruimte-items beide zijn gewijzigd, markeert de API een conflict. De API mag niet worden aangeroepen tijdens het uitvoeren van een Update from Git-bewerking .

Als u deze API wilt gebruiken, moeten de Git-referenties van de aanroeper worden geconfigureerd met de API Mijn Git-referenties bijwerken . U kunt de API Mijn Git-referenties ophalen gebruiken om de configuratie van git-referenties te controleren.

Permissions

De aanroeper moet een inzender hebben of een hogere werkruimterol.

Vereiste gedelegeerde bereiken

Workspace.GitUpdate.All of Workspace.GitCommit.All

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Yes
serviceprincipal en beheerde identiteiten Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status
Met optionele parameters: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status?includeFilesDetails={includeFilesDetails}

URI-parameters

Naam In Vereist Type Description
workspaceId
 path True

string (uuid)

De werkruimte-id.
includeFilesDetails
 query

boolean

Wanneer waar, bevat elk item in het antwoord een fileChanges-matrix met wijzigingsgegevens per bestand.

Antwoorden

Naam Type Description
200 OK

GitStatusResponse

De aanvraag is voltooid.
202 Accepted

Aanvraag geaccepteerd, status wordt uitgevoerd.

Kopteksten

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden.

Kopteksten

Retry-After: integer
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • WorkspaceNotConnectedToGit - Werkruimte is niet verbonden met Git.

  • WorkspaceHasNoCapacityAssigned - Werkruimte heeft geen capaciteit.

  • InsufficientPrivileges : de aanroeper beschikt niet over voldoende werkruimtemachtigingen.

  • PrincipalTypeNotSupported - Identiteitstype beller wordt niet ondersteund.

Voorbeelden

Get status example
Get status no changes example
Get status with conflict example
Get status with file details example

Get status example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status

Voorbeeldrespons

Statuscode:
200 
{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "changes": [
    {
      "itemMetadata": {
        "itemIdentifier": {
          "objectId": "7753f3b4-dbb8-44c1-a94f-6ae4d776369e"
        },
        "itemType": "SemanticModel",
        "displayName": "My new dataset in the workspace"
      },
      "workspaceChange": "Added",
      "conflictType": "None"
    },
    {
      "itemMetadata": {
        "itemIdentifier": {
          "logicalId": "1423f3b4-dba5-44c1-a94f-6ae4d776369a"
        },
        "itemType": "Report",
        "displayName": "My deleted report in Git"
      },
      "remoteChange": "Deleted",
      "conflictType": "None"
    },
    {
      "itemMetadata": {
        "itemIdentifier": {
          "logicalId": "111e8d7b-4a95-4c02-8ccd-6faef5ba1bd1",
          "objectId": "1153f3b4-dbb8-33c1-a84f-6ae4d776362d"
        },
        "itemType": "SemanticModel",
        "displayName": "Modified dataset in the workspace"
      },
      "workspaceChange": "Modified",
      "conflictType": "None"
    }
  ]
}
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get status no changes example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status

Voorbeeldrespons

Statuscode:
200 
{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "changes": []
}
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get status with conflict example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status

Voorbeeldrespons

Statuscode:
200 
{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "changes": [
    {
      "itemMetadata": {
        "itemIdentifier": {
          "logicalId": "222e8d7b-4a95-4c02-8ccd-6faef5ba1bd2",
          "objectId": "8853f3b4-dbb8-33c1-a84f-6ae4d776362a"
        },
        "itemType": "Report",
        "displayName": "Modified report on both sides"
      },
      "remoteChange": "Modified",
      "workspaceChange": "Modified",
      "conflictType": "Conflict"
    }
  ]
}
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get status with file details example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/workspaces/1455b6a2-c120-4c1c-dda7-92bafe99bec3/git/status?includeFilesDetails=True

Voorbeeldrespons

Statuscode:
200 
{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "7d03b2918bf6aa62f96d0a4307293f3853201705",
  "changes": [
    {
      "itemMetadata": {
        "itemIdentifier": {
          "objectId": "cfafbeb1-8037-4d0c-896e-28c4f2e65573"
        },
        "itemType": "Notebook",
        "displayName": "MyNotebook"
      },
      "workspaceChange": "Modified",
      "remoteChange": "Modified",
      "conflictType": "Conflict",
      "fileChanges": [
        {
          "path": "notebook-content.py",
          "workspaceChange": "Modified",
          "remoteChange": "Modified",
          "conflictType": "Conflict"
        },
        {
          "path": "metadata.json",
          "workspaceChange": "Modified",
          "conflictType": "None"
        },
        {
          "path": "config/settings.json",
          "remoteChange": "Added",
          "conflictType": "None"
        }
      ]
    },
    {
      "itemMetadata": {
        "itemIdentifier": {
          "objectId": "d5a2b3c4-1234-5678-abcd-ef0123456789"
        },
        "itemType": "Report",
        "displayName": "SalesReport"
      },
      "workspaceChange": "Modified",
      "conflictType": "None",
      "fileChanges": [
        {
          "path": "pages/page1.json",
          "workspaceChange": "Modified",
          "conflictType": "None"
        }
      ]
    }
  ]
}
Statuscode:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Definities

Naam Description
ChangeType

Een wijziging van een item. Er kunnen in de loop van de tijd extra gewijzigde typen worden toegevoegd.
ConflictType

Een wijziging van een item in zowel werkruimte als extern. Er kunnen in de loop van de tijd extra gewijzigde typen worden toegevoegd.
ErrorParameter

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.
GitFileChange

Bevat informatie over een wijziging op bestandsniveau binnen een item.
GitStatusResponse

Bevat het statusantwoord.
ItemChange

Bevat de wijzigingsgegevens van het item.
ItemIdentifier

Bevat de item-id. Ten minste één van de eigenschappen moet worden gedefinieerd.
ItemMetadata

Bevat de metagegevens van het item.
ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

ChangeType

Opsomming

Een wijziging van een item. Er kunnen in de loop van de tijd extra gewijzigde typen worden toegevoegd.

Waarde Description
Added

Een nieuw gemaakt item.
Deleted

Item is verwijderd.
Modified

Iteminhoud is gewijzigd.

ConflictType

Opsomming

Een wijziging van een item in zowel werkruimte als extern. Er kunnen in de loop van de tijd extra gewijzigde typen worden toegevoegd.

Waarde Description
None

Er zijn geen wijzigingen in het item.
Conflict

Er zijn verschillende wijzigingen in het item in de werkruimte en in externe Git.
SameChanges

Er zijn identieke wijzigingen in het item in de werkruimte en in externe Git.

ErrorParameter

Object

Een gestructureerde parameter die extra machineleesbare context biedt over een fout.

Naam Type Description
message

string

Een door mensen leesbare beschrijving van de betekenis van de parameter.
name

string

De parameter-id.
value

string

De waarde van de parameter.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Naam Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Naam Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
isRetriable

boolean

Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
parameters

ErrorParameter[]

Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string (uuid)

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Naam Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
parameters

ErrorParameter[]

Gestructureerde parameters die extra machineleesbare context bieden over de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

GitFileChange

Object

Bevat informatie over een wijziging op bestandsniveau binnen een item.

Naam Type Description
conflictType

ConflictType

De conflictstatus voor dit bestand.
path

string

Het bestandspad ten opzichte van de hoofdmap van het item. Het maakt gebruik van slashes en heeft geen voorloopslash.
remoteChange

ChangeType

Wijzigen aan de externe Git-zijde.
workspaceChange

ChangeType

Wijzigen aan de werkruimtezijde.

GitStatusResponse

Object

Bevat het statusantwoord.

Naam Type Description
changes

ItemChange[]

Een lijst met wijzigingen in externe Git die niet worden toegepast op de opgegeven werkruimte en wijzigingen in de werkruimte die niet worden toegepast op externe Git.
remoteCommitHash

string

Externe volledige SHA-doorvoerhash.
workspaceHead

string

Volledige SHA-hash waarmee de werkruimte wordt gesynchroniseerd.

ItemChange

Object

Bevat de wijzigingsgegevens van het item.

Naam Type Description
conflictType

ConflictType

Wanneer er wijzigingen zijn aan zowel de werkruimtezijde als de externe Git-zijde.
fileChanges

GitFileChange[]

Een lijst met wijzigingen op bestandsniveau binnen het item. Alleen ingevuld wanneer de queryparameter includeFilesDetails is ingesteld op true.
itemMetadata

ItemMetadata

De metagegevens van het item.
remoteChange

ChangeType

Wijzigen aan de externe Git-zijde.
workspaceChange

ChangeType

Wijzigen aan de werkruimtezijde.

ItemIdentifier

Object

Bevat de item-id. Ten minste één van de eigenschappen moet worden gedefinieerd.

Naam Type Description
logicalId

string (uuid)

De logische id van het item. Wanneer de logische id niet beschikbaar is omdat het item nog niet is toegevoegd aan de werkruimte, kunt u de object-id gebruiken.
objectId

string (uuid)

De object-id van het item. Wanneer de object-id niet beschikbaar is omdat het item is verwijderd uit de werkruimte, kunt u de logische id gebruiken.

ItemMetadata

Object

Bevat de metagegevens van het item.

Naam Type Description
displayName

string

De weergavenaam van het item. Geeft de voorkeur aan de weergavenaam van het werkruimte-item als het bestaat, anders gebruikt displayName de weergavenaam van het externe item.
itemIdentifier

ItemIdentifier

De item-id.
itemType

ItemType

Het itemtype.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.
Report

PowerBI-rapport.
SemanticModel

Semantisch Power BI-model.
PaginatedReport

Gepagineerd Power BI-rapport.
Datamart

PowerBI-datamart.
Lakehouse

Een lakehouse.
Eventhouse

Een eventhouse.
Environment

Een omgeving.
KQLDatabase

Een KQL-database.
KQLQueryset

Een KQL-queryset.
KQLDashboard

Een KQL-dashboard.
DataPipeline

Een gegevenspijplijn.
Notebook

Een notitieblok.
SparkJobDefinition

Een Spark-taakdefinitie.
MLExperiment

Een machine learning-experiment.
MLModel

Een machine learning-model.
Warehouse

Een magazijn.
Eventstream

Een eventstream.
SQLEndpoint

Een SQL-eindpunt.
MirroredWarehouse

Een gespiegeld magazijn.
MirroredDatabase

Een gespiegelde database.
Reflex

Een reflex.
GraphQLApi

Een API voor GraphQL-item.
MountedDataFactory

Een MountedDataFactory.
SQLDatabase

Een SQLDatabase.
CopyJob

Een kopieertaak.
VariableLibrary

Een VariableLibrary.
Dataflow

Een gegevensstroom.
ApacheAirflowJob

Een ApacheAirflowJob.
WarehouseSnapshot

Een momentopname van een magazijn.
DigitalTwinBuilder

Een DigitalTwinBuilder.
DigitalTwinBuilderFlow

Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Een gespiegelde Azure Databricks-catalogus.
Map

Een kaart.
AnomalyDetector

Een Anomaly Detector.
UserDataFunction

Een gebruikersgegevensfunctie.
GraphModel

Een GraphModel.
GraphQuerySet

Een Graph QuerySet.
SnowflakeDatabase

Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent

Een OperationsAgent.
CosmosDBDatabase

Een Cosmos DB-database.
Ontology

Een Ontologie.
EventSchemaSet

Een EventSchemaSet.
DataAgent

Een DataAgent.
MirroredCatalog

Een mirroredCatalog.
PolicySet

Een beleidsset.
AppBackend

Een AppBackend.
OrgApp

Een organisatie-app.
OrgAppAudience

Een organisatie-app-doelgroep.
DataBuildToolJob

Een DataBuildToolJob.
AzureDatabricksStorage

Een door OneLake ondersteund opslagitem voor Azure Databricks.
Plan

Een plan.