Arbeitsmappen

Um alle verfügbaren Arbeitsmappen in iCL Portal abzufragen, kann der folgende REST-Dienst verwendet werden.

Endpunkt: /api/services/app/workbook

1. Arbeitsmappen abfragen

Url: /GetWorkbooks

HTTP-Methode: GET

Erforderliche Berechtigung: Workbooks.List

Es gibt die jeweils neueste Version jeder nicht gelöschten Arbeitsmappe zurück. Pro Anfrage werden höchstens 500 Arbeitsmappen zurückgegeben. Gibt es mehr, enthält result.__next die URL der nächsten Seite.

Optionaler Parameter: workbookId - die ID einer bestimmten Arbeitsmappen-Version, die ebenfalls im Ergebnis enthalten ist, auch wenn sie nicht die neueste Version ist oder gelöscht wurde.

Beispiel:

GET https://dev.iclportal.com/api/services/app/workbook/GetWorkbooks HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept-Encoding: gzip, deflate

{
   "result": {
      "results": [
         {
            "id": "d4548668-a2a2-4e30-b21d-5fc312d2d660",
            "definitionId": "c589a1f4-1049-4018-a5ae-36c23a54221e",
            "version": "1.0.0.5",
            "versionCode": 5,
            "title": "Task with Finding Test",
            "name": "Task with Finding Test",
            "description": null,
            "isPublished": true,
            "creationTime": "2017-02-14T17:30:37.873Z",
            "isDeleted": false,
            "deletionTime": null,
            "deleterUser": null,
            "retentionInDays": null,
            "numberOfVersions": 5,
            "numberOfTeams": 2,
            "numberOfTestTeams": 0
         }
      ],
      "__count": 1
   }
}

Name	Typ	Beschreibung
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.
numberOfVersions	number	Die Anzahl der Versionen der Arbeitsmappe.
numberOfTeams	number	Die Anzahl der Teams, denen die Arbeitsmappe zugewiesen ist.
numberOfTestTeams	number	Die Anzahl der Teams, in denen die Arbeitsmappe im Testmodus ist.

Beispiel 2 - Sie erhalten nur Arbeitsmappen, die bereits veröffentlicht wurden (und somit den Inspektoren vor Ort zur Verfügung stehen), und außerdem maximal 20 Ergebnisse

GET https://dev.iclportal.com/api/services/app/workbook/GetWorkbooks?$filter=IsPublished+eq+true&$inlinecount=allpages&$orderby=CreationTime+desc&$top=20 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept-Encoding: gzip, deflate

{
   "result": {
      "results": [
         {
            "id": "d4548668-a2a2-4e30-b21d-5fc312d2d660",
            "definitionId": "c589a1f4-1049-4018-a5ae-36c23a54221e",
            "version": "1.0.0.5",
            "versionCode": 5,
            "title": "Sample Workbook",
            "name": "Sample Workbook",
            "description": null,
            "isPublished": true,
            "creationTime": "2017-02-14T17:30:37.873Z",
            "isDeleted": false,
            "deletionTime": null,
            "deleterUser": null,
            "retentionInDays": null,
            "numberOfVersions": 5,
            "numberOfTeams": 2,
            "numberOfTestTeams": 0
         }
      ],
      "__count": 1
   }
}

Parameter: Dies ist ein ODATA 3.0 Endpunkt, mit dem Sie die Arbeitsmappen im System abfragen können.

Hinweis

Sie können alle Attribute der zurückgegebenen json-Objekte verwenden, um eine Abfrage zu erstellen. Aufgrund der ODATA-Spezifikation müssen Sie diese in der Abfrage jedoch in Großbuchstaben schreiben. Da dies eine Konvention in JSON und der JavaScript-Welt ist, werden unsere Ergebnisse mit den Attributnamen in Kleinbuchstaben zurückgegeben.

Beispiel: Sie erhalten eine Arbeitsmappe wie:

{"isPublished":true, "title":"Sample Workbook", …}

Wie Sie sehen können, beginnt das Attribut "isPublished" mit einem Kleinbuchstaben. Wenn Sie jedoch den ODATA-Endpunkt mit "isPublished" abfragen, müssen Sie den ersten Buchstaben in Großbuchstaben schreiben: /GetWorkbooks?$filter=IsPublished+eq+….