Formular für die Remote-Integration abrufen

Version 4.0.23.6 (neueste Version)

Gibt das Integrationsformular für die Präsentation für den Nutzer zurück.

Anfrage

POST /integrations/{integration_id}/form
Datentyp
Beschreibung
Anfrage
HTTPRequest
Pfad
HTTPPath
HTTPPath-Definition maximieren...
Integrations-ID
String
ID der Integration
body
HTTP-Text
HTTPBody-Definition maximieren...
body
Objekt
Anfrageformular für die Integration

Antwort

200: Formular für Datenaktionen

Datentyp
Beschreibung
Status
Nutzerstatus
DataActionUserState-Definition maximieren...
Daten
String
Daten zum Nutzerstatus
Zeitpunkt der Aktualisierung
integer
Zeit in Sekunden, bis der Status aktualisiert werden muss
DataActionFormField-Definition maximieren...
name
String
Name
Label
String
Für Menschen lesbares Label
description
String
Beschreibung des Feldes
Typ
String
Feldtyp.
Standardeinstellung
String
Standardwert des Felds.
OAuth-URL
String
Die URL für einen OAuth-Link, wenn Typ "oauth_link".
interactive
boolean
Gibt an, ob ein Feld interaktive Formulare unterstützt.
erforderlich
boolean
Ob das Feld erforderlich ist oder nicht. Das ist ein Hinweis auf der Benutzeroberfläche. In der Benutzeroberfläche, in der dieses Formular angezeigt wird, sollte es nicht ohne Wert für dieses Feld gesendet werden. Diese Validierung muss auch vom Aktionsserver durchgeführt werden.
DataActionFormSelectOption-Definition maximieren...
name
String
Name
Label
String
Für Menschen lesbares Label

400: Ungültige Anfrage

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

404: Nicht gefunden

Datentyp
Beschreibung
(Objekt)
nachricht
String
Fehlerdetails
Dokumentations-URL
String
Link zur Dokumentation

422: Validierungsfehler

Datentyp
Beschreibung
nachricht
String
Fehlerdetails
ValidationErrorDetail-Definition maximieren...
Feld
String
Feld mit Fehler
Code
String
Fehlercode
nachricht
String
Fehlermeldung
Dokumentations-URL
String
Link zur Dokumentation
Dokumentations-URL
String
Link zur Dokumentation