SageCRM-Aktivität 'Objekte abfragen' verwenden

Mit der Aktivität 'Objekte abfragen' können Sie eine SData-Abfrage nach einem angegebenen Objekttyp in SageCRM ausführen.

Informationen zu diesem Vorgang

Verwenden Sie diese Task, um eine SData-Abfrage nach einem angegebenen Objekttyp in der SageCRM-Instanz auszuführen. Der Aufruf dieser Aktivität ist ein synchroner Aufruf, bei dem die Eingabedaten zur Verarbeitung an die Aktivität gesendet werden und die Antwort zurück an die Orchestrierung gesendet wird.

Vorgehensweise

  1. Klicken Sie mit der rechten Maustaste auf den Abschnitt 'Orchestrierungen' und wählen Sie 'Neue Orchestrierung' aus.
  2. Ziehen Sie den neu erstellten SageCRM-Endpunkt auf die Orchestrierung und wählen Sie die Aktivität Objekte abfragen aus.
  3. Die Aktivität Objekte abfragen wird der Orchestrierung hinzugefügt. Wählen Sie die Aktivität aus. Die Prüfliste der SageCRM-Aktivität 'Objekte abfragen' wird angezeigt.
  4. Klicken Sie in der Prüfliste auf Konfigurieren.
  5. Geben Sie die gültigen Abfrageparameter mit dem Zeichen ‘?’ als Platzhalter für den Wert ein. Wenn Sie mehrere Abfrageparameter konfigurieren wollen, trennen Sie jeden Abfrageparameter durch ein Zeichen ‘&’. Einige Beispiele für Abfragen:
    select=?&where=?
    startIndex=?&count=?
    orderBy=?
    select=?&where=?orderBy=?
      where=Lead_UpdatedDate lt @2016-01-10@

    Beachten Sie, dass die Abfragezeichenfolge nicht mit einem Zeichen ‘?’ darf.

  6. Klicken Sie auf Durchsuchen, um den Objekttyp auszuwählen. Das Fenster SageCRM durchsuchen wird angezeigt.
  7. Im Fenster SageCRM durchsuchen können Sie den Objekttyp in der Objekttypliste auswählen. Klicken Sie auf OK.
  8. Wählen Sie Eingaben zuordnen in der Prüfliste aus. Die XML-Schemas, die aus dem ausgewählten Objekt der Aktivität Objekte abfragen generiert wurden, werden als Knoten unter dem Anforderungseingabeparameter im Fenster An Aktivität angezeigt.
  9. Klicken Sie in der Prüfliste auf Wiederholung. Überprüfen Sie die Standardeinstellungen und nehmen Sie die erforderlichen Änderungen vor.
    Anmerkung: Weitere Informationen finden Sie unter Optionen für 'Wiederholung' für SageCRM REST API-Aktivitäten angeben.
  10. Erstellen Sie eine Zuordnung zwischen den Orchestrierungsvariablen und dem Eingabeparameter der Aktivität.
    Anmerkung: Während der Ausführung müssen Werte für obligatorische Elemente der Eingabestruktur angegeben werden. Ein Wert kann angegeben werden, indem ein Standardwert für ein Element eingegeben wird oder indem das Element mit einem Eingabeknoten verknüpft wird. Wenn während der Ausführung kein Wert für ein obligatorisches Element angegeben wird, löst die Aktivität eine Ausnahmebedingung aus, die von der Web Management Console gemeldet wird. Wenn während der Ausführung kein Wert für einen optionalen Eingabeparameter verfügbar ist, wird keine Ausnahmebedingung ausgelöst.
  11. Wählen Sie die Task Ausgaben zuordnen in der Prüfliste aus. Das XML-Schema, das zur Aufnahme der Antwort der Aktivität generiert wurde, wird als Knoten unter dem Antwortausgabeparameter im Fenster Von Aktivität angezeigt.
  12. Erstellen Sie eine Zuordnung zwischen den Ausgabeparametern und den Orchestrierungsvariablen.

    Abfrageparameter:

    Tabelle 1. Allgemeine Abfrageparameter für die Aktivität 'Objekte abfragen'
    Feldname Beschreibung
    startIndex Der Anfangsindex des Datensatzes, bei dem das Ergebnis des API-Aufrufs beginnen soll.
    count Die Anzahl der Objekte, die in der Antwort angezeigt werden sollen.
    where Gibt Filterkriterien an. Nur die Ressourcen, die den im Parameter 'where' angegebenen Kriterien entsprechen, werden zurückgegeben.
    orderBy Gibt ein Sortierkriterium an. Die Sammlung wird in aufsteigender oder absteigender Reihenfolge der Attributnamen sortiert, die in diesem Parameter angegeben werden.
    select Wählt die Eigenschaften aus, die in den Nutzdaten zurückgegeben werden. Durch diesen Parameter kann ein Client die Rückgabe einer bestimmten Liste von Eigenschaften in den Nutzdaten anfordern. Dadurch lassen sich Breite und Tiefe der zurückgegebenen Informationen präzise steuern.

    Mindestens einer der obigen Abfrageparameter muss einen zugeordneten Wert / Standardwert haben, damit die Aktivität erfolgreich ausgeführt werden kann.

Ergebnisse

Sie haben die SageCRM-Aktivität 'Objekte abfragen' konfiguriert.
Anmerkung:

Diese Aktivität kann zum Abrufen mehrerer Datensätze eines angegebenen Typs verwendet werden. Die Eingabeanforderung ist an sich eine einzelne Anforderung, die für einen einzelnen API-Aufruf 'Alle Objekte abrufen' verwendet wird, der mehrere Objekte abruft.