Eine Ressource abrufen.¶

Methode¶

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/{id}

Beschreibung¶

Ruft eine Ressource anhand ihrer ID oder externen ID ab.

Pfadparameter¶

tenant_id string erforderlich

Mandant, dem die Ressource gehört.

id string erforderlich

ID der abzurufenden Ressource. Eine externe ID kann verwendet werden, wenn ihr `ext$` vorangestellt ist.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/{id}

Schema der erfolgreichen Antwort (200)¶

object

Resource beschreibt eine einzelne verwaltete Ressource.

id string

Eindeutige ID der Ressource.

external_id string

Externe ID der Ressource (Google Workspace, Microsoft 365 usw.).

tenant_id string

Mandant, dem die Ressource gehört.

name string

Ressourcenname (beispielsweise die E-Mail-Adresse eines Benutzers bei Google Workspace- oder Microsoft 365-Mandanten oder der Name einer geteilten Ablage).

kind string

Ressourcenart (beispielsweise office_user oder office_teamdrive).

archived boolean

Gibt an, ob die Ressource archiviert ist. Bei true kann die Ressource nicht mehr gesichert werden (beispielsweise wenn sie gelöscht wurde).

Antwortbeispiel¶

{
  "id": "string",
  "external_id": "string",
  "tenant_id": "string",
  "name": "string",
  "kind": "string",
  "archived": true
}