Teams

Um Informationen über Teams (z.B. Mitglieder, Arbeitsmappen eines Teams) abzufragen, können die folgenden REST-Dienste verwendet werden.

1. Alle Teams abfragen

Url: /api/services/app/workArea/Get

HTTP-Methode: GET

Es gibt alle bestehenden Teams zurück, wenn der aufrufende Benutzer die Berechtigung Workarea.View hat. Andernfalls gibt es nur die Teams zurück, in denen dem Benutzer eine Berechtigung erteilt wurde.

Erforderliche Berechtigung: Workarea.List

Beispiel:

GET https://dev.iclportal.com/api/services/app/workArea/Get HTTP/1.1 

{  
   "result": {
    "results": [
      {
        "id": "56c08dcd-8884-45d3-a6cc-2b0cf32b8b6d",
        "title": "\"A\" Team",
        "description": "The Avengers",
        "teamMembers": null,
        "activeTasksCount": 0,
        "isActive": true,
        "canEdit": true
      }
    ],
    "__count": 1
  }
}

Name	Typ	Beschreibung
id	string	Die eindeutige Identität des Teams.
title	string	Der Titel des Teams.
description	string	Die Beschreibung des Teams.
teamMembers	array	Für künftige Verwendung.
activeTasksCount	number	Die Anzahl der aktiven Aufgaben im Team.
isActive	boolean	Wahr, wenn das Team aktiv ist. Wenn ein Team inaktiv ist, können keine neuen Aufgaben mehr erstellt oder zugewiesen werden.
canEdit	boolean	Wahr, wenn der Benutzer, dem der Bearer Token gehört, die Erlaubnis hat, die Teameinstellungen zu bearbeiten.

2. Gruppen abfragen

Url: /api/services/app/workArea/GetGroups

HTTP-Methode: POST

Es gibt alle Gruppen zurück, die für das angegebene Team definiert sind (Administratoren, Koordinatoren, Inspektoren, Betrachter). Der name einer Gruppe ist ihr Anzeigename in der Sprache des aufrufenden Benutzers. Die Tester-Gruppe des Teams wird nicht zurückgegeben.

Erforderliche Berechtigung: Workarea.Groups.View, entweder allgemein oder für das angegebene Team.

Parameter: Die Parameter werden im Körper der HTTP-Anfrage in Form eines JSON-Objekts angegeben. Der Parameter id ist der eindeutige Bezeichner des Teams.

Beispiel:

POST api/services/app/workArea/GetGroups HTTP/1.1
{ "id": "56c08dcd-8884-45d3-a6cc-2b0cf32b8b6d" }

{  
   "result": {
    "groups": [
      {
        "groupId": 6,
        "name": "Administrators"
      },
      {
        "groupId": 7,
        "name": "Coordinators"
      },
      {
        "groupId": 8,
        "name": "Inspectors"
      },
      {
        "groupId": 10,
        "name": "Viewer"
      }
    ]
  }
}

Existiert kein Team mit der angegebenen id, schlägt die Anfrage mit 500 Internal Server Error fehl.

3. Gruppenmitglieder abfragen

Url: /api/services/app/groups/GetMembers

HTTP-Methode: GET

Es gibt alle Mitglieder der angegebenen Gruppe zurück.

Parameter: Der Parameter groupId ist der eindeutige Bezeichner der Gruppe.

Beispiel:

GET https://dev.iclportal.com/api/services/app/groups/GetMembers?groupId=6 HTTP/1.1

{
  "result": {
    "results": [
      {
        "id": 4,
        "userName": "nromanoff",
        "name": "Natasha",
        "surname": "Romanoff",
        "emailAddress": "nromanoff@example.com"
      },
      {
        "id": 5,
        "userName": "tstark",
        "name": "Tony",
        "surname": "Stark",
        "emailAddress": "tstark@example.com"
      },
      {
        "id": 6,
        "userName": "srogers",
        "name": "Steven",
        "surname": "Rogers",
        "emailAddress": "srogers@example.com"
      }
    ],
    "__count": 3
  }
}

4. Arbeitsmappen von Teams abfragen

Url: /api/services/app/workbook/GetAssociatedWorkbooks

HTTP-Methode: GET

Es gibt alle Arbeitsmappen zurück, die mit dem angegebenen Team verbunden sind. Gelöschte Arbeitsmappen, die noch mit dem Team verbunden sind, sind enthalten; bei ihnen ist isDeleted true.

Parameter: Der Parameter workAreaId ist der eindeutige Bezeichner des Teams. Fehlt er, ist das Ergebnis leer.

Beispiel:

GET https://dev.iclportal.com/api/services/app/workbook/GetAssociatedWorkbooks?workAreaId=56c08dcd-8884-45d3-a6cc-2b0cf32b8b6d HTTP/1.1

{
  "result": {
    "results": [
      {
        "id": "4907fb0f-4c35-48be-b21a-5e4864e434e7",
        "definitionId": "3b5191e8-6c7d-4579-ba5d-5ee6ec3e57ad",
        "version": "1.0.0.14",
        "versionCode": 14,
        "title": "Test iWorkbook",
        "name": "Test iWorkbook",
        "description": null,
        "isPublished": true,
        "isTestModeEnabled": false,
        "creationTime": "2023-10-04T06:49:45.197Z",
        "isDeleted": false,
        "deletionTime": null,
        "deleterUser": null,
        "retentionInDays": null
      }
    ],
    "__count": 1
  }
}

Name	Typ	Beschreibung
isTestModeEnabled	boolean	true, wenn die Arbeitsmappe in diesem Team im Testmodus ist.
retentionInDays	number	Die Aufbewahrungsdauer der Arbeitsmappe in Tagen, d.h. die Anzahl der Tage, nach denen abgeschlossene Inspektionen von den Geräten der Benutzer gelöscht werden. null, wenn die Standard-Aufbewahrungsdauer gilt.