Syntax: POST /rest/v1/search

Dieser Aufruf sammelt Suchindex Konfigurationen welche auf den ausgewählten Begriff passen. Bei Mehrdeutigkeit werden einfach mehrere indicies aufgelistet. Wird kein Typ angegeben, werden alle verfügbaren Indices zurückgeliefert.

Parameter

Name Pflicht Beschreibung
type Nein Oid von Suchindex, Oid von Übersetzung, Name von Suchindex, ORM Typ inkl. Vererbung
ordered Nein Sortierung welche an die Benutzeroberfläche angelehnt ist

Mögliche Rückgabestatus

Status Beschreibung
200 OK Der externe Suchdienst hat die Anfrage erfolgreich bearbeitet.
403 Forbidden Der aktuelle Benutzer hat nicht die Berechtigung die Suche anzustoßen.
500 Internal server error Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler.

Rückgabe

Der Aufruf dieses Endpunkts liefert eine JSON-Struktur mit Informationen über die passenden Suchindicies aus.

Beispiel:

[
    {
        "Indices": [
            "4a7a0d92-5e4b-49d0-b2e6-0edf5917252e",
            "2a66d3f7-8b16-4fe9-b614-60b7f10b748f"
        ],
        "IsSearchIndexSet": true,
        "Name": "Offers and Proalpha offers",
        "Title": "Angebote",
        "Id": "4e3be329-3d7e-49c1-bbbb-c5adba79cf16",
        "OrmType": {
            "Guid": "2730bb1b-2682-445f-9d8d-6490789ca367",
            "Name": "OrmCRMOfferBase"
        },
        "Count": -1,
        "LastIndexUpdate": "0001-01-01T00:00:00",
        "Sort": 100
    },
    {
        "Indices": [
            "e5fd0df8-e89c-4c9f-86c4-4fc5a0cc8ce1",
            "cec9536b-a3db-4a45-90dc-0e0b497cdae1",
            "3554f43f-8d89-4d12-b44d-f38e3f865190",
            "ca3b5182-5f4e-4a60-9496-f72dccabd144",
            "51e19654-f706-4acc-8dc8-885dd0b7e1e0",
            "74f8acd2-bd29-457a-9510-e56ee76de3d0",
            "d4a9b125-fa9a-4203-b11b-77ac510c8808",
            "55403670-956a-47e7-bc30-8c964256ffcf",
            "6de3527d-4794-4477-b047-69eb264ae891",
            "4a7a0d92-5e4b-49d0-b2e6-0edf5917252e",
            "2a66d3f7-8b16-4fe9-b614-60b7f10b748f"
        ],
        "IsSearchIndexSet": true,
        "Name": "Activities",
        "Title": "Vorgänge",
        "Id": "a55c5e63-b3db-46a2-b73f-a097c121abc2",
        "OrmType": {
            "Guid": "0f969d9b-9a93-4646-9d06-0edd05ca0aaf",
            "Name": "OrmActivityBase"
        },
        "Count": -1,
        "LastIndexUpdate": "0001-01-01T00:00:00",
        "Sort": 100
    },
    {
        "Fields": [
            "Subject",
            "UniqueNumber",
            "Remark",
            "DefaultAttachments.Id",
            "DefaultAttachments.FileName",
            "DefaultAttachments.Data",
            "DefaultAttachments.Extension",
            "DefaultAttachments.*.Id",
            "DefaultAttachments.*.FileName",
            "DefaultAttachments.*.Data",
            "DefaultAttachments.*.Extension",
            "ActivityTags.de",
            "RelatedParents_2_2.Common_EntityTitle",
            "RelatedParents_2_2.SearchNames",
            "RelatedParents_2_2.ExternalSearchNames",
            "RelatedParents_2_2.RelatedResponsiblePerson.Common_EntityTitle",
            "RelatedParents_1_1.Common_EntityTitle",
            "RelatedParents.Common_EntityTitle",
            "RelatedCreatedBy.Common_EntityTitle",
            "RelatedProjects.Common_EntityTitle"
        ],
        "IsSearchIndexSet": false,
        "Name": "Proalpha offer",
        "Title": "Angebot (Proalpha)",
        "Id": "2a66d3f7-8b16-4fe9-b614-60b7f10b748f",
        "OrmType": {
            "Guid": "80018a48-5688-41a6-bdb1-fc005da30c0b",
            "Name": "OrmCRMproAlphaOffer"
        },
        "Count": -1,
        "LastIndexUpdate": "2025-05-23T10:11:19.6114295+02:00",
        "Sort": 100
    }
]