Jaa

Workspaces - List Workspaces

Palvelu:
Core
Ohjelmointirajapinnan versio:
v1

Palauttaa luettelon työtiloista, joita päänimi voi käyttää. Roolikyselyparametrin avulla voit suodattaa tulokset työtilan pääroolin mukaan.
Tämä ohjelmointirajapinta tukee sivutuksen.

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.

Identity Support
User Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kyllä

Interface

GET https://api.fabric.microsoft.com/v1/workspaces
Valinnaisilla parametreilla: 
GET https://api.fabric.microsoft.com/v1/workspaces?roles={roles}&continuationToken={continuationToken}&preferWorkspaceSpecificEndpoints={preferWorkspaceSpecificEndpoints}

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Description
continuationToken
 query

string

Tunnus seuraavan tulossivun noutamiseen.
preferWorkspaceSpecificEndpoints
 query

boolean

Asetus, joka määrittää, sisällytetäänkö työtilakohtainen ohjelmointirajapinnan päätepiste kullekin työtilalle. True – Sisällytä työtilakohtainen ohjelmointirajapinnan päätepiste, False – Älä sisällytä työtilaan kohtaista ohjelmointirajapinnan päätepistettä.
roles
 query

string

Roolien luettelo. Erota arvot käyttämällä pilkkua. Jos tätä ei anneta, kaikki työtilat palautetaan.

Vastaukset

Nimi Tyyppi Description
200 OK

Workspaces

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:

  • InvalidParameter – Työtilan rooli on virheellinen.

  • UnknownError – Ilmeni virhe.

Esimerkit

List workspaces example
List workspaces with continuation example
List workspaces with preferWorkspaceSpecificEndpoints example
List workspaces with roles filter example

List workspaces example

Mallipyyntö

GET https://api.fabric.microsoft.com/v1/workspaces

Mallivastaus

Tilakoodi:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd",
      "domainId": "7c889f28-999b-4945-840d-54da3e3b5a29"
    }
  ]
}

List workspaces with continuation example

Mallipyyntö

GET https://api.fabric.microsoft.com/v1/workspaces

Mallivastaus

Tilakoodi:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "My workspace",
      "description": "",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Marketing",
      "description": "A  workspace used by the marketing team",
      "type": "Workspace"
    },
    {
      "id": "f2d70dc6-8f3e-4f2c-b00e-e2d336d7d711",
      "displayName": "Finance",
      "description": "A workspace used by the finance team",
      "type": "Workspace",
      "capacityId": "171018af-1531-4e61-942a-74f024b7f9fd"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces?continuationToken=LDEsMTAwMDAwLDA%3D"
}

List workspaces with preferWorkspaceSpecificEndpoints example

Mallipyyntö

GET https://api.fabric.microsoft.com/v1/workspaces?preferWorkspaceSpecificEndpoints=True

Mallivastaus

Tilakoodi:
200 
{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Alice's Workspace",
      "description": "A workspace for Alice",
      "type": "Workspace",
      "apiEndpoint": "https://cfafbeb180374d0c896ea46fb27ff227.zcf.w.api.fabric.microsoft.com"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Bob's Workspace",
      "description": "A workspace for Bob",
      "type": "Workspace",
      "apiEndpoint": "https://0c02a0cd71bc410faa055a7bc98765f7.z0c.w.api.fabric.microsoft.com"
    }
  ]
}

List workspaces with roles filter example

Mallipyyntö

GET https://api.fabric.microsoft.com/v1/workspaces?roles=Admin,Member,Contributor,Viewer

Mallivastaus

Tilakoodi:
200 
{
  "value": [
    {
      "id": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "displayName": "Admins workspace",
      "description": "A workspace for admins",
      "type": "Personal"
    },
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff227",
      "displayName": "Members workspace",
      "description": "A workspace for members",
      "type": "Workspace"
    },
    {
      "id": "0c02a0cd-71bc-410f-aa05-5a7bc98765f7",
      "displayName": "Contributors workspace",
      "description": "A workspace for contributors",
      "type": "Workspace"
    },
    {
      "id": "99d58687-8903-4dbd-8a78-40f95dca7177",
      "displayName": "Viewers workspace",
      "description": "A workspace for viewers",
      "type": "Workspace"
    }
  ]
}

Määritelmät

Nimi Description
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
Workspace

Työtilan objekti.
WorkspaceAppliedTag

Edustaa käytössä olevaa tunnistetta.
Workspaces
WorkspaceType

Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi Tyyppi Description
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ä.
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 Description
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.

Workspace

Kohde

Työtilan objekti.

Nimi Tyyppi Description
apiEndpoint

string (uri)

HTTP-URL-osoite, joka edustaa työtilalle määritettyä ohjelmointirajapinnan päätepistettä. Tämä päätepistearvo palautetaan, kun käyttäjä ottaa käyttöön preferWorkspaceSpecificEndpoints-asetuksen. Se mahdollistaa ohjelmointirajapinnan käytön yksityisten linkkien kautta.
capacityId

string (uuid)

Sen kapasiteetin tunnus, jolle työtila on määritetty.
description

string

Työtilan kuvaus.
displayName

string

Työtilan näyttönimi.
domainId

string (uuid)

Sen toimialueen tunnus, jolle työtila on määritetty.
id

string (uuid)

Työtilan tunnus.
tags

WorkspaceAppliedTag[]

Luettelo käytössä olevista tunnisteista.
type

WorkspaceType

Työtilan tyyppi.

WorkspaceAppliedTag

Kohde

Edustaa käytössä olevaa tunnistetta.

Nimi Tyyppi Description
displayName

string

Tunnisteen nimi.
id

string (uuid)

Tunnisteen tunnus.

Workspaces

Kohde
Nimi Tyyppi Description
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

Workspace[]

Luettelo työtiloista.

WorkspaceType

Luettelointi

Työtilatyyppi. Lisää työtilatyyppejä voidaan lisätä ajan kuluessa.

Arvo Description
Personal

Oma kansio tai Oma työtila, jota käytetään käyttäjäkohteiden hallintaan.
Workspace

Fabric-kohteiden hallintaan käytetty työtila.
AdminWorkspace

Järjestelmänvalvojan valvontatyötila. Sisältää järjestelmänvalvojan raportit, kuten valvontaraportin sekä käyttö- ja käyttöönottoraportin.