Udostępnij za pośrednictwem

Git - Get Status

  • Odwołanie
Usługa:
Core
Wersja interfejsu API:
v1

Zwraca Git status elementów w obszarze roboczym, które mogą zostać zatwierdzone w usłudze Git.
Ten interfejs API obsługuje długotrwałych operacji (LRO).

Stan wskazuje zmiany elementów od czasu ostatniej synchronizacji obszaru roboczego i zdalnej gałęzi. Jeśli obie lokalizacje zostały zmodyfikowane, interfejs API flaguje konflikt.

Uprawnienia

Obiekt wywołujący musi mieć rolę współautora lub nowszego obszaru roboczego.

Wymagane zakresy delegowane

Workspace.GitUpdate.All lub Workspace.GitCommit.All

Tożsamości obsługiwane przez firmę Microsoft

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość Wsparcie
Użytkownik Tak
jednostki usługi i tożsamości zarządzanych Nie

Interfejs

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/status

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string

uuid

Identyfikator obszaru roboczego.

Odpowiedzi

Nazwa Typ Opis
200 OK

GitStatusResponse

Żądanie zostało ukończone pomyślnie.
202 Accepted

Żądanie zaakceptowane, uzyskiwanie stanu w toku.

Nagłówki

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

ErrorResponse

Typowe kody błędów:

  • WorkspaceNotConnectedToGit — obszar roboczy nie jest połączony z usługą git.

  • WorkspaceHasNoCapacityAssigned — obszar roboczy nie znajduje się w pojemności.

  • InsufficientPrivileges — obiekt wywołujący nie ma wystarczających uprawnień obszaru roboczego.

Przykłady

Get status example
Get status no changes example
Get status with conflict example

Get status example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
    }
  ]
}
Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "workspaceHead": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "remoteCommitHash": "eaa737b48cda41b37ffefac772ea48f6fed3eac4",
  "changes": []
}
Kod stanu:
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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
    }
  ]
}
Kod stanu:
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

Definicje

Nazwa Opis
ChangeType

Zmiana elementu. Dodatkowe zmienione typy mogą być dodawane wraz z upływem czasu.
ConflictType

Zmiana elementu w obszarze roboczym i zdalnym. Dodatkowe zmienione typy mogą być dodawane wraz z upływem czasu.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
GitStatusResponse

Zawiera odpowiedź stanu.
ItemChange

Zawiera informacje o zmianie elementu.
ItemIdentifier

Zawiera identyfikator elementu. Należy zdefiniować co najmniej jedną z właściwości.
ItemMetadata

Zawiera metadane elementu.
ItemType

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

ChangeType

Wyliczanie

Zmiana elementu. Dodatkowe zmienione typy mogą być dodawane wraz z upływem czasu.

Wartość Opis
Added

Nowo utworzony element.
Deleted

Element został usunięty.
Modified

Zawartość elementu została zmodyfikowana.

ConflictType

Wyliczanie

Zmiana elementu w obszarze roboczym i zdalnym. Dodatkowe zmienione typy mogą być dodawane wraz z upływem czasu.

Wartość Opis
Conflict

Istnieją różne zmiany w elemencie w obszarze roboczym i w zdalnym narzędziu Git.
None

Brak zmian w elemencie.
SameChanges

Istnieją identyczne zmiany elementu w obszarze roboczym i w zdalnym narzędziu Git.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.

GitStatusResponse

Objekt

Zawiera odpowiedź stanu.

Nazwa Typ Opis
changes

ItemChange[]

Lista zmian w zdalnym narzędziu Git, które nie są stosowane do danego obszaru roboczego, oraz zmiany w obszarze roboczym, które nie są stosowane do zdalnego usługi Git.
remoteCommitHash

string

Zdalny pełny skrót zatwierdzenia SHA.
workspaceHead

string

Pełny skrót SHA synchronizowany z obszarem roboczym.

ItemChange

Objekt

Zawiera informacje o zmianie elementu.

Nazwa Typ Opis
conflictType

ConflictType

Gdy po stronie obszaru roboczego i po stronie zdalnej usługi Git są wprowadzane zmiany.
itemMetadata

ItemMetadata

Metadane elementu.
remoteChange

ChangeType

Zmień po stronie zdalnej usługi Git.
workspaceChange

ChangeType

Zmień po stronie obszaru roboczego.

ItemIdentifier

Objekt

Zawiera identyfikator elementu. Należy zdefiniować co najmniej jedną z właściwości.

Nazwa Typ Opis
logicalId

string

uuid

Identyfikator logiczny elementu. Jeśli identyfikator logiczny jest niedostępny, ponieważ element nie został jeszcze dodany do obszaru roboczego, możesz użyć identyfikatora obiektu.
objectId

string

uuid

Identyfikator obiektu elementu. Jeśli identyfikator obiektu jest niedostępny, ponieważ element został usunięty z obszaru roboczego, możesz użyć identyfikatora logicznego.

ItemMetadata

Objekt

Zawiera metadane elementu.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana elementu. Preferuje nazwę wyświetlaną elementu obszaru roboczego, jeśli istnieje, w przeciwnym razie displayName używa nazwy wyświetlanej elementu zdalnego.
itemIdentifier

ItemIdentifier

Identyfikator elementu.
itemType

ItemType

Typ elementu.

ItemType

Wyliczanie

Typ elementu. Dodatkowe typy elementów można dodawać w czasie.

Wartość Opis
Dashboard

Pulpit nawigacyjny usługi Power BI.
DataPipeline

Potok danych.
Datamart

Datamart usługi Power BI.
Environment

Środowisko.
Eventhouse

Magazyn zdarzeń.
Eventstream

Strumień zdarzeń.
GraphQLApi

Interfejs API dla elementu GraphQL.
KQLDashboard

Pulpit nawigacyjny KQL.
KQLDatabase

Baza danych KQL.
KQLQueryset

Zestaw zapytań KQL.
Lakehouse

Jezioro.
MLExperiment

Eksperyment uczenia maszynowego.
MLModel

Model uczenia maszynowego.
MirroredDatabase

Dublowana baza danych.
MirroredWarehouse

Dublowany magazyn.
MountedDataFactory

A MountedDataFactory.
Notebook

Notes.
PaginatedReport

Raport podzielony na strony usługi PowerBI.
Reflex

Refleks.
Report

Raport usługi Power BI.
SQLDatabase

Baza danych SQLDatabase.
SQLEndpoint

Punkt końcowy SQL.
SemanticModel

Model semantyczny usługi PowerBI.
SparkJobDefinition

Definicja zadania platformy Spark.
Warehouse

Magazyn.