Allgemeine Schnittstelle zur Suche von Datensätzen

Durch die Übergabe der benötigten Klasse können über sämtliche Datentypen nach den verschiedenen Datensätzen gesucht werden. Die Schnittstelle retourniert die Daten im exakt gleichen Format wie diese auch von der regulären Übersichtsschnittstelle retourniert werden. Die Parameter :per und :page für eine Paginierung funktionieren ebenfalls. Sämtliche anderen Filtermöglichkeiten über Queryparameter, die auf der Übersichtsschnittstelle funktionieren, sind für die Suche nicht registriert.

Überblick

Klasse / Datentyp: Berechtigung Klasse Acl::Permission::SubjectClass
Response Formats: JSON
API Version: v2
Öffentlich erreichbar: false
HTTP Methode: GET

Zuletzt aktualisiert: 2016-12-13 16:31:44 +0100

/api/v2/:principal_slug/general/search/by_subject_class/:subject_class_key?query=:query

Parameter

Query Parameter

Pflicht	Schlüssel	Titel	Beispielwert
Pflicht	`subject_class_key` Pflicht Klasse / Datentyp nach dem gesucht werden soll	Klasse / Datentyp nach dem gesucht werden soll	Business::Partner::Client
Pflicht	`query` Pflicht Suchanfrage	Suchanfrage	island
Pflicht	`principal_slug` Pflicht Backend::Principal Slug / ID	Backend::Principal Slug / ID	squibble / 53db7cb4993a7aefa50001e1
optional	`page` optional Seite Definition der darzustellenden Seite. Standardwert: 1	Seite Definition der darzustellenden Seite. Standardwert: 1	2
optional	`per` optional Anzahl Datensätze pro Seite Definition der darzustellenden Datensätze pro Seite.	Anzahl Datensätze pro Seite Definition der darzustellenden Datensätze pro Seite.	24

Beispiel Rückgabe

{
  "data" : [
    {
      "id"             : "56b4c9eb93e2e5560d7b50fb",
      "name"           : "Audi Island",
      "email"          : "",
      "resource_class" : "Business::Partner::Client::BusinessClient",
      "classification" : {
        "id"     : "54fdc4656f726947ac0b0000",
        "label"  : "Island",
        "number" : 1040,
        "path"   : "1.10.1040"
      }
    }
  ],
  "meta" : {
    "resource_class" : "Business::Partner::Client",
    "max_updated_at" : "2016-11-28T20:07:30.451Z",
    "page"           : 1,
    "per"            : 24,
    "total_pages"    : 1,
    "total_count"    : 1
  }
}