Entitätsdatensätze abfragen

Fragt die Datensätze der Entität ab.

API-Endpunkt

BaseURL/EntityService/<Entity>/query

• BasisURL:

Anforderungsheader

Kopfzeile	Wert
Autorisierung	Bearer <access_token>
Inhaltstyp	application/json

Hinweis:

Ersetzen Sie alle Werte zwischen den spitzen Klammern <...> durch die entsprechenden Anwendungsfallwerte.

Die <access_token> ist diejenige, die Sie erhalten haben, als Sie die externe Anwendung autorisiert haben. Es ist 1 Stunde lang verfügbar, dann müssen Sie ein neues generieren oder ein Aktualisierungstoken anfordern.

Abfrageparameter

Abfrageparameter	Datentyp	Beschreibung	Standardwert
expansionLevel (optional)	int32	Gibt die Tiefe der abzurufenden Bezugsdatensätze an. Der Wert dieses Parameters kann 1, 2 oder 3 sein.	2

Anforderungstext (erforderlich)

{
  "selectedFields": [
    "string"
  ],
  "filterGroup": {
    "logicalOperator": 0,
    "queryFilters": [
      {
        "fieldName": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "filterGroups": [
      null
    ]
  },
  "start": 0,
  "limit": 0,
  "sortOptions": [
    {
      "fieldName": "string",
      "isDescending": true
    }
  ]
}

Anfragetextschemas

Der Text der Endpunktanforderung query enthält die folgenden Komponenten:

selectedFields

Dies ist eine optionale Komponente vom Typ string. Sie gibt die Liste der Felder an, die für jeden Datensatz der Abfrage zurückgegeben werden sollen. Wenn sie leer bleibt oder die Abfrageliste leer ist, werden alle Datensatzfelder zurückgegeben. Der Standardwert ist null.

filterGroup

Dies ist eine erforderliche Komponente, mit der Sie die Filtereigenschaften für die Abfrage festlegen können. Es kombiniert die folgenden Eigenschaften:

• LogicalOperator - Dies ist eine optionale filterGroup- Eigenschaft vom Typ int32. Es gibt an, ob alle Filter und Filtergruppen für die Abfrage gelten. Verwenden Sie 0 , um alle Filter und Filtergruppen anzuwenden. Verwenden Sie 1 , um einen der Filter und Filtergruppen anzuwenden. Der Standardwert ist 0.

• queryFilter - Dies ist eine erforderliche filterGroup- Eigenschaft, mit der Sie den Filterausdruck definieren können. Es hat die folgenden Eigenschaften:

  queryFilter-Eigenschaft	Datentyp	Beschreibung
  fieldName	string	Gibt den Namen des Felds an, das gefiltert werden soll.
  operator	string	Gibt den Filteroperator an. Unterstützt Folgendes: contains, not contains, startswith, endswith, =, !=, >, <,>=, <=, in, not in. Verwenden Sie den entsprechenden Operator für den entsprechenden Feldtyp.
  Wert	string	Gibt den Filterwert an.

• filterGroups – Dies ist eine optionale filterGroup- Eigenschaft, falls Sie eine andere Filteroption für die Abfrage festlegen müssen. Es enthält alle oben aufgeführten filterGroup- Eigenschaften.

Starten

Dies ist eine optionale Komponente vom Typ int32. Gibt die Anzahl der Datensätze an, die übersprungen werden sollen, bevor die Datensätze aus der Abfrage abgerufen werden. Kann zusammen mit der Eigenschaft limit verwendet werden, um die Paginierung zu implementieren. Die Datensätze sind aufsteigend nach ihren IDs sortiert. Um die Sortierreihenfolge zu ändern, verwenden Sie die Eigenschaft sortOptions . Der Standardwert ist 0.

limit

Dies ist eine optionale Komponente vom Typ int32. Er gibt die maximale Anzahl von Datensätzen an, die aus der Entität gelesen werden sollen. Kann zusammen mit der start -Eigenschaft verwendet werden, um die Paginierung zu implementieren. Der Standardwert ist 100und der Höchstwert ist 1000.

sortOptions

Dies ist eine optionale Komponente, mit der Sie die abgefragten Datensätze nach einer Liste von Feldern sortieren können. Wenn leer gelassen, werden die Datensätze aufsteigend nach ihren IDs sortiert. Es kombiniert die folgenden Eigenschaften:

• fieldName - Dies ist eine erforderliche sortOptions- Eigenschaft vom Typ string. Es gibt den Namen des Felds an, das zum Sortieren der Datensätze verwendet wird. Der Name muss einem gültigen Feld entsprechen, und die Groß-/Kleinschreibung muss beachtet werden.
• isDescending – Dies ist eine optionale sortOptions- Eigenschaft vom Typ boolean. Legen Sie true fest, wenn Sie die Datensätze absteigend sortieren möchten. Der Standardwert ist false.

Antworten

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:21:22.771Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:21:22.771Z"
    }
  ]
}

Antworttextschema

Der Antworttext des Endpunkts query enthält die folgenden Komponenten:

• totalRecordCount - Die Gesamtzahl der Datensätze, die den angegebenen Abfragefiltern entsprechen.
• value – Ein Array von Entitätsdatensätzen, die den angegebenen Abfragefiltern entsprechen, begrenzt durch die Eigenschaft „ limit “.

401 Nicht autorisiert

Sie sind nicht für den Zugriff auf Data Service authentifiziert. Stellen Sie sicher, dass Ihr Assistent oder Roboter mit einem modernen Ordner in Ihrem Konto verbunden ist.

403 Forbidden

Sie haben keine Berechtigung zum Zugriff auf die Entität, das Feld oder den Datensatz, oder Sie verwenden einen nicht unterstützten Robotertyp. Wenden Sie sich an Ihren Administrator, um die erforderlichen Berechtigungen zu erhalten.