Git - List Workspace Relations

Palvelu:: Core

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyn työtilan työtilasuhteiden luettelon.

Note

Tämä ohjelmointirajapinta on osa esikatseluversiota, ja se on saatavilla vain arviointi- ja kehitystarkoituksiin. Muutos saattaa perustua palautteeseen, eikä sitä suositella tuotantokäyttöön.

Tämä ohjelmointirajapinta tukee sivutuksen.

Permissions

Kutsujalla on oltava katselijan tai korkeamman työtilan rooli.

Vaaditut delegoidut vaikutusalueet

Workspace.Read.All tai Workspace.ReadWrite.All

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Käyttäjätiedot	Tuki
User	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Liittymä

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

Valinnaisilla parametreilla:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/git/workspaceRelations?continuationToken={continuationToken}

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
workspaceId	path	True	string (uuid)	Työtilan tunnus.
continuationToken	query		string	Tunnus seuraavan tulossivun noutamiseen.

Vastaukset

Nimi Tyyppi Kuvaus

200 OK

Nimi	Tyyppi	Kuvaus
200 OK	WorkspaceRelations	Pyynnön valmistuttua.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InsufficientPrivileges – Soittajalla ei ole riittäviä työtilan käyttöoikeuksia. WorkspaceNotFound – Määritettyä työtilaa ei löytynyt.

WorkspaceRelations

Pyynnön valmistuttua.

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

InsufficientPrivileges – Soittajalla ei ole riittäviä työtilan käyttöoikeuksia.
WorkspaceNotFound – Määritettyä työtilaa ei löytynyt.

Esimerkit

List workspace relations example

Mallipyyntö

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/66666666-6666-6666-6666-666666666666/git/workspaceRelations

Mallivastaus

Tilakoodi:: 200

{
  "value": [
    {
      "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "88888888-8888-8888-8888-888888888888",
      "relationType": "Base"
    },
    {
      "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "22222222-2222-2222-2222-222222222222",
      "relationType": "RelatedWorkspace"
    },
    {
      "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "workspaceId": "66666666-6666-6666-6666-666666666666",
      "relatedWorkspaceId": "44444444-4444-4444-4444-444444444444",
      "relationType": "RelatedWorkspace"
    }
  ]
}

Määritelmät

Nimi	Kuvaus
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
WorkspaceRelation	Työtilan relaatio-objekti.
WorkspaceRelations	Luettelo työtilasuhteista.
WorkspaceRelationType	Liittyvän työtilan tyyppi suhteessa. Muita aiheeseen liittyviä työtilatyyppejä voidaan lisätä ajan kuluessa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

WorkspaceRelation

Kohde

Työtilan relaatio-objekti.

Nimi	Tyyppi	Kuvaus
id	string (uuid)	Työtilan suhteen tunnus.
relatedWorkspaceId	string (uuid)	Liittyvä työtilan tunnus.
relationType	WorkspaceRelationType	Liittyvän työtilan tyyppi suhteessa.
workspaceId	string (uuid)	Työtilan tunnus.

WorkspaceRelations

Kohde

Luettelo työtilasuhteista.

Nimi	Tyyppi	Kuvaus
continuationToken	string	Seuraavan tulosjoukkoerän tunnus. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
continuationUri	string	Seuraavan tulosjoukkoerän URI. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
value	WorkspaceRelation[]	Luettelo työtilasuhteista.

WorkspaceRelationType

Luettelointi

Liittyvän työtilan tyyppi suhteessa. Muita aiheeseen liittyviä työtilatyyppejä voidaan lisätä ajan kuluessa.

Arvo	Kuvaus
Base	Liittyvä työtila on perustyötila (lähde).
Branch	Liittyvä työtila on haaratyötila.
RelatedWorkspace	Liittyvällä työtilalla on yleinen suhde.