Workspaces - List Workspaces

Tjeneste:

Admin

API-versjon:

v1

Returnerer en liste over arbeidsområder.

Note

Denne API-en er en del av en forhåndsversjon, og er bare tilgjengelig for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk.

Denne API-en støtter paginering. Maksimalt 10 000 poster kan returneres per forespørsel. Med det kontinuerlige tokenet som er angitt i svaret, kan du få de neste 10 000 postene.

Permissions

Innringeren må være en Fabric-administrator eller godkjenne ved hjelp av en tjenestekontohaver.

Nødvendige delegerte omfang

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 200 forespørsler per time.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identity	Support
User	Yes
tjenestekontohaver og administrerte identiteter	Yes

Interface

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

Med valgfrie parametere:

GET https://api.fabric.microsoft.com/v1/admin/workspaces?type={type}&capacityId={capacityId}&name={name}&state={state}&continuationToken={continuationToken}

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
capacityId	query		string (uuid)	Kapasitets-ID-en for arbeidsområdet.
continuationToken	query		string	Fortsettelsestoken. Brukes til å hente de neste elementene i listen.
name	query		string	Navnet på arbeidsområdet.
state	query		string	Arbeidsområdetilstanden. Støttede tilstander er aktive og slettet.
type	query		string	Arbeidsområdetypen. Støttede typer er personlige, arbeidsområder, administrasjonsområder.

Svar

Navn	Type	Beskrivelse
200 OK	Workspaces	Operasjonen var vellykket.
Other Status Codes	ErrorResponse	Vanlige feilkoder: BadRequest – spørringsparametere som workspaceType eller workspaceState ikke er gyldige. InsufficientPrivileges – Innringeren har ikke tillatelse til å kalle API-en.

Eksempler

Get a list of workspaces example

Get a list of workspaces using state query parameter example

Get a list of workspaces example

Eksempelforespørsel

HTTP

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

Eksempelsvar

Statuskode:

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84",
      "domainId": "039bd896-b39c-4540-93e3-e9926de135f9"
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces?continuationToken='LDEsMTAwMDAwLDA%3D'",
  "continuationToken": "LDEsMTAwMDAwLDA%3D"
}

Get a list of workspaces using state query parameter example

Eksempelforespørsel

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces?state=Active

Eksempelsvar

Statuskode:

200

{
  "workspaces": [
    {
      "id": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87",
      "name": "test report",
      "type": "Workspace",
      "state": "Active",
      "capacityId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e84"
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
Workspace	Workspace.
Workspaces	En liste over arbeidsområder.
WorkspaceState	Arbeidsområdetilstanden. Flere arbeidsområdetilstander kan legges til over tid.
WorkspaceType	En arbeidsområdetype. Flere arbeidsområdetyper kan legges til over tid.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

Workspace

Object

Workspace.

Navn	Type	Beskrivelse
capacityId	string (uuid)	Kapasitets-ID-en for arbeidsområdet.
domainId	string (uuid)	Domene-ID-en for arbeidsområdet.
id	string (uuid)	Arbeidsområde-ID-en.
name	string	Navnet på arbeidsområdet.
state	WorkspaceState	Arbeidsområdetilstanden.
type	WorkspaceType	Arbeidsområdetypen.

Workspaces

Object

En liste over arbeidsområder.

Navn	Type	Beskrivelse
continuationToken	string	Tokenet for den neste resultatsettgruppen. Hvis det ikke er flere poster, fjernes den fra svaret.
continuationUri	string	URI-en for neste satsvise resultatsett. Hvis det ikke er flere poster, fjernes den fra svaret.
workspaces	Workspace[]	Listen over stoffarbeidsområder.

WorkspaceState

Opplisting

Arbeidsområdetilstanden. Flere arbeidsområdetilstander kan legges til over tid.

Verdi	Beskrivelse
Active	Arbeidsområdet er aktivt. Frittstående arbeidsområder vises som aktive.
Deleted	Arbeidsområdet slettes.

WorkspaceType

Opplisting

En arbeidsområdetype. Flere arbeidsområdetyper kan legges til over tid.

Verdi	Beskrivelse
Personal	Min mappe eller Mitt arbeidsområde brukes til å administrere brukerelementer.
Workspace	Arbeidsområde som brukes til å administrere stoffelementene.
AdminWorkspace	Arbeidsområde for administratorovervåking. Inneholder administratorrapporter som revisjonsrapporten og bruks- og innføringsrapporten.