Kintone-Verbindungsdetails
Einführung
Connector-Version
Diese Dokumentation basiert auf Version 23.0.8895 des Connectors.
Erste Schritte
Unterstützung der Kintone-Version
Der Connector modelliert die Kintone REST- APIs als relationale Datenbank.
Herstellen einer Verbindung
Verbinde dich mit Kintone
Legen Sie zusätzlich zu den Authentifizierungswerten die folgenden Parameter fest, um eine Verbindung herzustellen und Daten von Kintone abzurufen:
URL
: Die URL Ihres Kontos.GuestSpaceId
: Optional. Legen Sie dies fest, wenn Sie einen Gastbereich verwenden.
Authentifizieren Sie sich bei Kintone
Kintone unterstützt die folgenden Authentifizierungsmethoden.
Kennwortauthentifizierung
Zur Authentifizierung bei Kintone müssen Sie Folgendes festlegen:
User
: Der Benutzername Ihres Kontos.Password
: Das Passwort Ihres Kontos.AuthScheme
: Setzen Sie AuthScheme auf Passwort.
API Token
Zur Authentifizierung bei Kintone müssen Sie Folgendes festlegen:
-
APIToken
: Das API Token. Um ein API Token zu generieren, greifen Sie auf die entsprechende App zu und klicken Sie auf das Zahnrad. Gehen Sie zur Tab „App-Einstellungen“ > „API Token“. Klicken Sie auf die Schaltfläche „Generieren“, ein API Token wird generiert. Sie können auch mehrere durch Kommas getrennte API-Tokens angeben. -
AppId
: Die Anwendungs-IDs.Die AppId ist die Nummer dieser bestimmten App in der Sequenz unter Apps im Kintone UI-Dashboard. Sie können auch mehrere durch Kommas getrennte AppIds angeben.
-
AuthScheme
: AuthScheme auf APIToken setzen.
Zusätzliche Sicherheit
Zusätzlich zu den genannten Authentifizierungsschemata bietet Kintone zusätzliche Sicherheit in Form eines zusätzlichen Basic Auth-Header und eines SSL-Zertifikats.
Client-SSL verwenden
Zusätzlich zu Ihren Authentifizierungsinformationen kann Kintone so konfiguriert sein, dass zum Akzeptieren von Anfragen ein SSL-Zertifikat erforderlich ist. Legen Sie dazu Folgendes fest:
SSLClientCert
: Die Datei, die das Zertifikat des SSL-Zertifikats enthält. Oder alternativ der Name des Zertifikatsspeichers für das Client-Zertifikat.SSLClientCertType
: Der Zertifikatstyp.SSLClientCertSubject
: (Optional) Bei der Suche nach einem Zertifikat im Zertifikatsspeicher wird der Speicher nach Subjekten durchsucht, die den Wert der Eigenschaft enthalten.SSLClientCertPassword
: Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort zum Öffnen des Zertifikatspeichers anzugeben.
Cookies-basis
Kintone-Umgebungen, die die Basisauthentifizierung verwenden, müssen zusätzliche Basisanmeldeinformationen übergeben. Geben Sie dazu Folgendes an:
BasicAuthUser
: Der grundlegende Anmeldename.BasicAuthPassword
: Das Basispasswort.
OAuth-Authentifizierung
Wenn Sie keinen Zugriff auf den Benutzernamen und das Passwort haben oder diese nicht anfordern möchten, verwenden Sie den OAuth-Benutzereinwilligungsablauf. Um diese Authentifizierung von allen OAuth-Abläufen aus zu aktivieren, müssen Sie festlegen AuthScheme
Zu OAuth
und erstellen Sie eine benutzerdefinierte OAuth-Anwendung.
Notiz
Die OAuth-Authentifizierung unterstützt keine Cursor API. OAuth wird nicht zum Abrufen von mehr als 10.000 Zeilen empfohlen.
In den folgenden Unterabschnitten wird beschrieben, wie Sie sich über drei gängige Authentifizierungsabläufe bei Kintone authentifizieren. Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung finden Sie unter Erstellen einer benutzerdefinierten OAuth-Anwendung. Eine vollständige Liste der in Kintone verfügbaren Verbindungszeichenfolgeneigenschaften finden Sie unter Connection.
Desktop-Anwendungen
Um sich mit den Anmeldeinformationen für eine benutzerdefinierte OAuth-Anwendung zu authentifizieren, müssen Sie das OAuth-Zugriffstoken abrufen und aktualisieren. Danach können Sie eine Verbindung herstellen.
OAuth-Zugriffstoken abrufen und aktualisieren:
InitiateOAuth
:GETANDREFRESH
. Wird verwendet, um automatisch die abzurufen und zu aktualisierenOAuthAccessToken
.OAuthClientId
: Die Client-ID, die Ihnen bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung zugewiesen wurde.OAuthClientSecret
: Das Client-Geheimnis, das Ihnen bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung zugewiesen wurde.CallbackURL
: Die Umleitungs-URI, die bei der Registrierung Ihrer benutzerdefinierten OAuth-Anwendung definiert wurde.UseCursor
:false
.
Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von Kintone in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen.
Nachdem Sie der Anwendung Berechtigungen erteilt haben, schließt der Connector den OAuth-Prozess ab:
- Der Connector erhält einen Zugriffstoken von Kintone und verwendet ihn, um Daten anzufordern.
- Die OAuth-Werte werden im in angegebenen Pfad gespeichert
OAuthSettingsLocation
. Diese Werte bleiben über Verbindungen hinweg bestehen.
Wenn das Zugriffstoken abläuft, aktualisiert der Connector es automatisch.
Automatische Aktualisierung des OAuth-Zugriffstokens:
So lässt der Connector das OAuth-Zugriffstoken automatisch aktualisieren:
- Legen Sie vor der ersten Verbindung mit Daten diese Verbindungsparameter fest:
InitiateOAuth
:REFRESH
.OAuthClientId
: Die Client-ID in Ihren benutzerdefinierten OAuth-Anwendungseinstellungen.OAuthClientSecret
: Das Client-Geheimnis in Ihren benutzerdefinierten OAuth-Anwendungseinstellungen.OAuthAccessToken
: Der von GetOAuthAccessToken zurückgegebene Zugriffstoken.OAuthSettingsLocation
: Der Pfad, in dem der Connector die OAuth-Werte speichern soll, die über Verbindungen hinweg bestehen bleiben.UseCursor
:false
.
- Bei nachfolgenden Datenverbindungen setzen Sie:
InitiateOAuth
OAuthSettingsLocation
Manuelle Aktualisierung des OAuth-Zugriffstokens:
Der einzige Wert, der zur manuellen Aktualisierung des OAuth-Zugriffstokens benötigt wird, ist das OAuth-Aktualisierungstoken.
- Um das OAuthAccessToken nach dem ExpiresIn-Zeitraum (zurückgegeben von GetOAuthAccessToken manuell zu aktualisieren) abgelaufen ist, rufen Sie den RefreshOAuthAccessToken gespeicherte Prozedur.
- Legen Sie diese Verbindungseigenschaften fest:
OAuthClientId
: Die Client-ID in Ihren benutzerdefinierten OAuth-Anwendungseinstellungen.OAuthClientSecret
: Das Client Secret in Ihren benutzerdefinierten OAuth-Anwendungseinstellungen.
- Rufen Sie RefreshOAuthAccessToken auf mit OAuthRefreshToken auf das von GetOAuthAccessToken zurückgegebene OAuth-Aktualisierungstoken gesetzt.
- Nachdem die neuen Token abgerufen wurden, setzen Sie das
OAuthAccessToken
Eigenschaft auf den von RefreshOAuthAccessToken zurückgegebenen Wert. Dadurch wird eine neue Verbindung geöffnet.
Speichern Sie das OAuth-Aktualisierungstoken, damit Sie es verwenden können, um das OAuth-Zugriffstoken nach Ablauf manuell zu aktualisieren.
Erstellen einer benutzerdefinierten OAuth-Anwendung
Erstellen einer benutzerdefinierten OAuth-Anwendung
Wenn Sie keinen Zugriff auf den Benutzernamen und das Passwort haben oder diese nicht anfordern möchten, können Sie die OAuth-Authentifizierung verwenden. Kintone verwendet den OAuth-Authentifizierungsstandard, der erfordert, dass der authentifizierende Benutzer über den Browser mit Kintone interagiert. Die Authentifizierung über OAuth erfordert die Verwendung der OAuth-Clientanmeldeinformationen, der Client-ID und des Clientgeheimnisses.
So registrieren Sie eine benutzerdefinierte OAuth-Anwendung und erhalten die OAuth-Clientanmeldeinformationen, die Client-ID und das Clientgeheimnis:
- Melden Sie sich bei Kintone an und navigieren Sie zu
User & System Administration
Seite. - Klicken Sie auf
OAuth
unterSystem Administration
. - Klicken Sie auf das grüne
Add OAuth Client button
unterSet up Advanced Services
. - Geben Sie die Details des OAuth-Clients ein.
- Geben Sie einen Wert für die der Anwendung ein
Redirect URI
:- Wenn Sie eine Desktop-Anwendung erstellen, setzen Sie die Callback-URL auf
http://localhost:33333
oder eine andere Port Ihrer Wahl. - Wenn Sie eine Webanwendung erstellen, legen Sie die Rückruf-URL auf eine Seite Ihrer Webanwendung fest, zu der der Benutzer nach der Autorisierung Ihrer Anwendung zurückgeleitet werden soll.
- Wenn Sie eine Desktop-Anwendung erstellen, setzen Sie die Callback-URL auf
- Wenn Sie alle erforderlichen Felder ausgefüllt haben, klicken Sie auf
Save
.
Aktivierte Anwendungen werden in der Liste angezeigt und der Vorgang wird abgeschlossen.
Die OAuthClientID und das ClientSecret werden zusammen mit den Informationen angezeigt, die Sie beim Einrichten der Anwendung angegeben haben. Notieren Sie die OAuthClientID und das ClientSecret für die zukünftige Verwendung.
Wichtige Hinweise
Konfigurationsdateien und ihre Pfade
- Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.
Erweiterte Funktionen
In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des Kintone-Connectors beschrieben.
Benutzerdefinierte Ansichten
Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.
Proxy
So konfigurieren Sie den Connector mithilfe von privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings
Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.
Abfrageverarbeitung
Der Connector verlagert möglichst viel der Verarbeitung der SELECT-Anweisung auf Kintone und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).
Siehe Abfrageverarbeitung für weitere Informationen.
Benutzerdefinierte Ansichten
Mit dem Kintone-Connector können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.
Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:
- Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
- DDL-Anweisungen.
Definieren von Ansichten mithilfe einer Konfigurationsdatei
Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json
. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.
Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews
Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.
Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:
- Jedes Stammelement definiert den Namen einer Ansicht.
- Jedes Stammelement enthält ein untergeordnetes Element namens
query
, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.
Zum Beispiel:
{
"MyView": {
"query": "SELECT * FROM Comments WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie die UserDefinedViews
Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Definieren von Ansichten mit DDL-Anweisungen
Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.
Erstellen einer Ansicht
Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:
CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;
Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews
Verbindungseigenschaft.
Ändern einer Ansicht
Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:
ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.
Löschen einer Ansicht
Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.
DROP LOCAL VIEW [MyViewName]
Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.
Schema für benutzerdefinierte Ansichten
Benutzerdefinierte Ansichten werden im angezeigt UserViews
Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName
Eigentum.
Arbeiten mit benutzerdefinierten Ansichten
Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers
listet nur Kunden in Raleigh auf:
SELECT * FROM Customers WHERE City = 'Raleigh';
Ein Beispiel für eine Abfrage an den Treiber:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Daraus ergibt sich die effektive Abfrage an die Quelle:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.
Datenmodell
Der Connector modelliert die Kintone API als relationale Tabellen, Ansichten und Gespeicherte Prozeduren.
Tabellen
Mit dem Connector können Sie mit allen Tabellen in Ihrem Konto arbeiten. Die Tabellenschemata können statisch oder dynamisch sein. Die Tabelle „Kommentare“ hat ein statisches Schema mit festen Spalten, während andere Tabellen dynamisch sind und Änderungen in den Metadaten widerspiegeln. Wenn Sie eine Verbindung herstellen, ruft der Connector Tabellenmetadaten von Kintone ab, um die Tabellenschemata zu generieren.
Statische Schemata werden in Schema definiert, wodurch sie leicht erweiterbar sind. Bearbeiten Sie die Schema, um das Spaltenverhalten der statischen Kommentartabelle anzupassen, beispielsweise um den Datentyp zu ändern. Die Schema befinden sich im Unterordner db des Connector-Installationsordners.
Untertabellen
In einigen Kintone-Apps kann der Benutzer benutzerdefinierte Felder mit vielen Datensätzen hinzufügen. Der Connector modelliert diese Felder als dynamische Untertabellen, die Ihre Änderungen widerspiegeln.
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu Kintone. Sie können zum Suchen, Aktualisieren und Ändern von Informationen verwendet werden
in Kintone. Verwenden Sie beispielsweise gespeicherte Prozeduren, um Vorgänge an Apps auszuführen oder mit Dateien zu arbeiten.
Ansichten
Der Connector modelliert Apps in der statischen Apps-Ansicht.
Tabellen
Der Connector modelliert die Daten in Kintone als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.
Kintone Anschlusstabellen
Name | Beschreibung |
---|---|
ActionSettings | Aktualisieren und Abfragen der verfügbaren Aktionseinstellungen in Kintone. |
AppPermissions | Aktualisieren und Abfragen der App-Berechtigungen in Kintone. |
Comments | Abfrage der verfügbaren Kommentare in Kintone. |
FieldPermissions | Aktualisieren und Abfragen der verfügbaren Feldberechtigungen in Kintone. |
FormFields | Erstellen, aktualisieren, löschen und Abfrage die Formularfelder in Kintone. |
FormLayout | Aktualisieren und Abfragen des verfügbaren Formularlayouts in Kintone. |
GeneralNotifications | Aktualisieren und Abfragen der verfügbaren GeneralNotifications in Kintone. |
GeneralSettings | Aktualisieren und Abfragen der allgemeinen Einstellungen in Kintone. |
GraphSettings | Aktualisieren und Abfragen der verfügbaren Grafikeinstellungen in Kintone. |
PerRecordNotifications | Aktualisieren und Abfragen der verfügbaren PerRecord-Benachrichtigungen in Kintone. |
ProcessManagement | Aktualisieren und Abfragen des Prozessmanagements in Kintone. |
RecordPermissions | Aktualisieren und Abfragen der verfügbaren RecordPermissions in Kintone. |
ReminderNotifications | Aktualisieren und Abfragen der verfügbaren Erinnerungsbenachrichtigungen in Kintone. |
Space | Erstellen, aktualisieren, löschen und abfragen Sie den verfügbaren Speicherplatz in Kintone. |
SpaceMembers | Aktualisieren und Abfragen der verfügbaren Space-Mitglieder in Kintone. |
Views | Aktualisieren und Abfragen der verfügbaren Ansichten in Kintone. |
Aktionseinstellungen
Aktualisieren und fragen Sie die verfügbaren Aktionseinstellungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ActionSettings WHERE AppId = 6
SELECT * FROM ActionSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettings WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die ActionSettings zu aktualisieren, geben Sie die Aktionen als Aggregat an. Die Spalte AppId ist erforderlich, um die ActionSettings zu aktualisieren.
UPDATE ActionSettings SET Actions = '{"Action_Z":{"name":"Action_A","index":"0"}}' WO AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Id [KEY] | String | True | Die ID der Aktion. | |
Index | String | Falsch | Die Reihenfolge der Aktion, beginnend bei 0. | |
Name | String | Falsch | Der Name der Aktion. | |
DestApp | String | Falsch | Die App-ID der Ziel-App zum Kopieren. | |
DestCode | String | Falsch | Der App-Code der Ziel-App zum Kopieren. Wenn in den Einstellungen der Ziel-App kein App-Code festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. | |
Mappings | String | Falsch | Ein Array von Objekten, die die Feldzuordnungsoptionen enthalten. Wenn die Feldzuordnungsoptionen nicht konfiguriert sind, wird ein leeres Array zurückgegeben. | |
Entities | String | Falsch | Ein Array von Objekten, die die Entitäten enthalten, denen die Aktion gewährt wird. Dies spiegelt die Optionen „Verfügbar für“ wider. Inaktive Benutzer und gelöschte Benutzer/Abteilungen/Gruppen werden nicht in die Antwort aufgenommen. | |
Revision | String | False | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die Aktionseinstellungsdetails der Live-App abrufen. Der Standardwert ist „true“. |
Actions | String | Wird nur zum Durchführen von Updates verwendet. |
App-Berechtigungen
Aktualisieren und fragen Sie die App-Berechtigungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM AppPermissions WHERE AppId = 6
SELECT * FROM AppPermissions WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die AppPermissions zu aktualisieren, geben Sie die Rechte als Aggregat an. Die Spalten AppId und IsPreview sind erforderlich, um die AppPermissions zu aktualisieren.
UPDATE AppPermissions SET Rights = '[{"entity":{"type":"CREATOR"},"appEditable":true,"recordViewable":true,"recordAddable":true,"recordEditable":true,"recordDeletable":true,"recordImportable":true,"recordExportable":true}]' WHERE AppId = 6 AND IsPreview = true
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
EntityType [KEY] | String | Falsch | Der Typ der Entität, der die Berechtigung erteilt wird. | |
EntityCode | String | Falsch | Der Code der Entität, der die Berechtigung erteilt wird. | |
IncludeSubs | Boolean | Falsch | Die Berechtigungsvererbungseinstellungen der Abteilung, der die Berechtigung erteilt wird. | |
AppEditable | Boolean | Falsch | Die App-Verwaltungsberechtigung der Entität. Entitäten mit dieser Berechtigung können auf die Einstellungen der App zugreifen und diese bearbeiten. | |
RecordViewable | Boolean | Falsch | Die Datensatzanzeigeberechtigung der Entität. | |
RecordAddable | Boolean | Falsch | Die Berechtigung der Entität zum Hinzufügen von Datensätzen. | |
RecordEditable | Boolean | Falsch | Die Datensatzbearbeitungsberechtigung der Entität. | |
RecordDeletable | Boolean | Falsch | Die Datensatzlöschberechtigung der Entität. | |
RecordImportable | Boolean | Falsch | Die Dateiimportberechtigung der Entität. | |
RecordExportable | Boolean | Falsch | Die Dateiexportberechtigung der Entität. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die App-Berechtigungsdetails der Live-App abrufen. Der Standardwert ist „true“. |
Rights | String | Wird nur zum Durchführen von Updates verwendet. |
Kommentare
Fragen Sie die verfügbaren Kommentare in Kintone ab.
Wählen
Die Spalten RecordId und AppId sind in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach diesen Spalten zu filtern. Die Kintone APIs unterstützen auch Filter für die ID. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM Comments WHERE RecordId = 1 AND AppId = 5 AND ID = 1
Einfügen
Die Spalten AppId und RecordId sind in der INSERT-Anweisung erforderlich.
INSERT INTO Comments (AppId, RecordId, Text, MentionsAggregate) VALUES (5, 1, 'To do', '[{"code": "Administrator","type": "USER"}]')
Löschen
Kommentare können durch Ausführen einer DELETE-Anweisung und Angabe von RecordId, AppId und Id gelöscht werden.
DELETE FROM Comments WHERE RecordId = 1 AND AppId = 5 AND ID = 1
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Integer | Wahr | Die Kommentar-ID. | |
AppId [KEY] | Integer | Falsch | Die App-ID. | |
RecordId [KEY] | Integer | Falsch | Die Datensatz-ID. | |
Text | String | False | Der Kommentar einschließlich der Zeilenvorschubcodes. | |
CreatorCode | String | True | Der Benutzercode des Kommentarerstellers (Anmeldename). | |
CreatorName | String | True | Der Benutzername des Kommentarerstellers (Anzeigename). | |
CreatedAt | Datetime | True | Das Erstellungsdatum und die Erstellungszeit des Kommentars. | |
MentionsAggregate | String | False | Ein Array mit Informationen zu den erwähnten Benutzern. |
Feldberechtigungen
Aktualisieren und fragen Sie die verfügbaren Feldberechtigungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM FieldPermissions WHERE AppId = 6
SELECT * FROM FieldPermissions WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die FieldPermissions zu aktualisieren, geben Sie die Rechte als Aggregat an. Die Spalten AppId und IsPreview sind erforderlich, um die FieldPermissions zu aktualisieren.
UPDATE FieldPermissions SET Rights = 'Update FieldPermissions set Rights='[{"code":"Updated_by","entities":[{"accessibility":"READ","entity":{"type":"GROUP","code":"everyone"}}]}]' WO AppId = 6 UND IsPreview = true
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Code [KEY] | String | Falsch | Der Feldcode eines Felds, das über Berechtigungseinstellungen verfügt. | |
Entities | String | Falsch | Ein Array, das die Entitäten in der Reihenfolge ihrer Priorität auflistet, denen die Berechtigungen erteilt wurden. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die FieldPermissions-Details der Live-App abrufen. Der Standardwert ist „true“. |
Rights | String | Wird nur zum Durchführen von Updates verwendet. |
Formularfelder
Erstellen, aktualisieren, löschen und Abfrage die Formularfelder in Kintone.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM FormFields WHERE AppId = 6
SELECT * FROM FormFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormFields WHERE AppId = 6 AND IsPreview = false
Einfügen
Die Spalten AppId, Type, Code und Label sind in der INSERT-Anweisung erforderlich.
INSERT INTO FormFields (AppId, Type, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_CRUD', 'Test')
Das Einfügen kann auch ausgeführt werden, indem die AppId-Spalte und die Eigenschaftenspalte als JSON-Aggregat bereitgestellt werden:
INSERT INTO FormFields (AppId, Properties) VALUES (6, '{"Text__single_line_TD":{"type":"SINGLE_LINE_TEXT","code":"Text__single_line_TD","label":"Test"}}')
The Kintone API supports Bulk Insert as well:
INSERT INTO FormFields#TEMP (AppId, Typ, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp1', 'Label1')
INSERT INTO FormFields#TEMP (AppId, Typ, Code, Label) VALUES (6, 'SINGLE_LINE_TEXT', 'Text__single_line_temp2', 'Label2')
INSERT INTO FormFields (AppId, Typ, Code, Label) SELECT AppId, Typ, Code, Label FROM FormFields#TEMP
Aktualisieren
Um die Formularfelder zu aktualisieren, geben Sie die Eigenschaften als Aggregat an. Die Spalte „AppId“ ist erforderlich, um die Formularfelder zu aktualisieren.
UPDATE FormFields SET Properties = '{"Text__single_line_TT":{"code":"Text__single_line_PT","label":"text","type":"SINGLE_LINE_TEXT"}}' WO AppId = 6
Löschen
Sie müssen die durch Kommas getrennten Werte der Codespalte angeben, die Sie löschen möchten. Die AppId-Spalte wird zum Löschen der Formularfelder benötigt.
DELETE FROM FormFields WHERE Code = 'Text__single_line_CRUD, Text__single_line_TD' AND AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Code [KEY] | String | Falsch | Der Feldcode. | |
Enabled | String | True | Die Ein-/Aus-Einstellungen von Funktionen. | |
Label | String | Falsch | Der Feldname. | |
NoLabel | Boolean | Falsch | Die Option „Feldnamen ausblenden“. | |
Type | String | Falsch | Der Feldtyp. | |
Required | String | Falsch | Die Option „Erforderliches Feld“. | |
Unique | String | Falsch | Die Option „Doppelte Werte verbieten“. | |
MaxValue | String | Falsch | Die maximale Anzahl an Zeichen für das Feld. | |
MinValue | String | Falsch | Die Mindestanzahl an Zeichen für das Feld. | |
MaxLength | String | Falsch | Die maximale Anzahl an Ziffern für das Feld. | |
MinLength | String | Falsch | Die Mindestanzahl an Ziffern für das Feld. | |
DefaultValue | String | Falsch | Der Standardwert. Für Felder, die mehrere Standardwerte festlegen können, wird ein Array zurückgegeben. | |
DefaultNowValue | String | Falsch | Die Standardoption für das Datensatzerstellungsdatum. | |
Options | String | Falsch | Ein Objekt, das Daten der Feldoptionen enthält. | |
Align | String | Falsch | Das Layout der Optionen. | |
Expression | String | Falsch | Der im Feld verwendete Formelausdruck. | |
HideExpression | String | Falsch | Die Einstellungen zum Ausblenden der Formel für das Feld. | |
Digit | String | Falsch | Die Option Tausendertrennzeichen verwenden. | |
ThumbnailSize | String | Falsch | Die Größe der Bildminiatur in Pixeln. | |
Protocol | String | Falsch | Die Linktypeinstellungen für das Feld. | |
Format | String | Falsch | Das Anzeigeformat für Felder mit Berechnungen. | |
DisplayScale | String | Falsch | Die Anzahl der für das Feld anzuzeigenden Dezimalstellen. | |
Unit | String | Falsch | Die Währungseinstellungen des Feldes. | |
UnitPosition | String | Falsch | Die Anzeigeposition der Währung. | |
Entities | String | False | Ein Array, das die voreingestellten Benutzer für das Feld auflistet. | |
ReferenceTable | String | Falsch | Ein Objekt, das die Einstellungen des Felds „Verwandte Datensätze“ enthält. | |
LookUp | String | Falsch | Ein Objekt, das die Einstellungen des Nachschlagefelds enthält. | |
OpenGroup | String | Falsch | Die Option „Felder in dieser Gruppe anzeigen“. | |
Fields | String | Falsch | Ein Objekt, das Daten von Feldern in einer Tabelle enthält. Die Parameter dieses Objekts sind dieselben wie die Eigenschaftenparameter. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die Formularfelddetails der Live-App abrufen. Der Standardwert ist „true“. |
Properties | String | Wird nur zum Ausführen von Einfügen oder Aktualisieren verwendet. |
Formularlayout
Aktualisieren und fragen Sie das verfügbare Formularlayout in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM FormLayout WHERE AppId = 6
SELECT * FROM FormLayout WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayout WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um das FormLayout zu aktualisieren, geben Sie das Layout als Aggregat an. Alle Felder im Formular müssen im Aggregat angegeben werden. Die Spalte AppId ist erforderlich, um das FormLayout zu aktualisieren.
UPDATE FormLayout SET Layout = '[{"type":"ROW","fields":[{"type":"SPACER","code":"Table_0","size":{"width":"200"}}]}]' WO AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Fields | String | Falsch | Eine Liste der Felder in der Zeile. | |
Type | String | Falsch | Der Zeilentyp. Die zulässigen Werte sind ROW, SUBTABLE, GROUP. | |
Code | String | Falsch | Der Feldcode des Tabellen- oder Gruppenfelds. Dieser Parameter wird für andere Zeilentypen nicht zurückgegeben. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die Formularlayoutdetails der Live-App abrufen. Der Standardwert ist „true“. |
Layout | String | Wird nur zum Ausführen von Einfügen oder Aktualisieren verwendet. |
AllgemeineBenachrichtigungen
Aktualisieren und fragen Sie die verfügbaren GeneralNotifications in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM GeneralNotifications WHERE AppId = 6
SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die allgemeinen Benachrichtigungen zu aktualisieren, geben Sie die Benachrichtigungen als Aggregat an. Die Spalte AppId ist erforderlich, um die allgemeinen Benachrichtigungen zu aktualisieren.
UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
EntityType | String | Falsch | Der Entitätstyp, für den die allgemeinen Benachrichtigungseinstellungen konfiguriert sind. | |
EntityCode [KEY] | String | Falsch | Der Code der Entität, für die die allgemeinen Benachrichtigungseinstellungen konfiguriert sind. | |
IncludeSubs | Boolean | Falsch | Die Einstellung „Zugehörige Abteilungen einschließen“ der Abteilung. Gibt immer „false“ zurück, es sei denn, notifications[].entity.type ist für ein Abteilungsauswahlfeld auf ORGANIZATION oder FIELD_ENTITY eingestellt. | |
RecordAdded | Boolean | Falsch | Option zum Benachrichtigen der Entität, wenn ein Datensatz hinzugefügt wird. | |
RecordEdited | Boolean | Falsch | Option zum Benachrichtigen der Entität, wenn ein Datensatz bearbeitet wird. | |
CommentAdded | Boolean | Falsch | Option zum Benachrichtigen der Entität, wenn ein Kommentar gepostet wird. | |
StatusChanged | Boolean | Falsch | Option zum Benachrichtigen der Entität, wenn sich ein Status ändert. | |
FileImported | Boolean | Falsch | Option zum Benachrichtigen der Entität, wenn eine Datei importiert wird. | |
NotifyToCommenter | Boolean | Falsch | Option zum Benachrichtigen aller Kommentatoren eines Datensatzes, wenn ein Kommentar zu diesem Datensatz gepostet wird. Dies entspricht dem Kontrollkästchen Aktualisierte Kommentarbenachrichtigungen an alle Kommentatoren senden. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IsPreview | Boolean | Wenn Sie dies auf „False“ setzen, können Sie die GeneralNotifications-Details der Live-App abrufen. Der Standardwert ist „true“. |
Notifications | String | Wird nur zum Durchführen von Updates verwendet. |
AllgemeineEinstellungen
Aktualisieren und Abfragen der allgemeinen Einstellungen in Kintone.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM GeneralSettings WHERE AppId = 6
SELECT * FROM GeneralSettings WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Sie müssen die AppId und den IconKey der zu aktualisierenden GeneralSetting angeben.
UPDATE GeneralSettings SET Name = 'UpdatedName', Description = 'Test Description', IconType = 'PRESET', IconKey = 'APP72' WHERE IconKey = 'APP72' AND AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | True | Die App-ID der Kintone-Anwendung. | |
IconKey [KEY] | String | False | Die Schlüsselkennung des Icons. Wird beantwortet, wenn die voreingestellten Icons in Kintone verwendet werden. | |
IconType | String | Falsch | Der Symboltyp: DATEI, VOREINSTELLUNG. | |
IconFile | String | Falsch | Der Symboltyp: DATEI, VOREINSTELLUNG. | |
Name | String | Falsch | Der App-Name. | |
Description | String | False | Die App-Beschreibung im HTML-Format. | |
Theme | String | Falsch | Das Farbthema. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Wenn Sie dies auf „False“ setzen, können Sie die allgemeinen Einstellungsdetails der Live-App abrufen. Der Standardwert ist „true“. |
GraphEinstellungen
Aktualisieren und fragen Sie die verfügbaren Grapheinstellungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM GraphSettings WHERE AppId = 6
SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die GraphSettings zu aktualisieren, stellen Sie die Berichte als Aggregat bereit. Die Spalte AppId ist erforderlich, um die GraphSettings zu aktualisieren.
UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WO AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Id [KEY] | String | True | Die ID des Diagramms. | |
Index | String | Falsch | Die Reihenfolge der Graphen, beginnend bei 0. | |
Name | String | Falsch | Der Name des Diagramms. Die maximale Länge beträgt 64 Zeichen. Wenn der Anforderungsparameter „lang“ angegeben ist, wird der Name des Diagramms in dieser Sprache zurückgegeben. | |
PeriodicReport | String | Falsch | Ein Objekt, das die Option „Regelmäßige Berichte (Externer Link)“ enthält. Wenn die Option „Berichte regelmäßig erstellen“ nie konfiguriert wurde, wird null zurückgegeben. | |
Sorts | String | Falsch | Ein Array von Objekten, die die Sortieroptionen enthalten. | |
AggregationsType | String | Falsch | Der Typ der Funktionsoption. | |
AggregationsCode | String | Falsch | Der Feldcode des in der Funktionsoption verwendeten Felds. | |
ChartMode | String | Falsch | Der Anzeigemodus (Externer Link) des Diagramms. | |
ChartType | String | Falsch | Der Diagrammtyp (Externer Link) des Graphen. | |
FilterCond | String | Falsch | Die Filterbedingung des Datensatzes im Abfrage, die die Filteroption widerspiegelt. | |
GroupsCode | String | Falsch | Der Feldcode des Felds, der zum Bestimmen der Option „Gruppieren nach“ verwendet wird. | |
GroupsPer | String | Falsch | Die für die Option „Gruppieren nach“ verwendete Zeiteinheit. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Wenn Sie dies auf „False“ setzen, können Sie die Graph-Einstellungsdetails der Live-App abrufen. Der Standardwert ist „true“. |
Reports | String | Wird nur zum Durchführen von Updates verwendet. |
PerRecordNotifications
Aktualisieren und fragen Sie die verfügbaren PerRecord-Benachrichtigungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM PerRecordNotifications WHERE AppId = 6
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotifications WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die PerRecordNotifications zu aktualisieren, geben Sie die Benachrichtigungen als Aggregat an. Die Spalte AppId ist erforderlich, um die PerRecordNotifications zu aktualisieren.
UPDATE PerRecordNotifications SET Notifications = '[{"filterCond":"Record_number = 18","title":"Test Title","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
FilterCond | String | Falsch | Die Filterbedingung des Datensatzes im Abfrage. | |
Title [KEY] | String | False | Der Betreff der Benachrichtigung, der unter Zusammenfassung gespeichert ist. | |
Targets | String | Falsch | Ein Array von Objekten, die die Empfänger der Benachrichtigung pro Datensatz enthalten. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die PerRecordNotifications-Details der Live-App abrufen. Der Standardwert ist „true“. |
Notifications | String | Wird nur zum Durchführen von Updates verwendet. |
ProzessManagement
Aktualisieren und Abfragen des Prozessmanagements in Kintone.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ProcessManagement WHERE AppId = 6
SELECT * FROM ProcessManagement WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagement WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um das Prozessmanagement zu aktualisieren, geben Sie die Zustände und Aktionen als Aggregat an. Die Spalte AppId ist erforderlich, um das Prozessmanagement zu aktualisieren.
UPDATE ProcessManagement SET Enable = true, States = '{"In progress":{"name":"In progress","index":"1","assignee":{"type":"ONE","entities":[]}},"Bereit":{"name":"Bereit","index":"3","assignee":{"type":"ONE","entities":[]}},"Completed":{"name":"Completed","index":"2","assignee":{"type":"ONE","entities":[]}},"Nicht gestartet":{"name":"Nicht gestartet","index":"0","assignee":{"type":"ONE","entities":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}}}', Actions = '[{"name":"Start","from":"Not started","to":"In progress","filterCond":""},{"name":"Complete","from":"Completed","to":"Completed","filterCond":""}]' WHERE AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Enable | Boolean | Falsch | Die Ein-/Aus-Einstellungen der Prozessmanagementeinstellungen. | |
Actions | String | False | Ein Array mit Daten der Aktionen. Sie werden in derselben Reihenfolge aufgelistet wie in der GUI. Für Apps, die die Prozessmanagementeinstellungen noch nie aktiviert haben, wird Null zurückgegeben. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. | |
Name | String | Falsch | Der Statusname. | |
Index | String | Falsch | Die Anzeigereihenfolge (aufsteigend) des Status, wenn er mit den anderen Status aufgelistet wird. | |
AssigneeType | String | Falsch | Der Typ der Zuständigenliste des Status. | |
AssigneeEntities | String | Falsch | Ein Array mit den Daten der Bevollmächtigten. Sie werden in der gleichen Reihenfolge aufgelistet wie in der GUI. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die Prozessmanagementdetails der Live-App abrufen. Der Standardwert ist „true“. |
States | String | Wird nur zum Durchführen von Updates verwendet. |
Datensatzberechtigungen
Aktualisieren und fragen Sie die verfügbaren RecordPermissions in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM RecordPermissions WHERE AppId = 6
SELECT * FROM RecordPermissions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissions WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die AppPermissions zu aktualisieren, geben Sie die Rechte als Aggregat an. Die Spalten AppId und IsPreview sind erforderlich, um die RecordPermissions zu aktualisieren.
UPDATE RecordPermissions SET Rights = '[{"filterCond":"","entities":[{"entity":{"type":"GROUP","code":"everyone"},"viewable":false,"editable":false,"deletable":false,"includeSubs":true}]}]' WHERE AppId = 6 AND IsPreview = true
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
FilterCond | String | Falsch | Die Filterbedingung der Datensatzberechtigung. | |
Entities | String | Falsch | Ein Array, das die Entitäten in der Reihenfolge ihrer Priorität auflistet, denen die Berechtigungen erteilt wurden. | |
Revision | String | False | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die RecordPermissions-Details der Live-App abrufen. Der Standardwert ist „true“. |
Rights | String | Wird nur zum Durchführen von Updates verwendet. |
ErinnerungBenachrichtigungen
Aktualisieren und fragen Sie die verfügbaren Erinnerungsbenachrichtigungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ReminderNotifications WHERE AppId = 6
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotifications WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die Erinnerungsbenachrichtigungen zu aktualisieren, geben Sie die Benachrichtigungen als Aggregat an. Die Spalte AppId ist erforderlich, um die Erinnerungsbenachrichtigungen zu aktualisieren.
UPDATE ReminderNotifications SET Notifications = '[{"timing":{"code":"Updated_datetime","daysLater":-2,"hoursLater":-5},"filterCond":"Record_number = 14","title":"Reminder: Tomorrow is the deadline.","targets":[{"entity":{"type":"FIELD_ENTITY","code":"Created_by"},"includeSubs":false}]}]' WHERE AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
AppId [KEY] | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
FilterCond | String | Falsch | Die Filterbedingung des Datensatzes im Abfrage. | |
Title | String | False | Der Betreff der Benachrichtigung, der unter Zusammenfassung gespeichert ist. | |
TimingCode [KEY] | String | Falsch | Der Feldcode des Felds, das zur Bestimmung des Zeitpunkts der Erinnerungsbenachrichtigung verwendet wird. | |
TimingDaysLater | Integer | Falsch | Die Anzahl der Tage nach dem Benachrichtigungsdatum[].timing.code, an dem die Erinnerungsbenachrichtigung gesendet wird. Ein negativer Wert gibt die Anzahl der Tage vor dem Benachrichtigungsdatum[].timing.code an. | |
TimingHoursLater | Integer | Falsch | Die Anzahl der Stunden nach den Benachrichtigungen[].timing.code datetime, verschoben um daysLater, wenn die Erinnerungsbenachrichtigung gesendet wird. | |
TimingTime | String | Falsch | Der Zeitpunkt, zu dem die Erinnerungsbenachrichtigung gesendet wird. Der Parameter wird zurückgegeben, wenn der Parameter notifications[].timing.code auf ein Datumsfeld oder den gesetzt ist. | |
Targets | String | Falsch | Ein Array von Objekten, das die Empfänger der Erinnerungsbenachrichtigung enthält. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. | |
Timezone | String | Falsch | Die Zeitzone, die den Zeitpunkt der Erinnerungsbenachrichtigung bestimmt. Dies spiegelt die Dropdown-Option „Zeitzone der Erinnerung“ wider. Wenn die Einstellungen für die Erinnerungsbenachrichtigung der App nie konfiguriert wurden, wird null zurückgegeben. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Wenn Sie dies auf „False“ setzen, können Sie die Details der Erinnerungsbenachrichtigungen der Live-App abrufen. Der Standardwert ist „true“. |
Notifications | String | Wird nur zum Durchführen von Updates verwendet. |
Raum
Erstellen, aktualisieren, löschen und abfragen Sie den verfügbaren Speicherplatz in Kintone.
Wählen
Die ID-Spalte ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM Space WHERE ID = 7
Einfügen
Die Spalten SpaceTemplateID, Name und Members sind in der INSERT-Anweisung erforderlich.
INSERT INTO Space(SpaceTemplateID, Name, Members) Values(1, 'New_Space', '[{"entity":{"type":"USER","code":"cdataarc.handson@gmail.com"},"isAdmin":true}]')
Aktualisieren
Die ID-Spalte wird benötigt, um den Space zu aktualisieren.
UPDATE Space SET body='Space Body' WHERE ID = 16
Löschen
Die ID-Spalte wird benötigt, um den Space zu löschen.
DELETE FROM Space WHERE ID = 16
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Wahr | Die Space-ID. | |
Name | String | Falsch | Der Name des Raums. | |
DefaultThread | String | Falsch | Die Thread-ID des Standard-Threads, der beim Erstellen des Spaces erstellt wurde. | |
IsPrivate | Boolean | Falsch | Die privaten Einstellungen des Space. | |
CreatorCode | String | Falsch | Der Code (Anmeldename) des Erstellers. Für inaktive oder gelöschte Benutzer wird eine leere Zeichenfolge zurückgegeben. | |
CreatorName | String | Falsch | Der Anzeigename des Erstellers. Für inaktive oder gelöschte Benutzer wird eine leere Zeichenfolge zurückgegeben. | |
ModifierCode | String | False | Der Code (Anmeldename) des Updaters. Für inaktive oder gelöschte Benutzer wird eine leere Zeichenfolge zurückgegeben. | |
ModifierName | String | False | Der Anzeigename des Aktualisierers. Für inaktive oder gelöschte Benutzer wird eine leere Zeichenfolge zurückgegeben. | |
MemberCount | String | Falsch | Die Anzahl der Mitglieder des Space. | |
CoverType | String | Falsch | Der Bildtyp des Titelbilds. | |
CoverKey | String | Falsch | Der Schlüssel des Titelbilds. | |
CoverUrl | String | Falsch | Die URL des Titelbilds. | |
Body | String | False | Das HTML des Space-Textkörpers. Null wird zurückgegeben, wenn das HTML im Textkörper leer ist. Wenn der Textkörper jedoch zuvor festgelegt wurde, können die HTML-Tags festgelegt werden, auch wenn nichts auf dem Bildschirm angezeigt wird, und die Zeichenfolge wird zurückgegeben. | |
UseMultiThread | Boolean | Falsch | Die Einstellung „Mehrere Threads aktivieren“. | |
IsGuest | Boolean | Falsch | Die Einstellung für den Gästebereich. | |
FixedMember | Boolean | Falsch | ||
AttachedApps | String | Falsch | Eine Liste der Apps, die sich im Thread befinden. Apps, die noch nicht live sind, sind hiervon ausgenommen. | |
ShowAnnouncement | Boolean | Falsch | Der Anzeigestatus für das Ankündigungs-Widget. | |
ShowThreadList | Boolean | Falsch | Der Anzeigestatus für das Threads-Widget. | |
ShowAppList | Boolean | Falsch | Der Anzeigestatus für das Apps-Widget. | |
ShowMemberList | Boolean | Falsch | Der Anzeigestatus für das Personen-Widget. | |
ShowRelatedLinkList | Boolean | Falsch | Der Anzeigestatus für das Widget „Zugehörige Apps und Spaces“. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
SpaceTemplateID | String | Die Space-Vorlagen-ID. Sie wird beim Erstellen eines neuen Spaces benötigt. |
Members | String | Eine Liste der Mitglieder des Space. Sie wird beim Erstellen eines neuen Space benötigt. Mindestens ein Space-Administrator muss angegeben werden. Inaktive und gelöschte Benutzer können nicht angegeben werden. |
RaumMitglieder
Aktualisieren und fragen Sie die verfügbaren Space-Mitglieder in Kintone ab.
Wählen
Die ID-Spalte ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM SpaceMembers WHERE ID = 1
Aktualisieren
Um die SpaceMembers zu aktualisieren, geben Sie die Spalte „Members“ als Aggregat an. Die Spalte „ID“ ist erforderlich, um die SpaceMembers zu aktualisieren.
UPDATE SpaceMembers SET Members='[{"entity":{"type":"USER","code":"cdataarc.handson@gmail.com"},"isAdmin":true}]' WHERE ID = 1
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | Wahr | Die Space-ID. | |
EntityCode | String | Falsch | Der Code des Space-Mitglieds. | |
EntityType | String | Falsch | Der Entitätstyp des Space-Mitglieds. | |
IsAdmin | Boolean | Falsch | Die Space-Admin-Einstellungen des Space-Mitglieds. | |
IsImplicit | Boolean | Falsch | Ob das Space-Mitglied als Benutzer hinzugefügt wurde oder nicht. | |
IncludeSubs | Boolean | Falsch | Die Einstellung „Zugehörige Abteilungen einschließen“ des Abteilungsbereichsmitglieds. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Members | String | Eine Liste der Mitglieder des Space. Sie wird beim Erstellen eines neuen Space benötigt. Mindestens ein Space-Administrator muss angegeben werden. Inaktive und gelöschte Benutzer können nicht angegeben werden. |
Ansichten
Aktualisieren und fragen Sie die verfügbaren Ansichten in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM Views WHERE AppId = 6
SELECT * FROM Views WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM Views WHERE AppId = 6 AND IsPreview = false
Aktualisieren
Um die Ansichten zu aktualisieren, geben Sie die Ansichten als Aggregat an. Ansichtsnamen, die nicht im Aggregat angegeben sind, werden gelöscht. Die Spalte AppId ist zum Aktualisieren der Ansichten erforderlich.
UPDATE VIEWS SET Views = '{"(Assigned to me)":{"index":0,"type":"LIST","name":"(Assigned to me)","filterCond":"Assignee in (LOGINUSER())","sort":"Record_number asc"},"subTableTest2":{"index":1,"type":"CALENDAR","name":"subTableTest","date":"Updated_datetime","filterCond":"","sort":"Record_number asc"}}' WO AppId = 6
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die Ansichts-ID. | |
AppId | Integer | Falsch | Die App-ID der Kintone-Anwendung. | |
Index | String | Falsch | Die Anzeigereihenfolge (aufsteigend) der Ansicht, wenn sie mit anderen Ansichten aufgelistet wird. | |
Name | String | Falsch | Der Name der Ansicht. | |
Title | String | Falsch | Der für das Titelfeld festgelegte Feldcode. Beantwortet für Kalenderansichten. | |
Type | String | Falsch | Der Ansichtstyp. Die zulässigen Werte sind LIST, CALENDAR, CUSTOM. | |
BuiltinType | String | Falsch | Der Typ der integrierten Ansicht. | |
Date | String | Falsch | Der für das Datumsfeld festgelegte Feldcode. Beantwortet für Kalenderansichten. | |
Fields | String | Falsch | Die Liste der Feldcodes für die in der Ansicht angezeigten Felder. | |
FilterCond | String | False | Die Filterbedingung als Abfrage. | |
Html | String | Falsch | Der für die Ansicht festgelegte HTML-Code. Für benutzerdefinierte Ansichten geantwortet. | |
Pager | Boolean | Falsch | Die Paginierungseinstellungen. Für benutzerdefinierte Ansichten geantwortet. | |
Device | String | Falsch | Der Bereich, in dem die Ansicht angezeigt wird. | |
Sort | String | False | Die Sortierreihenfolge als Abfrage. | |
Revision | String | True | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | Die lokalisierte Sprache zum Abrufen der Daten. |
IsPreview | Boolean | Indem Sie dies auf „False“ setzen, können Sie die Ansichtsdetails der Live-App abrufen. Der Standardwert ist „true“. |
Views | String | Wird nur zum Durchführen von Updates verwendet. |
Ansichten
Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.
Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.
Kintone Connector-Ansichten
Name | Beschreibung |
---|---|
ActionSettingsEntities | Abfrage der verfügbaren Aktionseinstellungsentitäten in Kintone. |
ActionSettingsMappings | Abfrage der verfügbaren Aktionseinstellungszuordnungen in Kintone. |
Apps | Abfrage der verfügbaren Apps in Kintone. |
FieldPermissionsEntities | Abfrage der Feldberechtigungsentitäten in kintone. |
FormLayoutFields | Abfrage der verfügbaren Formular-Layoutfelder in Kintone. |
PerRecordNotificationsTargets | Abfrage der PerRecord-Benachrichtigungsziele in kintone. |
ProcessManagementActions | Abfrage der Prozessmanagementaktionen in kintone. |
RecordPermissionsEntities | Abfrage der verfügbaren Datensatzberechtigungsentitäten in Kintone. |
ReminderNotificationsTargets | Abfrage der verfügbaren Erinnerungsbenachrichtigungsziele in Kintone. |
AktionEinstellungenEntitäten
Fragen Sie die verfügbaren Aktionseinstellungselemente in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ActionSettingsEntities WHERE AppId = 6
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsEntities WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId | Integer | Die App-ID der Kintone-Anwendung. | |
Id [KEY] | String | Die ID der Aktion. | |
Code | String | Der Code der Entität, der die Aktion gewährt wird. Bei Gastbenutzern wird dem Anmeldenamen „guest/“ vorangestellt. | |
Type | String | Der Typ der Entität, der die Aktion gewährt wird. Die zulässigen Werte sind USER, GROUP, ORGANIZATION. | |
Revision | String | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | |
IsPreview | Boolean |
Aktionseinstellungszuordnungen
Fragen Sie die verfügbaren Aktionseinstellungszuordnungen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ActionSettingsMappings WHERE AppId = 6
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ActionSettingsMappings WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId | Integer | Die App-ID der Kintone-Anwendung. | |
Id [KEY] | String | Die ID der Aktion. | |
SrcType | String | Der Typ der Quelldaten, die kopiert werden sollen. Die zulässigen Werte sind FIELD, RECORD_URL. | |
SrcField | String | Der Feldcode des Felds, das in den Feldzuordnungsoptionen als Quelle angegeben ist. Dieser Parameter wird nur zurückgegeben, wenn der Parameter actions.{actionname}.mappings[].srcType auf FIELD gesetzt ist. | |
DestField | String | Der Feldcode des Felds, das in den Feldzuordnungsoptionen als Ziel angegeben ist. | |
Revision | String | Die Revisionsnummer der App-Einstellungen. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | |
IsPreview | Boolean |
Apps
Fragen Sie die verfügbaren Apps in Kintone ab.
Wählen
Standardmäßig verwendet der Connector die Kintone APIs, um Suchkriterien zu verarbeiten, die sich auf die folgenden Spalten beziehen, und verarbeitet andere Filter clientseitig innerhalb des Connectors: Die Kintone API unterstützt Suchvorgänge in den Spalten AppId, Code und SpaceId. Diese Spalten unterstützen die serverseitige Verarbeitung der Operatoren = und IN, während die Spalte Name nur den Operator LIKE unterstützt. Beispielsweise wird die folgende Abfrage serverseitig verarbeitet:
SELECT * FROM Apps WHERE AppId IN (20, 21, 51, 56) AND Name LIKE '%To Do%'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId [KEY] | Integer | Die App-ID der Kintone-Anwendung. | |
Code | String | Der App-Code der App. Dieses Feld ist leer, wenn in den Einstellungen der App kein App-Code festgelegt ist. | |
Name | String | Der Name der App. Wenn Lokalisierungseinstellungen verwendet werden, gibt diese Spalte den lokalisierten Namen zurück, abhängig von den Spracheinstellungen des Kintone-Benutzers, der diese API verwendet. | |
Description | String | Die Beschreibung der App. Wenn Lokalisierungseinstellungen verwendet werden, gibt diese Spalte die lokalisierte App-Beschreibung zurück, abhängig von den Spracheinstellungen des Kintone-Benutzers, der diese API verwendet. | |
SpaceId | String | Wenn die App innerhalb eines Space erstellt wurde, gibt diese Spalte die Space-ID zurück. Andernfalls gibt diese Spalte null zurück. | |
ThreadId | String | Wenn die App in einem Space erstellt wurde, gibt diese Spalte die Thread-ID des Threads des Spaces zurück, zu dem sie gehört. Für Benutzer, die ihre Benutzeroberflächeneinstellungen nicht auf das klassische Design geändert haben, gehören Apps automatisch zum ersten Thread des Spaces, wenn die App in dem Space erstellt wird. Benutzer, die das klassische Design verwenden, werden feststellen, dass sie Apps erstellen können, die threadspezifisch statt spacespezifisch sind. Wenn die App nicht in einem Space erstellt wurde, wird null zurückgegeben. | |
CreatedAt | Datetime | Das Datum, an dem die App erstellt wurde. | |
CreatorCode | String | Der Anmeldename des Erstellers. Für inaktive und gelöschte Benutzer wird nichts zurückgegeben. | |
CreatorName | String | Der Anzeigename des Erstellers. Für inaktive und gelöschte Benutzer wird nichts zurückgegeben. | |
ModifiedAt | Datetime | Das Datum, an dem die App zuletzt geändert wurde. | |
ModifierCode | String | Der Anmeldename des letzten Aktualisierers. Für inaktive und gelöschte Benutzer wird nichts zurückgegeben. | |
ModifierName | String | Der Anzeigename des letzten Aktualisierers. Für inaktive und gelöschte Benutzer wird nichts zurückgegeben. | |
Alias | String | Der Aliasname der App. |
FeldberechtigungenEntitäten
Fragen Sie die Feldberechtigungsentitäten in kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6
SELECT * FROM FieldPermissionsEntities WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId [KEY] | Integer | Die App-ID der Kintone-Anwendung. | |
Code [KEY] | String | Der Feldcode eines Felds, das über Berechtigungseinstellungen verfügt. | |
EntityType | String | Der Typ der Entität, der die Berechtigung erteilt wird. | |
EntityCode | String | Der Code der Entität, der die Berechtigung erteilt wird. | |
Accessibility | String | Die der Entität erteilte Berechtigung. Die zulässigen Werte sind READ, WRITE, NONE. | |
IncludeSubs | Boolean | Die Berechtigungsvererbungseinstellungen der Abteilung, der die Berechtigung erteilt wird. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IsPreview | Boolean |
FormularLayoutFelder
Fragen Sie die verfügbaren Formularlayoutfelder in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM FormLayoutFields WHERE AppId = 6
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM FormLayoutFields WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId | Integer | Die App-ID der Kintone-Anwendung. | |
Code | String | Der Feldcode. | |
Type | String | Der Feldtyp. | |
ElementId | String | Die Element-ID des Space-Felds. Wird nur für Space-Felder zurückgegeben. | |
Label | String | Der im Beschriftungsfeld festgelegte Text. Wird nur für Beschriftungsfelder zurückgegeben. | |
Width | String | Die Breite des Feldes in Pixeln. | |
Height | String | Die Höhe des Feldes in Pixeln, einschließlich der Höhe des Feldnamens. | |
InnerHeight | String | Die Höhe des Feldes in Pixeln, ausschließlich der Höhe des Feldnamens. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
IsPreview | Boolean |
PerRecordNotificationsTargets
Fragen Sie die PerRecord-Benachrichtigungsziele in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM PerRecordNotificationsTargets WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId [KEY] | Integer | Die App-ID der Kintone-Anwendung. | |
Title [KEY] | String | Der Betreff der Benachrichtigung, der unter Zusammenfassung gespeichert ist. | |
EntityType | String | Der Entitätstyp, für den die Einstellungen für die Benachrichtigung pro Datensatz konfiguriert sind. | |
EntityCode | String | Der Code der Entität, für die die Einstellungen für die Benachrichtigung pro Datensatz konfiguriert sind. | |
IncludeSubs | Boolean | Die Einstellung „Zugehörige Abteilungen einbeziehen“ der Abteilung. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | |
IsPreview | Boolean |
ProzessManagementAktionen
Fragen Sie die Prozessmanagementaktionen in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ProcessManagementActions WHERE AppId = 6
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ProcessManagementActions WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId | Integer | Die App-ID der Kintone-Anwendung. | |
Name | String | Der Aktionsname. | |
From | String | Der Status vor dem Ergreifen von Maßnahmen. | |
To | String | Der Status nach der Durchführung der Aktion. | |
FilterCond | String | Die Verzweigungskriterien der Aktion. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | |
IsPreview | Boolean |
DatensatzberechtigungenEntities
Fragen Sie die verfügbaren Datensatzberechtigungseinheiten in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM RecordPermissionsEntities WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId [KEY] | Integer | Die App-ID der Kintone-Anwendung. | |
FilterCond [KEY] | String | Die Filterbedingung der Datensatzberechtigung. | |
EntityType | String | Der Typ der Entität, der die Berechtigung erteilt wird. | |
EntityCode | String | Der Code der Entität, der die Berechtigung erteilt wird. | |
Viewable | Boolean | Die Anzeigeberechtigung der Entität. | |
Editable | Boolean | Die Bearbeitungsberechtigung der Entität. | |
Deletable | Boolean | Die Löschberechtigung der Entität. | |
IncludeSubs | Boolean | Die Berechtigungsvererbungseinstellungen der Abteilung, der die Berechtigung erteilt wird. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | |
IsPreview | Boolean |
ErinnerungBenachrichtigungenZiele
Fragen Sie die verfügbaren Erinnerungsbenachrichtigungsziele in Kintone ab.
Wählen
Die Spalte AppId ist in der WHERE-Klausel erforderlich. Der Connector verwendet die Kintone APIs, um die Ergebnisse nach dieser Spalte zu filtern. Standardmäßig verarbeitet der Connector andere Filter clientseitig innerhalb des Connectors.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND Lang = 'en'
SELECT * FROM ReminderNotificationsTargets WHERE AppId = 6 AND IsPreview = false
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
AppId [KEY] | Integer | Die App-ID der Kintone-Anwendung. | |
TimingCode [KEY] | String | Der Feldcode des Felds, das zur Bestimmung des Zeitpunkts der Erinnerungsbenachrichtigung verwendet wird. | |
EntityType | String | Der Entitätstyp, für den die Einstellungen für Erinnerungsbenachrichtigungen konfiguriert sind. | |
EntityCode | String | Der Code der Entität, für die die Einstellungen für Erinnerungsbenachrichtigungen konfiguriert sind. | |
IncludeSubs | Boolean | Die Einstellung „Zugehörige Abteilungen einbeziehen“ der Abteilung. Die Einstellung „Zugehörige Abteilungen einbeziehen“ der Abteilung. |
Pseudo-Spalten
Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
Lang | String | |
IsPreview | Boolean |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Kintone hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Kintone zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren für den Kintone Connector
Name | Beschreibung |
---|---|
AddGuests | Fügt Gastbenutzer zu Kintone hinzu. Dadurch werden Gastbenutzer nicht mit Gastbereichen verknüpft und es werden keine Einladungs-Emails gesendet. Um einen Gastbenutzer mit einem Gastbereich zu verknüpfen, verwenden Sie die gespeicherte Prozedur AddGuestsToSpace. Nur Kintone-Administratoren können diese API verwenden. |
AddGuestsToSpace | Fügen Sie die Gastbenutzer mit einem Gastbereich hinzu. Nur der Administrator des Gastbereichs kann diese API verwenden. |
AddThreadComment | Fügt einem Thread eines Spaces einen Kommentar hinzu. |
AppsDeployStatus | Bereitstellungsstatus der App abrufen. |
CreateApp | Erstellt Apps. |
DeleteGuests | Löscht einen Gastbenutzer aus Kintone. Nur Kintone-Administratoren können diese API verwenden. |
DeployApps | Stellt Apps bereit. |
DownloadFile | Lädt Dateien aus einem Anhangsfeld in einer App herunter. |
GetOAuthAccessToken | Ruft ein Authentifizierungstoken von Asana ab. |
GetOAuthAuthorizationURL | Ruft die Autorisierungs URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern den OAuthAccessToken von dieser URL an. |
RefreshOAuthAccessToken | Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei Asana verwendet wird. |
UpdateAssignees | Aktualisiert die Beauftragten. |
UpdateStatus | Aktualisiert den Status eines App-Datensatzes. |
UpdateThread | Aktualisiert einen Thread eines Space. |
UploadFile | Lädt ein Dokument in Kintone hoch. |
Gäste hinzufügen
Fügt Gastbenutzer zu Kintone hinzu. Dadurch werden Gastbenutzer keinem Gastbereich zugeordnet und es werden keine Einladungs-Emails gesendet. Um einen Gastbenutzer einem Gastbereich zuzuordnen, verwenden Sie die gespeicherte Prozedur AddGuestsToSpace. Nur Kintone-Administratoren können diese API verwenden.
Gespeicherte Prozedurspezifische Informationen
Kintone erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Jack', 'jack@gmail.com', '#jack@123', 'America/Los_Angeles')
Insert into GuestsAggregate#TEMP(Name, Code, Password, Timezone) Values('Geeky', 'geeky@gmail.com', '#geeky@321', 'America/Los_Angeles')
EXECUTE AddGuests GuestsAggregate = 'GuestsAggregate#TEMP'
Die zweite Möglichkeit, die gespeicherte Prozedur zu verwenden, besteht darin, das Aggregat selbst hinzuzufügen:
EXECUTE AddGuests GuestsAggregate = '[{"code":"ax@example.com","password":"#abcd@123","timezone":"America/Los_Angeles","locale":"en","name":"John Doe","company":"Company Name","division":"Sales","callto":"skypecallto"}]'
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
Name | String | Falsch | Der Anzeigename des Benutzers. Muss zwischen 1 und 128 Zeichen lang sein. |
Code | String | Falsch | Die Email Adresse (Anmeldename) des Gastbenutzers. |
Password | String | Falsch | Das Anmeldekennwort des Gastbenutzers. Es muss alphanumerisch sein. |
Timezone | String | Falsch | Die Zeitzone des Gastbenutzers. |
Locale | String | Falsch | Die Spracheinstellungen des Gastbenutzers. Verfügbare Werte sind auto, en, zh, ja. Wenn nicht angegeben, wird auto als Standard festgelegt. |
Image | String | Falsch | Das Profilbild des Gastbenutzers. Geben Sie einen Dateischlüssel einer hochgeladenen Datei an. |
SurNameReading | String | Falsch | Die phonetischen Nachnameneinstellungen des Gastbenutzers. Die maximale Länge beträgt 64 Zeichen. |
GivenNameReading | String | Falsch | Die phonetischen Vornamenseinstellungen des Gastbenutzers. Die maximale Länge beträgt 64 Zeichen. |
Company | String | Falsch | Der Firmenname, der im Profil des Gastbenutzers angezeigt werden soll. |
Division | String | Falsch | Der Abteilungsname, der im Profil des Gastbenutzers angezeigt werden soll. |
Phone | String | Falsch | Die im Profil des Gastbenutzers anzuzeigende Telefonnummer. |
CallTo | String | Falsch | Der Skype-Name des Gastbenutzers. |
GuestsAggregate | String | Falsch | Das Gästeaggregat. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Gäste zum Platz hinzufügen
Fügen Sie die Gastbenutzer mit einem Gastbereich hinzu. Nur der Administrator des Gastbereichs kann diese API verwenden.
Gespeicherte Prozedurspezifische Informationen
Kintone erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:
EXECUTE AddGuestsToSpace GuestSpaceId = '6', Guests = '["jackd@gmail.com","yogesh@gmail.com","harshm@gmail.com"]'
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
GuestSpaceId | String | True | Die Gästebereich-ID. |
Guests | String | True | Eine Liste mit Email Adressen von Gastbenutzern. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Thread-Kommentar hinzufügen
Fügt einem Thread eines Spaces einen Kommentar hinzu.
Gespeicherte Prozedurspezifische Informationen
Kintone erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:
EXECUTE AddThreadComment SpaceId = 8, ThreadId = 8, Text = 'Test Comment'
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
SpaceId | Integer | True | Die ID des Raums. |
ThreadId | Integer | True | Die ID des Threads. |
Text | String | Falsch | Der Kommentarinhalt. Ein Zeilenumbruch kann durch LF angegeben werden. Die maximale Zeichenanzahl des Kommentars beträgt 65535. Erforderlich, wenn Dateien nicht festgelegt sind. |
Mentions | String | Falsch | Ein Array mit Erwähnungen, die andere Kintone Benutzer benachrichtigen. |
Files | String | Falsch | Ein Array mit Daten der angehängten Dateien. Die maximale Anzahl der Dateien beträgt 5. Erforderlich, wenn kein Text angegeben ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Id | String | Die Kommentar-ID des erstellten Kommentars. |
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
AppsDeployStatus
App-Bereitstellungsstatus abrufen.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AppIds | String | True | Die ID der App. Dies kann eine Liste durch Kommas getrennter IDs sein. |
GuestSpaceId | String | Falsch | Dieser Parameter wird für Apps verwendet, die sich im Gastbereich befinden. Fügen Sie diesen Parameter nicht hinzu, wenn die Verbindungseigenschaft GuestSpaceId in der Verbindungszeichenfolge angegeben ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
AppId | String | Die ID der App. |
Status | String | Der Status der App. |
App erstellen
Erstellt Apps.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
Name | String | True | Geben Sie den Namen der Anwendung mit weniger als 64 Zeichen an. |
Space | String | Falsch | Die ID des Bereichs. Geben Sie dies nicht an, wenn die Verbindungseigenschaft GuestSpaceId in der Verbindungszeichenfolge festgelegt ist. |
ThreadId | String | Falsch | Die ID des Threads. Dies ist erforderlich, wenn der Space-Parameter oder die Verbindungseigenschaft GuestSpaceId angegeben ist. |
IsGuestSpace | Boolean | Falsch | Dies ist ein Boolescher Wert, der angibt, ob der Parameter „Space“ ein normaler Space oder ein Gastspace ist. Setzen Sie diesen Wert für Gastspaces auf „true“. Der Standardwert ist „falsch“. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
AppId | String | Die ID der App. |
Revision | String | Die Überarbeitung der App. |
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Gäste löschen
Löscht einen Gastbenutzer aus Kintone. Nur Kintone-Administratoren können diese API verwenden.
Gespeicherte Prozedurspezifische Informationen
Kintone erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:
Geben Sie zum Löschen der Gäste die durch Kommas getrennten Werte der Gäste ein.
EXECUTE DeleteGuests Guests = '["jackd@gmail.com","harshm@gmail.com"]'
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
Guests | String | True | Eine Liste mit Email Adressen von Gastbenutzern. Bis zu 100 Gäste können gelöscht werden. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Bereitstellen von Apps
Stellt Apps bereit.
Hinweis
Dieses Verfahren verwendet indizierte Parameter.
Indizierte Parameter erleichtern die Bereitstellung mehrerer Instanzen eines einzelnen Parameters als Eingaben für das Verfahren.
Angenommen, es gibt einen Eingabeparameter mit dem Namen Param#. Um mehrere Instanzen eines indexierten Parameters wie diesen einzugeben, führen Sie Folgendes aus:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
In der folgenden Tabelle sind indexierte Parameter mit einem gekennzeichnet #
-Zeichen am Ende ihrer Namen.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AppId# | String | True | Die App-ID. Dies kann eine Liste durch Kommas getrennter IDs sein. |
Revision# | String | Falsch | Geben Sie die Revision der Einstellung an, die die Umfeld widerspiegelt. Wenn die angegebene Revision nicht auf dem neuesten Stand ist, schlägt die Anforderung fehl. |
Revert | Boolean | Falsch | Wenn Sie die Änderung der Anwendungseinstellungen verwerfen möchten, setzen Sie dies auf „true“. Der Standardwert ist „falsch“. |
GuestSpaceId | String | Falsch | Dieser Parameter wird für Apps verwendet, die sich im Gastbereich befinden. Fügen Sie diesen Parameter nicht hinzu, wenn die Verbindungseigenschaft GuestSpaceid in der Verbindungszeichenfolge angegeben ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Datei herunterladen
Lädt Dateien aus einem Anhangsfeld in einer App herunter.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
FileKey | String | True | Die ID der Datei. |
LocalPath | String | Falsch | Der lokale Pfad, in dem die Datei gespeichert werden soll. |
FileName | String | Falsch | Der Dateiname, unter dem die Dateien gespeichert werden sollen. |
GuestSpaceId | String | Falsch | Dieser Parameter wird für Dokumente verwendet, die sich im Gastbereich befinden. Fügen Sie diesen Parameter nicht hinzu, wenn die Verbindungseigenschaft GuestSpaceId in der Verbindungszeichenfolge angegeben ist. |
Encoding | String | Falsch | Der FileData-Eingabecodierungstyp. Die zulässigen Werte sind NONE, BASE64. Der Standardwert ist BASE64. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
FileData | String | Gibt Dateidaten zurück, wenn die LocalPath- oder FileStream-Eingabe leer ist. |
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
GetOAuthAccessToken
Ruft ein Authentifizierungstoken von Asana ab.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AuthMode | String | Falsch | Der zu verwendende Authentifizierungsmodustyp. Wählen Sie „App“, um Authentifizierungstoken über eine Desktop-App abzurufen. Wählen Sie „Web“, um Authentifizierungstoken über eine Web-App abzurufen. Die zulässigen Werte sind APP, WEB. Der Standardwert ist APP. |
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Weiterleitungs URL übereinstimmen, die Sie in den Einstellungen der Asana-App angegeben haben. Nur erforderlich, wenn der Authmode-Parameter „Web“ ist. |
Verifier | String | Falsch | Der von Asana zurückgegebene Verifizierer, nachdem der Benutzer Ihrer App den Zugriff auf seine Daten gestattet hat. Dieser Wert wird als Parameter an die Rückruf-URL zurückgegeben. |
Scope | String | Falsch | Eine durch Leerzeichen getrennte Liste von Bereichen, die den Zugriff einer Anwendung auf das Konto eines Benutzers beschränken. Der Standardwert ist k:app_record:read k:app_record:write k:app_settings:read k:app_settings:write k:file:read k:file:write. |
State | String | Falsch | Kodiert den Status der App, der wortwörtlich in der Antwort zurückgegeben wird und verwendet werden kann, um die Antwort einer bestimmten Anfrage zuzuordnen. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Der Zugriffstoken, der für die Kommunikation mit Asana verwendet wird. |
OAuthRefreshToken | String | Das OAuth-Aktualisierungstoken. Dies ist dasselbe wie das Zugriffstoken bei Asana. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. Eine -1 bedeutet, dass es nicht abläuft. |
GetOAuthAuthorizationURL
Ruft die Autorisierungs URL ab, die vom Benutzer separat geöffnet werden muss, um Zugriff auf Ihre Anwendung zu gewähren. Wird nur bei der Entwicklung von Web-Apps benötigt. Sie fordern den OAuthAccessToken von dieser URL an.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. Dieser Wert muss mit der Weiterleitungs-URL in den Asana-App-Einstellungen übereinstimmen. |
State | String | Falsch | Kodiert den Status der App, der wortwörtlich in der Antwort zurückgegeben wird und verwendet werden kann, um die Antwort einer bestimmten Anfrage zuzuordnen. |
Scope | String | Falsch | Eine durch Leerzeichen getrennte Liste von Bereichen, die den Zugriff einer Anwendung auf das Konto eines Benutzers beschränken. Der Standardwert ist k:app_record:read k:app_record:write k:app_settings:read k:app_settings:write k:file:read k:file:write. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die Autorisierungs-URL, die in einen Webbrowser eingegeben wird, um das Prüftoken zu erhalten und Ihre App zu autorisieren. |
Aktualisieren Sie das OAuthAccessToken
Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei Asana verwendet wird.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
OAuthRefreshToken | String | True | Setzen Sie dies auf den abgelaufenen Tokenwert. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von Asana zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Dies ist dasselbe wie der Zugriffstoken. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. |
Bevollmächtigte aktualisieren
Aktualisiert Beauftragte.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AppId | String | True | Die App-ID. |
RecordId | String | True | Die Datensatz-ID. |
Assignees | String | True | Die Benutzercodes der Beauftragten. Wenn leer, werden keine Benutzer zugewiesen. Die maximale Anzahl der Beauftragten beträgt 100. |
Revision | String | Falsch | Die Revisionsnummer des Datensatzes vor der Aktualisierung der Beauftragten. Wenn die angegebene Revision nicht die neueste Revision ist, führt die Anfrage zu einem Fehler. |
GuestSpaceId | String | Falsch | Dieser Parameter wird für Apps verwendet, die sich im Gastbereich befinden. Fügen Sie diesen Parameter nicht hinzu, wenn die Verbindungseigenschaft GuestSpaceId in der Verbindungszeichenfolge angegeben ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Revision | String | Die Revisionsnummer des Datensatzes nach der Aktualisierung des Status. Die Revisionsnummer erhöht sich um 2, da zwei Vorgänge ausgeführt werden: Ausführen der Aktion und Aktualisieren des Status. |
UpdateStatus
Aktualisiert den Status eines App-Datensatzes.
Hinweis
Dieses Verfahren verwendet indizierte Parameter.
Indizierte Parameter erleichtern die Bereitstellung mehrerer Instanzen eines einzelnen Parameters als Eingaben für das Verfahren.
Nehmen wir an, es gibt einen Eingabeparameter mit dem Namen Param#. Um mehrere Instanzen eines indexierten Parameters wie diesen einzugeben, führen Sie Folgendes aus:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
In der folgenden Tabelle sind indexierte Parameter mit einem gekennzeichnet #
-Zeichen am Ende ihrer Namen.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AppId | String | True | Die App-ID. |
RecordId# | String | True | Die Datensatz-ID. |
Action# | String | True | Der Name der Aktion, die Sie ausführen möchten. Wenn die Lokalisierungsfunktion verwendet wurde, um mehrere Übersetzungen der Aktion anzuwenden, geben Sie den Namen der Aktion in den Spracheinstellungen des Benutzers an, der die API ausführen wird. |
Assignee# | String | Falsch | Der nächste Bevollmächtigte. Geben Sie den Anmeldenamen des Bevollmächtigten an. |
Revision# | String | Falsch | Die Revisionsnummer des Datensatzes vor der Aktualisierung des Status. Wenn die angegebene Revision nicht die neueste Revision ist, führt die Anfrage zu einem Fehler. |
GuestSpaceId | String | Falsch | Dieser Parameter wird für Apps verwendet, die sich im Gastbereich befinden. Fügen Sie diesen Parameter nicht hinzu, wenn die Verbindungseigenschaft GuestSpaceId in der Verbindungszeichenfolge angegeben ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Id | String | Die Datensatz-ID. |
Revision | String | Die Revisionsnummer des Datensatzes nach der Aktualisierung des Status. Die Revisionsnummer erhöht sich um 2, da zwei Vorgänge ausgeführt werden - Ausführen der Aktion und Aktualisieren des Status. |
UpdateThread
Aktualisiert einen Thread eines Spaces.
Gespeicherte Prozedurspezifische Informationen
Kintone erlaubt nur die Verwendung einer kleinen Teilmenge von Spalten in der Exec Abfrage. Diese Spalten können normalerweise nur mit =-Vergleichen verwendet werden. Beispiel:
EXECUTE UpdateThread ThreadId = 13, Name = 'Test Thread', Body = 'This is for testing'
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
ThreadId | Integer | True | Die Thread-ID. Die Thread-ID befindet sich in der URL des Threads. |
Name | String | Falsch | Der neue Name des Threads. Muss zwischen 1 und 128 Zeichen lang sein. Der Name wird nicht aktualisiert, wenn dieser Parameter ignoriert wird. Der Thread-Name von Single-Thread-Spaces kann nicht aktualisiert werden. |
Body | String | Falsch | Der Inhalt des Thread-Textkörpers. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Success | String | Dieser Wert gibt per Boolescher Wert an, ob der Operation erfolgreich war oder nicht. |
Datei hochladen
Lädt ein Dokument in Kintone hoch.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
FullPath | String | Falsch | Der vollständige Pfad zum hochzuladenden Dokument. Ein Wert für dieses Feld ist erforderlich, wenn FileData nicht angegeben ist. |
FileData | String | Falsch | Wenn die Eingabe „FullPath“ leer ist, geben Sie bitte BASE64-codierte FileData ein. |
FileName | String | Falsch | Der Name, den Sie dem Dokument geben möchten. Wenn keiner angegeben ist, wird der in der Eingabe „FullPath“ angegebene Dateiname verwendet. |
ContentType | String | Falsch | Inhaltstyp der Datei. |
GuestSpaceId | String | Falsch | Dieser Parameter wird für Dokumente verwendet, die sich im Gastbereich befinden. Fügen Sie diesen Parameter nicht hinzu, wenn die Verbindungseigenschaft GuestSpaceId in der Verbindungszeichenfolge angegeben ist. |
AttachToApp | String | Falsch | Dieser Parameter ist vom Typ Boolesch und standardmäßig auf „Falsch“ eingestellt. Er wird verwendet, um die Datei an ein Anhangsfeld einer App anzuhängen. |
UploadedFileKey | String | Falsch | Die ID der hochgeladenen Datei. Dies ist erforderlich, wenn AttachToApp auf „true“ gesetzt ist und Content, FileData oder FullPath nicht angegeben sind. |
AppId | String | Falsch | Die Kintone App-ID. Dies ist erforderlich, wenn AttachToApp auf „true“ gesetzt ist. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
FileKey | String | Die ID der hochgeladenen Datei. |
Success | String | Ob der Operation erfolgreich war oder nicht. |
Id | String | Die Datensatz-ID der hochgeladenen Datei. Wird zurückgegeben, wenn die Anfrage mit dem Attach-Parameter gefiltert wird. |
Revision | String | Die Revisionsnummer des Datensatzes nach der Aktualisierung des Status. Die Revisionsnummer wird um 2 erhöht, da zwei Vorgänge ausgeführt werden - Ausführen der Aktion und Aktualisieren des Status. Wird zurückgegeben, wenn die Anfrage mit dem Parameter „Anhängen“ gefiltert wird. |
Systemtabellen
Sie können die in diesem Abschnitt beschriebenen Systemtabellen Abfrage, um auf Schema, Informationen zur Datenquellenfunktionalität und Statistiken zu Operation Charge.
Schematabellen
Die folgenden Tabellen geben Datenbankmetadaten für Kintone zurück:
- sys_catalogs: Listet die verfügbaren Datenbanken auf.
- sys_schemas: Listet die verfügbaren Schemata auf.
- sys_tables: Listet die verfügbaren Tabellen und Ansichten auf.
- sys_tablecolumns: Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
- sys_procedures: Beschreibt die verfügbaren gespeicherten Prozeduren.
- sys_procedureparameters: Beschreibt Parameter gespeicherter Prozeduren.
- sys_keycolumns: Beschreibt die Primär- und Fremdschlüssel.
- sys_indexes: Beschreibt die verfügbaren Indizes.
Datenquellentabellen
Die folgenden Tabellen enthalten Informationen dazu, wie eine Verbindung zur Datenquelle hergestellt und diese Abfrage wird:
- sys_connection_props: Gibt Informationen zu den verfügbaren Verbindungseigenschaften zurück.
- sys_sqlinfo: Beschreibt die SELECT-Abfragen, die der Connector an die Datenquelle auslagern kann.
Abfrageinformationstabellen
Die folgende Tabelle gibt Abfrage für Datenänderungsabfragen zurück, einschließlich Charge:
- Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.
Sys_catalogs
Listet die verfügbaren Datenbanken auf.
Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:
SELECT * FROM sys_catalogs
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
Sys_schemas
Listet die verfügbaren Schemas auf.
Die folgende Abfrage ruft alle verfügbaren Schemata ab:
SELECT * FROM sys_schemas
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Datenbankname. |
SchemaName | String | Der Schema. |
Sys_tables
Listet die verfügbaren Tabellen auf.
Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:
SELECT * FROM sys_tables
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht. |
TableType | String | Der Tabellentyp (Tabelle oder Ansicht). |
Description | String | Eine Beschreibung der Tabelle oder Ansicht. |
IsUpdateable | Boolean | Ob die Tabelle aktualisiert werden kann. |
Sys_tablecolumns
Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.
Die folgende Abfrage gibt die Spalten und Datentypen für die Tabelle „Kommentare“ zurück:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Comments'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die die Tabelle oder Ansicht enthält. |
SchemaName | String | Das Schema, das die Tabelle oder Ansicht enthält. |
TableName | String | Der Name der Tabelle oder Ansicht, die die Spalte enthält. |
ColumnName | String | Der Spaltenname. |
DataTypeName | String | Der Name des Datentyps. |
DataType | Int32 | Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt. |
Length | Int32 | Die Speichergröße der Spalte. |
DisplaySize | Int32 | Die normale Maximalbreite der angegebenen Spalte in Zeichen. |
NumericPrecision | Int32 | Die maximale Anzahl von Ziffern in numerischen Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten. |
NumericScale | Int32 | Die Spaltenskala oder Anzahl der Ziffern rechts vom Dezimalpunkt. |
IsNullable | Boolean | Ob die Spalte Null enthalten kann. |
Description | String | Eine kurze Beschreibung der Spalte. |
Ordinal | Int32 | Die Sequenznummer der Spalte. |
IsAutoIncrement | String | Ob der Spaltenwert in festen Schritten zugewiesen wird. |
IsGeneratedColumn | String | Ob die Spalte generiert wird. |
IsHidden | Boolean | Ob die Spalte ausgeblendet ist. |
IsArray | Boolean | Ob die Spalte ein Array ist. |
IsReadOnly | Boolean | Ob die Spalte schreibgeschützt ist. |
IsKey | Boolean | Gibt an, ob ein von sys_tablecolumns zurückgegebenes Feld der Primärschlüssel der Tabelle ist. |
Sys_procedures
Listet die verfügbaren gespeicherten Prozeduren auf.
Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:
SELECT * FROM sys_procedures
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Die Datenbank, die die gespeicherte Prozedur enthält. |
SchemaName | String | Das Schema, das die gespeicherte Prozedur enthält. |
ProcedureName | String | Der Name der gespeicherten Prozedur. |
Description | String | Eine Beschreibung der gespeicherten Prozedur. |
ProcedureType | String | Der Typ der Prozedur, z. B. PROZEDUR oder FUNKTION. |
Sys_procedureparameters
Beschreibt Parameter gespeicherter Prozeduren.
Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur DownloadFile zurück:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='DownloadFile' AND Direction=1 OR Direction=2
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die die gespeicherte Prozedur enthält. |
SchemaName | String | Der Name des Schema, das die gespeicherte Prozedur enthält. |
ProcedureName | String | Der Name der gespeicherten Prozedur, die den Parameter enthält. |
ColumnName | String | Der Name des gespeicherten Prozedurparameters. |
Direction | Int32 | Eine Ganzzahl, die dem Typ des Parameters entspricht: Eingabe (1), Eingabe/Ausgabe (2) oder Ausgabe (4). Parameter vom Typ Eingabe/Ausgabe können sowohl Eingabe- als auch Ausgabeparameter sein. |
DataTypeName | String | Der Name des Datentyps. |
DataType | Int32 | Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt. |
Length | Int32 | Die Anzahl der für Zeichendaten zulässigen Zeichen. Die Anzahl der für numerische Daten zulässigen Ziffern. |
NumericPrecision | Int32 | Die maximale Genauigkeit für numerische Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten. |
NumericScale | Int32 | Die Anzahl der Ziffern rechts vom Dezimalkomma in numerischen Daten. |
IsNullable | Boolean | Ob der Parameter Null enthalten kann. |
IsRequired | Boolean | Ob der Parameter zur Ausführung der Prozedur erforderlich ist. |
IsArray | Boolean | Ob der Parameter ein Array ist. |
Description | String | Die Beschreibung des Parameters. |
Ordinal | Int32 | Der Index des Parameters. |
Sys_keycolumns
Beschreibt die Primär- und Fremdschlüssel.
Die folgende Abfrage ruft den Primärschlüssel für die Tabelle „Kommentare“ ab:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Comments'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
IsKey | Boolean | Ob die Spalte ein Primärschlüssel in der Tabelle ist, auf die im Feld „TableName“ verwiesen wird. |
IsForeignKey | Boolean | Ob die Spalte ein Fremdschlüssel ist, auf den im Feld TableName verwiesen wird. |
PrimaryKeyName | String | Der Name des Primärschlüssels. |
ForeignKeyName | String | Der Name des Fremdschlüssels. |
ReferencedCatalogName | String | Die Datenbank, die den Primärschlüssel enthält. |
ReferencedSchemaName | String | Das Schema, das den Primärschlüssel enthält. |
ReferencedTableName | String | Die Tabelle, die den Primärschlüssel enthält. |
ReferencedColumnName | String | Der Spaltenname des Primärschlüssels. |
Sys_foreignkeys
Beschreibt die Fremdschlüssel.
Die folgende Abfrage ruft alle Fremdschlüssel ab, die auf andere Tabellen verweisen:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
PrimaryKeyName | String | Der Name des Primärschlüssels. |
ForeignKeyName | String | Der Name des Fremdschlüssels. |
ReferencedCatalogName | String | Die Datenbank, die den Primärschlüssel enthält. |
ReferencedSchemaName | String | Das Schema, das den Primärschlüssel enthält. |
ReferencedTableName | String | Die Tabelle, die den Primärschlüssel enthält. |
ReferencedColumnName | String | Der Spaltenname des Primärschlüssels. |
ForeignKeyType | String | Gibt an, ob der Fremdschlüssel ein Importschlüssel (zeigt auf andere Tabellen) oder ein Exportschlüssel (referenziert von anderen Tabellen) ist. |
Sys_primarykeys
Beschreibt die Primärschlüssel.
Die folgende Abfrage ruft die Primärschlüssel aus allen Tabellen und Ansichten ab:
SELECT * FROM sys_primarykeys
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Schlüssel enthält. |
SchemaName | String | Der Name des Schema, das den Schlüssel enthält. |
TableName | String | Der Name der Tabelle, die den Schlüssel enthält. |
ColumnName | String | Der Name der Schlüsselspalte. |
KeySeq | String | Die Sequenznummer des Primärschlüssels. |
KeyName | String | Der Name des Primärschlüssels. |
Sys_indexes
Beschreibt die verfügbaren Indizes. Durch das Filtern nach Indizes können Sie selektivere Abfragen mit schnelleren Abfrage schreiben.
Die folgende Abfrage ruft alle Indizes ab, die keine Primärschlüssel sind:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Spalten
Name | Typ | Beschreibung |
---|---|---|
CatalogName | String | Der Name der Datenbank, die den Index enthält. |
SchemaName | String | Der Name des Schema, das den Index enthält. |
TableName | String | Der Name der Tabelle, die den Index enthält. |
IndexName | String | Der Indexname. |
ColumnName | String | Der Name der mit dem Index verknüpften Spalte. |
IsUnique | Boolean | Wahr, wenn der Index eindeutig ist. Andernfalls falsch. |
IsPrimary | Boolean | Wahr, wenn der Index ein Primärschlüssel ist. Andernfalls falsch. |
Type | Int16 | Ein ganzzahliger Wert, der dem Indextyp entspricht: Statistik (0), gruppiert (1), gehasht (2) oder Sonstiges (3). |
SortOrder | String | Die Sortierreihenfolge: A für aufsteigend oder D für absteigend. |
OrdinalPosition | Int16 | Die Sequenznummer der Spalte im Index. |
Sys_connection_props
Gibt Informationen zu den verfügbaren Verbindungseigenschaften und den in der Verbindungszeichenfolge festgelegten Eigenschaften zurück.
Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:
jdbc:cdata:kintone:config:
Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.
Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:
SELECT * FROM sys_connection_props WHERE Value <> ''
Spalten
Name | Typ | Beschreibung |
---|---|---|
Name | String | Der Name der Verbindungseigenschaft. |
ShortDescription | String | Eine kurze Beschreibung. |
Type | String | Der Datentyp der Verbindungseigenschaft. |
Default | String | Der Standardwert, sofern nicht explizit einer festgelegt wurde. |
Values | String | Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben. |
Value | String | Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard. |
Required | Boolean | Ob für die Immobilie eine Anschlusspflicht besteht. |
Category | String | Die Kategorie der Verbindungseigenschaft. |
IsSessionProperty | String | Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird. |
Sensitivity | String | Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird. |
PropertyName | String | Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise. |
Ordinal | Int32 | Der Index des Parameters. |
CatOrdinal | Int32 | Der Index der Parameterkategorie. |
Hierarchy | String | Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen. |
Visible | Boolean | Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist. |
ETC | String | Diverse sonstige Informationen zum Objekt. |
Sys_sqlinfo
Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.
Entdecken der SELECT-Funktionen der Datenquelle
Nachfolgend sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.
Name | Beschreibung | Mögliche Werte |
---|---|---|
AGGREGATE_FUNCTIONS | Unterstützte Aggregatfunktionen. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Ob die COUNT-Funktion unterstützt wird. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. | ] |
SUPPORTED_OPERATORS | Eine Liste unterstützter SQL-Operatoren. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Unterstützte String-Funktionen. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Unterstützte numerische Funktionen. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Unterstützte Datums-/Uhrzeitfunktionen. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Zeigt an, dass während der Replikation Tabellen übersprungen wurden. | |
REPLICATION_TIMECHECK_COLUMNS | Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen. | |
IDENTIFIER_PATTERN | Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist. | |
SUPPORT_TRANSACTION | Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. | YES , NO |
DIALECT | Gibt den zu verwendenden SQL-Dialekt an. | |
KEY_PROPERTIES | Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren. | |
SUPPORTS_MULTIPLE_SCHEMAS | Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. | YES , NO |
DATASYNCVERSION | Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | Die Kategorie „Datensynchronisierung“ dieses Treiber. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Ob Charge Operationen unterstützt werden. | YES , NO |
SQL_CAP | Alle unterstützten SQL-Funktionen für diesen Treiber. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an. | |
ENABLE_EF_ADVANCED_QUERY | Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. | YES , NO |
PSEUDO_COLUMNS | Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt. | |
MERGE_ALWAYS | Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation. | |
REPLICATION_MIN_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll. | |
REPLICATION_START_DATE | Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben. | |
REPLICATION_MAX_DATE_QUERY | Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation. | |
REPLICATION_MAX_FUNCTION | Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird. | |
CHECKCACHE_USE_PARENTID | Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Gibt gespeicherte Prozeduren an, die zum Generieren von Schema verwendet werden können. |
Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; siehe Datenmodell Abschnitt für weitere Informationen.
Spalten
Name | Typ | Beschreibung |
---|---|---|
NAME | String | Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann. |
VALUE | String | Details zum unterstützten SQL bzw. zur SQL-Syntax. |
Systemidentität
Gibt Informationen zu versuchten Änderungen zurück.
Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:
SELECT * FROM sys_identity
Spalten
Name | Typ | Beschreibung |
---|---|---|
Id | String | Die von einer Operation zurückgegebene, von der Datenbank generierte ID. |
Batch | String | Eine Kennung für den Charge. 1 für einen einzelnen Operation. |
Operation | String | Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT. |
Message | String | SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist. |
Systeminformationen
Beschreibt die verfügbaren Systeminformationen.
Die folgende Abfrage ruft alle Spalten ab:
SELECT * FROM sys_information
Spalten
Name | Typ | Beschreibung |
---|---|---|
Product | String | Der Name des Produkts. |
Version | String | Die Versionsnummer des Produkts. |
Datasource | String | Der Name der Datenquelle, mit der das Produkt eine Verbindung herstellt. |
NodeId | String | Die eindeutige Kennung der Maschine, auf der das Produkt installiert ist. |
HelpURL | String | Die URL zur Hilfedokumentation des Produkts. |
License | String | Die Lizenzinformationen für das Produkt. (Wenn diese Informationen nicht verfügbar sind, kann das Feld leer gelassen oder als „N/A“ markiert werden.) |
Location | String | Der Dateipfad, in dem die Produktbibliothek gespeichert ist. |
Environment | String | Die Version der Umfeld oder Rumtine, unter der das Produkt derzeit ausgeführt wird. |
DataSyncVersion | String | Die zur Verwendung dieses Connectors erforderliche Synchronisierungsebene. |
DataSyncCategory | String | Die Kategorie der Synchronisierungsfunktionalität (z. B. Quelle, Ziel). |
Erweiterte Konfigurationseigenschaften
Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Ob eine Verbindung zu Kintone mit Benutzer/Passwort oder APIToken oder OAuth hergestellt werden soll. |
URL | Die Kintone URL. Beispiel: https://SUBDOMAIN_NAME.cybozu.com . |
User | Das zur Authentifizierung verwendete Kintone-Benutzerkonto. |
Password | Das zur Authentifizierung des Benutzers verwendete Kennwort. |
BasicAuthUser | Der zusätzliche Benutzername, der für Domänen mit Basisauthentifizierung erforderlich ist. |
BasicAuthPassword | Das zusätzliche Kennwort, das für Domänen mit Basisauthentifizierung erforderlich ist. |
AppId | Die AppId, die zusammen mit dem APIToken zur Authentifizierung verwendet wird. |
APIToken | Der zur Authentifizierung verwendete APIToken. |
Eigenschaft | Beschreibung |
---|---|
InitiateOAuth | Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten. |
OAuthClientId | Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthClientSecret | Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthAccessToken | Der Zugriffstoken für die Verbindung mittels OAuth. |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben. |
OAuthVerifier | Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. |
OAuthRefreshToken | Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken. |
OAuthExpiresIn | Die Lebensdauer des OAuth AccessToken in Sekunden. |
OAuthTokenTimestamp | Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde. |
Eigenschaft | Beschreibung |
---|---|
SSLClientCert | Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL). |
SSLClientCertType | Der Typ des Schlüsselspeichers, der das TLS/SSL-Client-Zertifikat enthält. |
SSLClientCertPassword | Das Passwort für das TLS/SSL-Client-Zertifikat. |
SSLClientCertSubject | Der Betreff des TLS/SSL-Client-Zertifikats. |
Eigenschaft | Beschreibung |
---|---|
Location | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
BrowsableSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC. |
Views | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC. |
Eigenschaft | Beschreibung |
---|---|
AllowSpecialCharacters | Legt fest, ob Sonderzeichen zulässig sind oder nicht. Wenn dies der Fall ist, werden Sonderzeichen nicht ersetzt. |
CheckForSubtablesIn | Eine durch Kommas getrennte Liste von Kintone-Apps, aus denen Untertabellen abgerufen werden sollen. |
GuestSpaceId | Abfrage auf einen Gastbereich beschränken. |
MaxRows | Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln. |
NumberMapToDouble | Bestimmt, ob der Datentyp von Zahlenfeldern von Dezimal in Double geändert werden soll oder nicht. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
Pagesize | Die maximale Anzahl der von Kintone zurückzugebenden Ergebnisse pro Seite. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
SubtableSeparatorCharacter | Das zum Trennen von Tabellen und Untertabellen verwendete Zeichen im Format Tabellenname + Zeichen + Untertabelle. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UseCodeForFieldName | Bestimmt, ob für den Feldnamen eine Bezeichnung oder ein Code verwendet werden soll. |
UseCursor | Boolescher Wert, der bestimmt, ob Cursor zum Abrufen von Datensätzen verwendet werden sollen. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
UseSimpleNames | Boolescher Wert, der bestimmt, ob für Tabellen und Spalten einfache Namen verwendet werden sollen. |
UseUnitForNumericField | Bestimmt, ob die Einheit mit dem Feldnamen angezeigt werden soll. |
Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Ob eine Verbindung zu Kintone mit Benutzer/Passwort oder APIToken oder OAuth hergestellt werden soll. |
URL | Die Kintone URL. Beispiel: https://SUBDOMAIN_NAME.cybozu.com . |
User | Das zur Authentifizierung verwendete Kintone-Benutzerkonto. |
Password | Das zur Authentifizierung des Benutzers verwendete Kennwort. |
BasicAuthUser | Der zusätzliche Benutzername, der für Domänen mit Basisauthentifizierung erforderlich ist. |
BasicAuthPassword | Das zusätzliche Kennwort, das für Domänen mit Basisauthentifizierung erforderlich ist. |
AppId | Die AppId, die zusammen mit dem APIToken zur Authentifizierung verwendet wird. |
APIToken | Der zur Authentifizierung verwendete APIToken. |
AuthScheme
Ob die Verbindung zu Kintone mit Benutzer/Passwort oder APIToken oder OAuth hergestellt werden soll.
Mögliche Werte
Password
, APIToken
, OAuth
Datentyp
string
Standardwert
Password
Hinweise
-
Passwort: Legen Sie dies fest, um eine Passwortauthentifizierung durchzuführen.
-
APIToken: Legen Sie dies fest, um eine APIToken-Authentifizierung durchzuführen.
-
OAuth: Legen Sie dies fest, um eine OAuth 2.0-Authentifizierung durchzuführen.
URL
Die Kintone URL. Beispiel: https://SUBDOMAIN_NAME.cybozu.com
.
Datentyp
string
Standardwert
""
Hinweise
Die Kintone URL. Beispiel:
https://SUBDOMAIN_NAME.cybozu.com
Benutzer
Das zur Authentifizierung verwendete Kintone-Benutzerkonto.
Datentyp
string
Standardwert
""
Hinweise
Zusammen mit Passwort, dieses Feld wird zur Authentifizierung gegenüber dem Kintone-Server verwendet.
Passwort
Das zur Authentifizierung des Benutzers verwendete Passwort.
Datentyp
string
Standardwert
""
Hinweise
Der Benutzer Und Password
werden zusammen zur Authentifizierung beim Server verwendet.
Basisauthentifzierung
Der zusätzliche Benutzername, der für Domänen mit Basisauthentifizierung erforderlich ist.
Datentyp
string
Standardwert
""
Hinweise
Der Benutzername für die Basisauthentifizierung, der für die Verbindung mit Domänen mit aktivierter Basisauthentifizierung verwendet wird. Die Basisauthentifizierung bietet eine doppelte Authentifizierung: Wenn Sie eine Verbindung mit einer Domäne mithilfe der Basisauthentifizierung herstellen, setzen Sie BasicAuthUser
und BasicAuthPassword zusätzlich zu Benutzer und Passwort.
Grundlegendes Auth-Passwort
Das zusätzliche Passwort, das für Domänen mit Basisauthentifizierung erforderlich ist.
Datentyp
string
Standardwert
""
Hinweise
Das grundlegende Authentifizierungskennwort, das zum Herstellen einer Verbindung mit Domänen mit aktivierter grundlegender Authentifizierung verwendet wird. Die grundlegende Authentifizierung bietet eine doppelte Authentifizierung: Wenn Sie eine Verbindung mit einer Domäne mithilfe der grundlegenden Authentifizierung herstellen, legen Sie BasicAuthUser fest Und BasicAuthPassword
zusätzlich zu Benutzer und Passwort.
AppId
Die AppId, die zusammen mit dem APIToken zur Authentifizierung verwendet wird.
Datentyp
string
Standardwert
""
Hinweise
Die AppId ist die Nummer dieser bestimmten App in der Sequenz unter Apps im Kintone UI-Dashboard.
Sie können auch mehrere durch Kommas getrennte AppIds angeben.
APIToken
Der zur Authentifizierung verwendete APIToken.
Datentyp
string
Standardwert
""
Hinweise
Das zur Authentifizierung verwendete API-Token. So erstellen Sie ein API Token: Rufen Sie die jeweilige App auf, für die Sie die API Token erstellen möchten, und klicken Sie auf das Zahnrad. Gehen Sie zur Tab „App-Einstellungen“ > „API -Token“ > klicken Sie auf die Schaltfläche „Generieren“. Ein API Token wird generiert.
Sie können bei Vorgängen mit Nachschlagefeldern oder zugehörigen Datensatzfeldern auch mehrere durch Kommas getrennte API-Tokens angeben.
OAuth
Dieser Abschnitt enthält eine vollständige Liste der OAuth-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
InitiateOAuth | Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten. |
OAuthClientId | Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthClientSecret | Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren. |
OAuthAccessToken | Der Zugriffstoken für die Verbindung mittels OAuth. |
OAuthSettingsLocation | Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://' . |
CallbackURL | Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben. |
OAuthVerifier | Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. |
OAuthRefreshToken | Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken. |
OAuthExpiresIn | Die Lebensdauer des OAuth AccessToken in Sekunden. |
OAuthTokenTimestamp | Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde. |
OAuth initiieren
Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
Mögliche Werte
OFF
, GETANDREFRESH
, REFRESH
Datentyp
string
Standardwert
OFF
Hinweise
Folgende Optionen stehen zur Verfügung:
OFF
: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.GETANDREFRESH
: Gibt an, dass der gesamte OAuth-Flow vom Connector verarbeitet wird. Wenn derzeit kein Token vorhanden ist, wird es durch eine entsprechende Aufforderung an den Benutzer über den Browser abgerufen. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.REFRESH
: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessToken übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessToken und des OAuthRefreshToken übernehmen.
OAuthClientId
Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Datentyp
string
Standardwert
""
Hinweise
Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId
-Wert, manchmal auch Consumer-Schlüssel genannt, und ein Client-Geheimnis, das OAuthClientSecret.
OAuthClientSecret
Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Datentyp
string
Standardwert
""
Hinweise
Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId, auch Consumer-Schlüssel genannt. Sie erhalten außerdem ein Client-Geheimnis, auch Consumer-Geheimnis genannt. Legen Sie das Client-Geheimnis im OAuthClientSecret
Eigentum.
OAuth-Zugriffstoken
Der Zugriffstoken für die Verbindung per OAuth.
Datentyp
string
Standardwert
""
Hinweise
Der OAuthAccessToken
Eigenschaft wird für die Verbindung über OAuth verwendet. Die OAuthAccessToken
wird im Rahmen des Authentifizierungsprozesses vom OAuth-Server abgerufen. Es hat ein serverabhängiges Timeout und kann zwischen Anfragen wiederverwendet werden.
Das Zugriffstoken wird anstelle Ihres Benutzernamens und Passworts verwendet. Das Zugriffstoken schützt Ihre Anmeldeinformationen, indem es sie auf dem Server speichert.
OAuthSettingsLocation
Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'
.
Datentyp
string
Standardwert
%APPDATA%\Kintone Data Provider\OAuthSettings.txt
Hinweise
Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH
oder REFRESH
, der Connector speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.
Anstatt einen Dateipfad anzugeben, können Sie den Speicher verwenden. Speicherorte werden durch einen Wert angegeben, der mit beginnt 'memory://'
gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_props
Systemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.
Der Standardspeicherort ist „%APPDATA%\ Kintone Data Provider\OAuthSettings.txt“ mit %APPDATA%
auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
- Mac: "%AppData%..."
wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.
Die folgende Tabelle listet den Wert von auf %APPDATA%
nach Operationssystem:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
Rückruf-URL
Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
Datentyp
string
Standardwert
""
Hinweise
Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
OAuthVerifier
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
Datentyp
string
Standardwert
""
Hinweise
Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.
Authentifizierung auf Headless-Maschinen
Siehe, um die zu erhalten OAuthVerifier
Wert.
OAuthSettingsLocation festlegen zusammen mit OAuthVerifier
. Beim Verbinden tauscht der Connector die OAuthVerifier
für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.
Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier
aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.
Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.
OAuthRefreshToken
Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
Datentyp
string
Standardwert
""
Hinweise
Der OAuthRefreshToken
Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.
OAuthLäuftAbIn
Die Lebensdauer des OAuth AccessToken in Sekunden.
Datentyp
string
Standardwert
""
Hinweise
Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann der AccessToken abläuft.
OAuthTokenTimestamp
Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.
Datentyp
string
Standardwert
""
Hinweise
Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.
SSL
Dieser Abschnitt enthält eine vollständige Liste der SSL-Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
SSLClientCert | Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL). |
SSLClientCertType | Der Typ des Schlüsselspeichers, der das TLS/SSL-Client-Zertifikat enthält. |
SSLClientCertPassword | Das Passwort für das TLS/SSL-Client-Zertifikat. |
SSLClientCertSubject | Der Betreff des TLS/SSL-Client-Zertifikats. |
SSLClientCert
Der TLS/SSL-Client-Zertifikatspeicher für die SSL-Client-Authentifizierung (bidirektionales SSL).
Datentyp
string
Standardwert
""
Hinweise
Der Name des Zertifikatspeichers für das Client-Zertifikat.
Der SSLClientCertType Feld gibt den Typ des durch angegebenen Zertifikatspeichers an SSLClientCert
. Wenn der Store kennwortgeschützt ist, geben Sie das Kennwort in SSLClientCertPassword an.
SSLClientCert
wird in Verbindung mit SSLClientCertSubject verwendet, um Client-Zertifikate anzugeben. Wenn SSLClientCert
hat einen Wert und SSLClientCertSubject gesetzt ist, wird eine Suche nach einem Zertifikat eingeleitet. Siehe SSLClientCertSubject für weitere Informationen.
Die Bezeichnungen der Zertifikatsspeicher sind plattformabhängig.
Nachfolgend sind die Bezeichnungen der gebräuchlichsten Benutzer- und Maschinen-Zertifikatspeicher in Windows aufgeführt:
Eigenschaft | Beschreibung |
---|---|
MY | Ein Zertifikatsspeicher, der persönliche Zertifikate mit den zugehörigen privaten Schlüsseln enthält. |
CA | Zertifikate der Zertifizierungsstelle. |
ROOT | Stammzertifikate. |
SPC | Zertifikate von Softwareherstellern. |
In Java ist der Zertifikatsspeicher normalerweise eine Datei, die Zertifikate und optionale private Schlüssel enthält.
Wenn der Zertifikatsspeichertyp PFXFile ist, muss diese Eigenschaft auf den Namen der Datei gesetzt werden. Wenn der Typ PFXBlob ist, muss die Eigenschaft auf den binären Inhalt einer PFX-Datei gesetzt werden (z. B. PKCS12-Zertifikatsspeicher).
SSLClientCertType
Der Typ des Schlüsselspeichers, der das TLS/SSL-Clientzertifikat enthält.
Mögliche Werte
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Datentyp
string
Standardwert
USER
Hinweise
Diese Eigenschaft kann einen der folgenden Werte annehmen:
Eigenschaft | Beschreibung |
---|---|
USER - default | Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Zertifikatspeicher handelt, der dem aktuellen Benutzer gehört. Beachten Sie, dass dieser Speichertyp in Java nicht verfügbar ist. |
MACHINE | Unter Windows gibt dies an, dass es sich bei dem Zertifikatspeicher um einen Maschinenspeicher handelt. Beachten Sie, dass dieser Speichertyp in Java nicht verfügbar ist. |
PFXFILE | Der Zertifikatsspeicher ist der Name einer PFX-Datei (PKCS12), die Zertifikate enthält. |
PFXBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen Zertifikatsspeicher im PFX-Format (PKCS12) darstellt. |
JKSFILE | Der Zertifikatsspeicher ist der Name einer Java Key Store (JKS)-Datei, die Zertifikate enthält. Beachten Sie, dass dieser Speichertyp nur in Java verfügbar ist. |
JKSBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen Zertifikatsspeicher im JKS-Format darstellt. Beachten Sie, dass dieser Speichertyp nur in Java verfügbar ist. |
PEMKEY_FILE | Der Zertifikatsspeicher ist der Name einer PEM-codierten Datei, die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PEMKEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (base64-codiert), die einen privaten Schlüssel und ein optionales Zertifikat enthält. |
PUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
PUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die ein PEM- oder DER-codiertes öffentliches Schlüsselzertifikat enthält. |
SSHPUBLIC_KEY_FILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen öffentlichen Schlüssel im SSH-Stil enthält. |
SSHPUBLIC_KEY_BLOB | Der Zertifikatsspeicher ist eine Zeichenfolge (Base-64-codiert), die einen öffentlichen Schlüssel im SSH-Stil enthält. |
P7BFILE | Der Zertifikatsspeicher ist der Name einer PKCS7-Datei, die Zertifikate enthält. |
PPKFILE | Der Zertifikatsspeicher ist der Name einer Datei, die einen privaten PuTTY-Schlüssel (PPK) enthält. |
XMLFILE | Der Zertifikatsspeicher ist der Name einer Datei, die ein Zertifikat im XML-Format enthält. |
XMLBLOB | Der Zertifikatsspeicher ist eine Zeichenfolge, die ein Zertifikat im XML-Format enthält. |
SSLClientCertPassword
Das Passwort für das TLS/SSL-Client-Zertifikat.
Datentyp
string
Standardwert
""
Hinweise
Wenn der Zertifikatspeicher von einem Typ ist, der ein Passwort erfordert, wird diese Eigenschaft verwendet, um dieses Passwort zum Öffnen des Zertifikatspeichers anzugeben.
SSLClientCertSubject
Der Betreff des TLS/SSL-Client-Zertifikats.
Datentyp
string
Standardwert
*
Hinweise
Beim Laden eines Zertifikats wird der Betreff verwendet, um das Zertifikat im Speicher zu lokalisieren.
Wenn keine genaue Übereinstimmung gefunden wird, wird der Speicher nach Betreffs durchsucht, die den Wert der Eigenschaft enthalten. Wenn immer noch keine Übereinstimmung gefunden wird, wird die Eigenschaft auf eine leere Zeichenfolge gesetzt und kein Zertifikat ausgewählt.
Der spezielle Wert „*“ wählt das erste Zertifikat im Zertifikatspeicher aus.
Der Betreff des Zertifikats ist eine durch Kommas getrennte Liste von Distinguished Name-Feldern und-Werten. Beispiel: „CN=www.server.com, OU=test, C=US, E=support@company.com“. Die allgemeinen Felder und ihre Bedeutungen werden unten angezeigt.
Feld | Bedeutung |
---|---|
CN | Allgemeiner Name. Dies ist normalerweise ein Host wie www.server.com. |
O | Organisation |
OU | Organisationseinheit |
L | Ort |
S | Staat |
C | Land |
E | Email Adresse |
Wenn ein Feldwert ein Komma enthält, muss es in Anführungszeichen gesetzt werden.
Schema
Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
Location | Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren. |
BrowsableSchemas | Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC. |
Views | Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC. |
Standort
Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
Datentyp
string
Standardwert
%APPDATA%\Kintone Data Provider\Schema
Hinweise
Der Pfad zu einem Verzeichnis, das die Schema für den Connector enthält (.rsd-Dateien für Tabellen und Ansichten, .rsb-Dateien für gespeicherte Prozeduren). Der Ordnerspeicherort kann ein relativer Pfad vom Speicherort der ausführbaren Datei sein. Der Location
Die Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.
Wenn nichts angegeben wird, ist der Standardspeicherort "%APPDATA%\ Kintone Data Provider\Schema" mit %APPDATA%
wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:
Plattform | %APPDATA% |
---|---|
Windows | Der Wert der Umfeld APPDATA |
Mac | ~/Bibliothek/Anwendungsunterstützung |
Linux | ~/.config |
DurchsuchbareSchemas
Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Datentyp
string
Standardwert
""
Hinweise
Das Auflisten der Schemata aus Datenbanken kann aufwändig sein. Die Bereitstellung einer Liste von Schemata in der Verbindungszeichenfolge verbessert die Leistung.
Tabellen
Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC.
Datentyp
string
Standardwert
""
Hinweise
Das Auflisten der Tabellen aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Tabellen in der Verbindungszeichenfolge verbessert die Leistung des Connectors.
Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.
Geben Sie die gewünschten Tabellen in einer durch Kommas getrennten Liste an. Jede Tabelle sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.
Ansichten
Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC.
Datentyp
string
Standardwert
""
Hinweise
Das Auflisten der Ansichten aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Ansichten in der Verbindungszeichenfolge verbessert die Leistung des Connectors.
Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.
Geben Sie die gewünschten Ansichten in einer durch Kommas getrennten Liste an. Jede Ansicht sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.
Verschiedenes
Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AllowSpecialCharacters | Legt fest, ob Sonderzeichen zulässig sind oder nicht. Wenn dies der Fall ist, werden Sonderzeichen nicht ersetzt. |
CheckForSubtablesIn | Eine durch Kommas getrennte Liste von Kintone-Apps, aus denen Untertabellen abgerufen werden sollen. |
GuestSpaceId | Abfrage auf einen Gastbereich beschränken. |
MaxRows | Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln. |
NumberMapToDouble | Bestimmt, ob der Datentyp von Zahlenfeldern von Dezimal in Double geändert werden soll oder nicht. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
Pagesize | Die maximale Anzahl der von Kintone zurückzugebenden Ergebnisse pro Seite. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
SubtableSeparatorCharacter | Das zum Trennen von Tabellen und Untertabellen verwendete Zeichen im Format Tabellenname + Zeichen + Untertabelle. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UseCodeForFieldName | Bestimmt, ob für den Feldnamen eine Bezeichnung oder ein Code verwendet werden soll. |
UseCursor | Boolescher Wert, der bestimmt, ob Cursor zum Abrufen von Datensätzen verwendet werden sollen. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
UseSimpleNames | Boolescher Wert, der bestimmt, ob für Tabellen und Spalten einfache Namen verwendet werden sollen. |
UseUnitForNumericField | Bestimmt, ob die Einheit mit dem Feldnamen angezeigt werden soll. |
Sonderzeichen zulassen
Bestimmt, ob Sonderzeichen zulässig sind oder nicht. Wenn dies der Fall ist, werden Sonderzeichen nicht ersetzt.
Datentyp
bool
Standardwert
false
Hinweise
Bestimmt, ob Sonderzeichen zulässig sind oder nicht. Wenn dies der Fall ist, werden Sonderzeichen nicht ersetzt.
CheckForSubtablesIn
Eine durch Kommas getrennte Liste von Kintone-Apps, aus denen Untertabellen abgerufen werden sollen.
Datentyp
string
Standardwert
*
Hinweise
Setzen Sie dieses Feld auf *, um in allen Kintone Apps nach Untertabellen zu suchen. Setzen Sie dieses Feld auf „Keine“, um nicht nach Untertabellen zu suchen. Kintone-Untertabellen werden als separate Tabellen angezeigt und das Abrufen der Liste aller Untertabellen aus der API ist ein zeitaufwändiger Operation. Indem Sie in diesem Feld nur einige App-Namen angeben, erhöht sich die Leistung des Connectors. Sie können dieses Feld auch auf * setzen, um in allen Kintone-Apps nach Untertabellen zu suchen. Beachten Sie jedoch, dass das Auflisten der Tabellen bei einer großen Anzahl von Apps viel länger dauert.
Gastbereichs-ID
Beschränken Sie die Abfrage auf einen Gastbereich.
Datentyp
string
Standardwert
""
Hinweise
Diese Verbindungseigenschaft beschränkt die Abfrage auf den angegebenen Gastbereich.
Sie finden die GuestSpaceId vom Connector in der Spalte „SpaceId“ der Tabelle „Apps“. Oder rufen Sie die GuestSpaceId aus der URL ab, wenn Sie zum erstellten Bereich navigieren. In der folgenden URL wäre die GuestSpaceId beispielsweise „3“:
https://xlqc1.cybozu.com/k/guest/3/#/space/3/thread/3
MaxRows
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
Datentyp
int
Standardwert
-1
Hinweise
Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
NumberMapToDouble
Bestimmt, ob der Datentyp von Zahlenfeldern von Dezimal auf Double geändert werden soll oder nicht.
Datentyp
bool
Standardwert
false
Hinweise
Bestimmt, ob der Datentyp von Zahlenfeldern von Dezimal auf Double geändert werden soll oder nicht. Wenn „true“, wird der Datentyp von Dezimal auf Double geändert.
Andere
Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
Datentyp
string
Standardwert
""
Hinweise
Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.
Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.
Integration und Formatierung
Eigenschaft | Beschreibung |
---|---|
DefaultColumnSize | Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000. |
ConvertDateTimeToGMT | Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen. |
RecordToFile=filename | Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei. |
Seitengröße
Die maximale Anzahl der Ergebnisse, die pro Seite von Kintone zurückgegeben werden sollen.
Datentyp
int
Standardwert
500
Hinweise
Der Pagesize
Die Eigenschaft beeinflusst die maximale Anzahl von Ergebnissen, die pro Seite von Kintone zurückgegeben werden. Das Festlegen eines höheren Wertes kann zu einer besseren Leistung führen, allerdings auf Kosten des zusätzlichen Speichers, der pro verbrauchter Seite zugewiesen wird.
Pseudospalten
Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
Datentyp
string
Standardwert
""
Hinweise
Diese Einstellung ist besonders hilfreich im Entity Framework, da Sie dort keinen Wert für eine Pseudospalte festlegen können, es sei denn, es handelt sich um eine Tabellenspalte. Der Wert dieser Verbindungseinstellung hat das Format „Tabelle1=Spalte1, Tabelle1=Spalte2, Tabelle2=Spalte3“. Sie können das Zeichen „*“ verwenden, um alle Tabellen und alle Spalten einzuschließen, z. B. „*=*“.
Untertabellentrennzeichen
Das zum Trennen von Tabellen und Untertabellen verwendete Zeichen im Format Tabellenname + Zeichen + Untertabelle.
Datentyp
string
Standardwert
_
Hinweise
Wenn eine App eine Untertabelle hat, wird diese als separate Tabelle dargestellt. Ihr Name lautet AppName + Untertabellentrennzeichen + Untertabellenname. Verwenden Sie diese Eigenschaft, um ein benutzerdefiniertes Zeichen als Trennzeichen festzulegen und Untertabellen einfach von Apps zu unterscheiden. Mit dieser Eigenschaft können Sie verschiedene Sonderzeichen im Namen der Untertabelle festlegen, ohne die Namenskonventionen Ihrer App zu verletzen.
Zeitüberschreitung
Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
Datentyp
int
Standardwert
60
Hinweise
Wenn Timeout
= 0, Operationen werden nicht abgebrochen. Die Operationen werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.
Wenn Timeout
abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.
CodeFürFeldnameVerwenden
Bestimmt, ob für den Feldnamen eine Bezeichnung oder ein Code verwendet werden soll.
Datentyp
bool
Standardwert
false
Hinweise
Wenn wahr, wird Code für Feldname verwendet.
Verwenden Sie den Cursor
Boolescher Wert, der bestimmt, ob Cursor zum Abrufen von Datensätzen verwendet werden sollen.
Datentyp
bool
Standardwert
true
Hinweise
Boolescher Wert, der bestimmt, ob Cursor zum Abrufen von Datensätzen verwendet werden sollen.
BenutzerdefinierteAnsichten
Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.
Datentyp
string
Standardwert
""
Hinweise
Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json
. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.
Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews
Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.
Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:
- Jedes Stammelement definiert den Namen einer Ansicht.
- Jedes Stammelement enthält ein untergeordnetes Element namens
query
, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.
Zum Beispiel:
{
"MyView": {
"query": "SELECT * FROM Comments WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Verwenden Sie die UserDefinedViews
Verbindungseigenschaft zur Angabe des Speicherorts Ihrer JSON-Konfigurationsdatei. Beispiel:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.
UseSimpleNames
Boolescher Wert, der bestimmt, ob einfache Namen für Tabellen und Spalten verwendet werden sollen.
Datentyp
bool
Standardwert
false
Hinweise
Kintone-Tabellen und-Spalten können Sonderzeichen in Namen verwenden, die in Standarddatenbanken normalerweise nicht zulässig sind. UseSimpleNames
macht den Connector mit herkömmlichen Datenbanktools einfacher zu verwenden.
Einstellung UseSimpleNames
auf true vereinfacht die Namen der zurückgegebenen Tabellen und Spalten. Es wird ein Benennungsschema erzwungen, sodass nur alphanumerische Zeichen und der Unterstrich für die angezeigten Tabellen- und Spaltennamen gültig sind. Alle nicht alphanumerischen Zeichen werden in einen Unterstrich umgewandelt.
EinheitFürNumerischesFeldVerwenden
Bestimmt, ob die Einheit mit dem Feldnamen angezeigt werden soll.
Datentyp
bool
Standardwert
true
Hinweise
Wenn auf „false“ gesetzt, wird die Einheit nicht mit dem Feldnamen angezeigt.