Details zur Basecamp Verbindung
Einführung
Connector-Version
Diese Dokumentation basiert auf Version 23.0.8803 des Connectors.
Erste Schritte
Unterstützung der Basecamp Version
Der Connector modelliert Basecamp 2- und Basecamp 3-Konten als bidirektionale Tabellen.
Herstellen einer Verbindung
Mit Basecamp verbinden
Legen Sie zusätzlich zur Authentifizierung die folgenden Verbindungseigenschaften fest, um auf Basecamp-Tabellen zuzugreifen.
-
Schema
: Setzen Sie dies auf „V2“ oder „V3“, um eine Verbindung mit einem Basecamp 2- oder Basecamp 3-Konto herzustellen. -
ProjectId
: Dies ist ein erforderlicher Parameter für die meisten Tabellenoperationen. Sie können die Tabelle „Projekte“ Abfrage, um diesen Wert zu erhalten.Wenn Sie das nicht angeben
ProjectId
Verbindungseigenschaft, der Connector verwendet die erste Projekt-ID, die von der Tabelle „Projekte“ bei Ihrer ersten Authentifizierung bei Basecamp zurückgegeben wird. -
AccountId
: Sie finden dieAccountId
in der URL, nachdem Sie sich in einem Webbrowser bei Basecamp angemeldet haben:http://basecamp.com/<AccountId>
Authentifizieren bei Basecamp
Basecamp 2 verwendet die Basisauthentifizierung oder OAuth 2.0-Authentifizierung. Sie können die Basisauthentifizierung verwenden, um sich mit Ihrem eigenen Konto zu verbinden, oder Sie können OAuth verwenden, um anderen Benutzern die Anmeldung bei ihren eigenen Konten zu ermöglichen.
Basecamp 3 erfordert OAuth 2.0.
Cookies-basis
Bei der Basisauthentifizierung verwenden Sie Ihre Anmeldeinformationen zum Herstellen einer Verbindung. Legen Sie die folgenden Eigenschaften fest:
User
: Dies ist der Benutzername, den Sie zum Anmelden bei Basecamp verwenden.Password
: Dies ist das Passwort, das Sie zum Anmelden bei Basecamp verwenden.AuthScheme
: Stellen Sie dies auf „Basic“ ein.
OAuth
AuthScheme
muss auf gesetzt werden OAuth
in allen Benutzerkonto-Flows.
Desktop-Anwendungen
Es wird eine eingebettete OAuth-Anwendung bereitgestellt, die die OAuth-Desktop-Authentifizierung vereinfacht. Alternativ können Sie eine benutzerdefinierte Anwendung erstellen. Siehe Erstellen einer benutzerdefinierten OAuth-App für Informationen zum Erstellen benutzerdefinierter Anwendungen und Gründe dafür.
Der einzige Unterschied zwischen den beiden Methoden zur Authentifizierung besteht darin, dass Sie bei Verwendung benutzerdefinierter OAuth-Anwendungen zwei zusätzliche Verbindungseigenschaften festlegen müssen.
Nachdem Sie die folgenden Verbindungseigenschaften festgelegt haben, können Sie eine Verbindung herstellen:
InitiateOAuth
: Setzen Sie dies aufGETANDREFRESH
. Sie können verwendenInitiateOAuth
um den OAuth-Austausch und das manuelle Setzen der zu vermeidenOAuthAccessToken
.OAuthClientId
: (nur benutzerdefinierte Anwendungen) Stellen Sie die Client-ID in Ihren Anwendungseinstellungen ein.OAuthClientSecret
: (nur benutzerdefinierte Anwendungen) Stellen Sie in Ihren Anwendungseinstellungen das Client-Geheimnis ein.
Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen. Der Connector schließt den OAuth-Prozess dann wie folgt ab:
- Extrahiert den Zugriffstoken aus der Rückruf URL.
- Erhält einen neuen Zugriffstoken, wenn der alte abläuft.
- Speichert OAuth-Werte in
OAuthSettingsLocation
damit sie über mehrere Verbindungen hinweg bestehen bleiben.
Erstellen einer benutzerdefinierten OAuth-App
Wann sollte eine benutzerdefinierte OAuth-App erstellt werden?
bettet OAuth-Anwendungsanmeldeinformationen mit Branding ein, die bei der Verbindung über eine Desktop-Anwendung oder von einem Headless-Computer aus verwendet werden können. Bei Verwendung einer Webanwendung ist jedoch das Erstellen einer benutzerdefinierten OAuth-Anwendung erforderlich. Sie können Ihre eigenen OAuth-Anwendungsanmeldeinformationen erstellen, wenn Sie Folgendes möchten:
- das Branding des Authentifizierungsdialogs steuern
- die Umleitungs-URI steuern, zu der die Anwendung den Benutzer nach der Authentifizierung umleitet
- die Berechtigungen anpassen möchten, die Sie vom Benutzer anfordern
Befolgen Sie die nachstehenden Schritte, um eine benutzerdefinierte OAuth-App zu erstellen und die Verbindungseigenschaften in einem bestimmten OAuth-Authentifizierungsablauf abzurufen.
Erstellen einer benutzerdefinierten OAuth-App
Registrieren Sie Ihre Basecamp App auf integrate.37signals.com
um die folgenden Verbindungseigenschaften zu erhalten:
OAuthClientId
OAuthClientSecret
CallbackURL
(nur Desktop)
Der einzige Unterschied zwischen Desktop-Anwendungen, Web-Anwendungen und Headless-Maschinen besteht darin, wie Sie die Umleitungs-URI festlegen:
-
Desktop-Anwendungen:
Legen Sie die Umleitungs-URI fest auf
http://localhost:portnumber
und setzeCallbackURL
passend. Sie können jeden verfügbaren Port angeben. -
Webanwendungen: Legen Sie die Umleitungs-URI auf eine Seite Ihrer Website fest. Auf diese Seite kehren Benutzer zurück, nachdem sie der Anwendung Berechtigungen erteilt haben.
-
Headless-Maschinen: Setzen Sie die Umleitungs-URI auf
http://localhost:portnumber
. Sie können jeden verfügbaren Port angeben.
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 Basecamp-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.
SSL-Konfiguration
Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert
-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.
Proxy
So konfigurieren Sie den Connector mit 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 Basecamp und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).
Benutzerdefinierte Ansichten
Mit dem Basecamp-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 Projects 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 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.
SSL-Konfiguration
Anpassen der SSL-Konfiguration
Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.
Um ein anderes Zertifikat anzugeben, siehe SSLServerCert
Eigenschaft für die verfügbaren Formate, um dies zu tun.
Datenmodell
Der Basecamp Connector modelliert die Basecamp 2- und Basecamp APIs als relationale Tabellen, Ansichten und gespeicherte Prozeduren. Diese werden in Schema definiert, bei denen es sich um einfache, textbasierte Konfigurationsdateien handelt.
Die verfügbaren Entitäten sowie alle API Einschränkungen und Anforderungen für die Abfrage dieser Entitäten sind im Basecamp 2-Datenmodell dokumentiert und Basecamp 3 Datenmodell.
Überblick
Die Datenmodelle zeigen ein Beispiel, wie Ihre Basecamp Umfeld aussehen könnte. Das eigentliche Datenmodell wird dynamisch basierend auf Ihrem Basecamp-Konto abgerufen.
Hauptmerkmale
- Tabellen und Ansichten werden dynamisch definiert, um Kalender, Dokumente und Projekte in Basecamp zu modellieren.
- Gespeicherte Prozeduren ermöglichen Ihnen, Vorgänge in Basecamp auszuführen, einschließlich des Herunterladens und Hochladens von Objekten.
- Die Live-Konnektivität zu diesen Objekten bedeutet, dass alle Änderungen an Ihrem Basecamp-Konto bei Verwendung des Connectors sofort angezeigt werden.
Basecamp 2-Datenmodell
Basecamp 2 Datenmodell beschreibt die Schemata, die für die Verbindung mit Basecamp 2-Konten verfügbar sind. Sie können Tabellen verwenden, um mit Live-Basecamp-Daten zu arbeiten. Sie können gespeicherte Prozeduren verwenden, die vom Basecamp Connector bereitgestellt werden, um die Arbeit mit Basecamp Daten zu automatisieren.
Basecamp 3-Datenmodell
Basecamp 3-Datenmodell beschreibt die Schemata, die für die Verbindung mit Basecamp 3-Konten verfügbar sind. Sie können Tabellen verwenden, um mit Live-Basecamp-Daten zu arbeiten. Sie können gespeicherte Prozeduren verwenden, die vom Basecamp Connector bereitgestellt werden, um die Arbeit mit Basecamp Daten zu automatisieren.
Basecamp 2-Datenmodell
Dieser Abschnitt dokumentiert die Tabellen, Ansichten und Gespeicherte Prozeduren zum Verbinden mit Basecamp 2-Konten verfügbar.
Tabellen
Der Connector modelliert die Daten in Basecamp als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.
Basecamp Connector-Tabellen
Name | Beschreibung |
---|---|
Accesses | Zugriffsberechtigungen für Projekte und Kalender auf Basecamp abrufen, erteilen und verweigern. |
CalendarEvents | Kalenderereignisse auf Basecamp abrufen, erstellen, aktualisieren und löschen. |
Calendars | Kalender auf Basecamp abrufen, erstellen, aktualisieren und löschen. |
Documents | Abrufen, Erstellen, Aktualisieren und Löschen von Dokumenten auf Basecamp. |
People | Personen auf Basecamp abrufen und löschen. |
Projects | Projekte auf Basecamp abrufen, erstellen, aktualisieren und löschen. |
Zugriffe
Rufen Sie Zugriffsberechtigungen für Projekte und Kalender auf Basecamp ab, erteilen Sie diese und verweigern Sie sie.
Tabellenspezifische Informationen
Wählen
Sie müssen eine ProjectId oder CalendarId angeben, um Zugriffe abzurufen. Diese Spalten sind auch die einzigen Spalten, die von Basecamp als Filterkriterien unterstützt werden; sie können mit dem Operator '=' verwendet werden.
SELECT * FROM Accesses WHERE ProjectId = '11111111'
SELECT * FROM Accesses WHERE CalendarId = '11111111'
Einfügen
Sie können jemandem über seine Email-Adresse oder ID Zugriff auf ein Projekt oder einen Kalender gewähren (sofern er bereits Teil der Organisation ist).
INSERT INTO Accesses (ProjectId, EmailAddresses) VALUES ('11111111', 'someone@example.com, someoneelse@example.com')
INSERT INTO Accesses (CalendarId, Ids) VALUES ('11111111', '123456789, 987654321')
Aktualisieren
UPDATE ist kein unterstützter Operation für die Tabellenzugriffe.
Löschen
Um jemandem den Zugriff auf ein Projekt oder einen Kalender zu entziehen, geben Sie die Projekt-ID oder Kalender-ID und die ID der Person an.
DELETE FROM Accesses WHERE ProjectId = '11111111' AND Id = '123456789'
DELETE FROM Accesses WHERE CalendarId = '11111111' AND ID = '123456789'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung der Person mit Zugriff auf das Projekt oder den Kalender. | |
Admin | Boolean | True | Boolescher Wert, um anzuzeigen, ob die aktuelle Person ein Administrator ist oder nicht. | |
AppUrl | String | True | Die App-URL. | |
AvatarUrl | String | True | Die Avatar-URL der Person. | |
CanCreateProjects | Boolean | Wahr | Ob die Person Projekte erstellen kann oder nicht. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Datensatzerstellung. | |
EmailAddress | String | True | Die Email-Adresse der Person mit Zugriff auf das Projekt oder den Kalender. | |
FullsizeAvatarUrl | String | True | Die Avatar-URL der Person in voller Größe. | |
IdentityId | String | True | Die Identitäts-ID der Person mit Zugriff auf das Projekt oder den Kalender. | |
IsClient | Boolean | Falsch | Ist der zurückgegebene Benutzer ein Kunde oder nicht. | |
Name | String | True | Der Name der Person mit Zugriff auf das Projekt oder den Kalender. | |
Trashed | Boolean | Falsch | Boolescher Wert für gelöschte Personen. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
URL | String | True | Die URL der Person. | |
Ids | String | Falsch | Eine durch Kommas getrennte Liste von Benutzer-IDs, denen Zugriff auf ein Projekt oder einen Kalender gewährt werden soll. | |
EmailAddresses | String | Falsch | Eine durch Kommas getrennte Liste von Benutzer-Email-Adressen, denen Zugriff auf ein Projekt oder einen Kalender gewährt werden soll. |
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 |
---|---|---|
ProjectId | String | Die mit dem Zugriff verknüpfte Projekt-ID. |
CalendarId | String | Die mit dem Zugriff verknüpfte Kalender-ID. |
KalenderVeranstaltungen
Rufen Sie Kalenderereignisse auf Basecamp ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Wählen
Basecamp unterstützt nur eine begrenzte Teilmenge von Spalten, die als Filterkriterien in der WHERE-Klausel verwendet werden können. Alle Booleschen Spalten für diese Tabelle können mit dem Operator „=“ verwendet werden. ProjectId, CalendarId, StartsAt und EndsAt können auch mit dem Operator „=“ verwendet werden. Darüber hinaus kann die Spalte StartsAt mit dem Operator „>=“ verwendet werden.
Die folgende Abfrage filtert nach einem bestimmten Zeitraum.
SELECT * FROM CalendarEvents WHERE StartsAt = '2016-01-01' AND EndsAt = '2016-02-01'
Die folgenden Abfragen erhalten Kalenderereignisse für ein bestimmtes Projekt oder einen bestimmten Kalender.
SELECT * FROM CalendarEvents WHERE ProjectId = '123456768'
SELECT * FROM CalendarEvents WHERE CalendarId = '123456768'
Einfügen
Geben Sie beim Erstellen eines neuen Kalenderereignisses die Projekt-ID oder Kalender-ID und „StartsAt“ an.
INSERT INTO CalendarEvents (ProjectId, Summary, Description, AllDay, StartsAt) VALUES ('12345678', 'My single, all-day Project event', 'Details to follow', 'true', 2016-02-01)
Aktualisieren und Löschen
Geben Sie beim Aktualisieren oder Löschen von Kalenderereignissen die Projekt-ID oder Kalender-ID und die Kalenderereignis-ID an.
UPDATE CalendarEvents SET Summary = 'Updated, two-day Project event', Description = 'Details to follow', AllDay = 'true', StartsAt = '2016-01-01', EndsAt = '2016-01-03' WHERE ProjectId = '12345678' AND Id = '12345678'
DELETE FROM CalendarEvents WHERE ProjectId = '12345678' AND ID = '12345678'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung für das Kalenderereignis. | |
AllDay | Boolean | Falsch | Ob das Kalenderereignis ein ganztägiges Ereignis ist. | |
AppUrl | String | True | Die App-URL. | |
BucketAppUrl | String | True | Die URL der Kalenderereignis-Bucket-App. | |
BucketColor | String | True | Die Farbe des Kalenderereignis-Buckets. | |
BucketId | String | True | Die Bucket-ID des Kalenderereignisses. | |
BucketName | String | True | Der Name des Kalenderereignis-Buckets. | |
BucketType | String | True | Der Bucket-Typ des Kalenderereignisses. | |
BucketUrl | String | True | Die URL des Kalenderereignis-Buckets. | |
CommentsCount | Integer | True | Die Anzahl der Kommentare zu diesem Kalenderereignis. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Erstellung des Kalenderereignisses. | |
CreatorAvatarUrl | String | Falsch | Ersteller-Avatar-URL. | |
CreatorFullsizeAvatarUrl | String | Falsch | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Falsch | Die ID des Erstellers des Kalenderereignisses. | |
CreatorName | String | Falsch | Der Name des Erstellers des Kalenderereignisses. | |
Description | String | Falsch | Die Beschreibung für das Kalenderereignis. | |
EndsAt | Datetime | Falsch | Das Enddatum und die Endzeit für das Kalenderereignis. | |
Past | Boolean | Falsch | Boolescher Wert für vergangene Kalenderereignisse. | |
Private | Boolean | Falsch | Ob dieses Kalenderereignis privat ist. | |
RemindAt | Datetime | Falsch | Datum und Uhrzeit der Kalenderereigniserinnerung. | |
StartsAt | Datetime | Falsch | Das Startdatum und die Startzeit für das Kalenderereignis. | |
SubscribersId | String | Falsch | Die ID des Abonnenten des Kalenderereignisses. | |
SubscribersName | String | Falsch | Der Name des Abonnenten des Kalenderereignisses. | |
Summary | String | Falsch | Die Zusammenfassung für das Kalenderereignis. | |
Trashed | Boolean | Falsch | Boolescher Wert für gelöschte Kalenderereignisse. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der Aktualisierung des Kalenderereignisses. | |
Url | String | True | Die URL des Kalenderereignisses. |
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 |
---|---|---|
ProjectId | String | Die ID des mit dem Kalenderereignis verknüpften Projekts. |
CalendarId | String | Die mit dem Kalenderereignis verknüpfte Kalender-ID. |
Kalender
Rufen Sie Kalender auf Basecamp ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Wählen
Wählen Sie alle Kalender aus oder geben Sie eine ID an, um weitere Details zu einem bestimmten Kalender abzurufen (die ID ist die einzige Spalte, die von Basecamp als Suchkriterium unterstützt wird).
SELECT * FROM Calendars WHERE ID = '123456789'
Einfügen
Geben Sie (mindestens) die Eigenschaft „Name“ an, um einen neuen Kalender unter der Organisation zu erstellen.
INSERT INTO Calendars (Name) VALUES ('New Test Calendar')
Aktualisieren und löschen
Geben Sie eine Kalender-ID an, um Kalender zu aktualisieren oder zu löschen. Legen Sie die Eigenschaft Name erneut fest, wenn Sie aktualisieren.
UPDATE Calendars SET Name = 'This is a new name for the Test Calendar.' WHERE Id = '123456789'
DELETE FROM Calendars WHERE ID = '123456789'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung für den Kalender. | |
AccessesAppUrl | String | True | Die App-URL, auf die zugegriffen wird. | |
AccessesCount | Integer | True | Die Zugriffe zählen. | |
AccessesUpdatedAt | Datetime | True | Der Zeitpunkt der Aktualisierung der Zugriffe. | |
AccessesUrl | String | True | Die Zugriffs URL. | |
AppUrl | String | True | Die App-URL. | |
CalendarEventsCount | Integer | Wahr | Anzahl der Kalenderereignisse. | |
CalendarEventsUpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Kalenderereignisses. | |
CalendarEventsUrlsPast | String | True | URL des letzten Kalenderereignisses. | |
CalendarEventsUrlsUpcoming | String | True | Datum und Uhrzeit der letzten Aktualisierung des Kalenders. | |
Color | String | Wahr | Die Farbe des Kalenders. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Dokumenterstellung. | |
CreatorAvatarUrl | String | Falsch | Ersteller-Avatar-URL. | |
CreatorFullsizeAvatarUrl | String | Falsch | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Falsch | Die ID des Erstellers des Kalenders. | |
CreatorName | String | Falsch | Der Name des Erstellers des Kalenders. | |
Name | String | Falsch | Der Name des Kalenders. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Kalenders. | |
Url | String | True | Die URL des Kalenders. |
Dokumente
Rufen Sie Dokumente auf Basecamp ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Wählen
Sie können alle Dokumente (für alle Projekte) abrufen, nur Dokumente auswählen, die zu einem bestimmten Projekt gehören, oder gleichzeitig ein Projekt und ein bestimmtes Dokument angeben (ProjectId und ID sind die einzigen Spalten, die von Basecamp als Suchkriterien unterstützt werden).
Sie können Dokumente auch nach „Aktualisiert am“, „Erstellt am“ oder „Titel“ sortieren.
SELECT * FROM Documents WHERE ProjectId = '11111111' AND Id = '1234567689'
SELECT * FROM Documents ORDER BY UpdatedAt
SELECT * FROM Documents ORDER BY Title DESC
Einfügen
Um einem größeren Projekt ein neues Dokument hinzuzufügen, geben Sie die Projekt-ID an und geben Sie den Titel oder Inhalt des Dokuments an.
INSERT INTO Documents (ProjectId, Title, Content) VALUES ('11111111', 'Memo', 'This is our document content')
Aktualisieren und Löschen
Geben Sie die Projekt-ID und die Dokument-ID an, um ein Dokument zu aktualisieren oder zu löschen.
UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND Id = '1234567689'
DELETE FROM Documents WHERE ProjectId = '11111111' AND ID = '12345678'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung für das Dokument. | |
AppUrl | String | True | Die App-URL. | |
BucketAppUrl | String | True | Die URL der Themen-Bucket-App. | |
BucketColor | String | True | Die Farbe des Aufgabeneimers. | |
BucketId | String | True | Die To-Do-Bucket-ID. | |
BucketName | String | True | Der Name des Aufgaben-Buckets. | |
BucketType | String | True | Der To-Do-Bucket-Typ. | |
BucketUrl | String | True | Die URL des Aufgabenbereichs. | |
Content | String | Falsch | Der Inhalt des Dokuments. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Dokumenterstellung. | |
CreatorAvatarUrl | String | Falsch | Ersteller-Avatar-URL. | |
CreatorFullsizeAvatarUrl | String | Falsch | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Falsch | Die ID des Erstellers des Dokuments. | |
CreatorName | String | Falsch | Der Name des Erstellers des Dokuments. | |
LastUpdaterId | String | Falsch | Die ID der Person, die das Dokument zuletzt aktualisiert hat. | |
LastUpdaterName | String | Falsch | Der Name der Person, die das Dokument zuletzt aktualisiert hat. | |
Private | Boolean | Falsch | Ob diese Aufgabe privat ist. | |
SubscribersId | String | Falsch | Die ID des Abonnenten des Dokuments. | |
SubscribersName | String | Falsch | Der Name des Abonnenten des Dokuments. | |
Title | String | Falsch | Der Titel des Dokuments. | |
Trashed | Boolean | False | Boolescher Wert für gelöschte Aufgaben. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Dokuments. | |
URL | String | True | Die URL des Dokuments. |
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 |
---|---|---|
ProjectId | String | Die ID des mit dem Dokument verknüpften Projekts. |
Menschen
Abrufen und Löschen von Personen auf Basecamp.
Tabellenspezifische Informationen
Wählen
Rufen Sie alle Personen aus der Organisation ab, geben Sie eine ID an, um weitere Informationen zu erhalten, oder sehen Sie, wer gelöscht wurde (Administratorzugriff erforderlich). „ID“ und „Papierkorb“ sind die Spalten, die Basecamp als Suchkriterien unterstützt.
SELECT * FROM People WHERE Id = '123456789'
SELECT * FROM People WHERE Trashed = true
EINFÜGEN
Neue Personen können direkt über die Zugriffstabelle zu Projekten eingeladen werden.
Aktualisieren
UPDATE ist für die Tabelle „Personen“ kein unterstützter Operation.
Löschen
Geben Sie die Personen-ID an, um den Datensatz aus der Organisation zu löschen.
DELETE FROM People WHERE ID = '123456789'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung für die Person. | |
AccountOwner | Boolean | True | Boolescher Wert, um anzuzeigen, ob die aktuelle Person der Kontoinhaber ist. | |
Admin | Boolean | True | Boolescher Wert, um anzuzeigen, ob die aktuelle Person ein Administrator ist oder nicht. | |
AssignedTodosCount | Integer | True | Anzahl der zugewiesenen Aufgaben. | |
AssignedTodosUpdatedAt | Datetime | True | Datum und Uhrzeit der Aktualisierung des Datensatzes. | |
AssignedTodosUrl | String | True | Die URL der zugewiesenen Aufgabe. | |
AppUrl | String | True | Die App-URL. | |
AvatarUrl | String | True | Die Avatar-URL der Person. | |
CalendarEventsTodayCount | Integer | Wahr | Anzahl der Ereignisse für heute. | |
CanCreateProjects | Boolean | Wahr | Ob die Person Projekte erstellen kann oder nicht. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Datensatzerstellung. | |
EmailAddress | String | True | Die Email Adresse der Person. | |
EventsAppUrl | String | True | Die URL der Veranstaltungs-App. | |
EventsCount | Integer | Wahr | Anzahl der Ereignisse. | |
EventsUpdatedAt | Datetime | True | Datum und Uhrzeit der Aktualisierung des Ereignisses. | |
EventsUrl | String | True | Die URL der zugewiesenen Aufgabe. | |
FullsizeAvatarUrl | String | True | Die Avatar-URL der Person in voller Größe. | |
HasBasecampSiblings | Boolean | Falsch | Boolescher Wert für Basecamp Geschwister. | |
IdentityId | String | True | Die Identitäts-ID der Person. | |
Name | String | Wahr | Der Name der Person. | |
OutstandingTodosCount | Integer | True | Anzahl der ausstehenden Aufgaben. | |
Trashed | Boolean | Falsch | Boolescher Wert für gelöschte Personen. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
Url | String | True | Die URL der Person. |
Projekte
Rufen Sie Projekte auf Basecamp ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Wählen
Sie können alle aktiven Projekte aus der Organisation abrufen, Datensätze nach Entwürfen und archivierten Projekten filtern oder einfach eine Projekt-ID für weitere Informationen festlegen. Entwürfe, Archiviert und ID sind die Spalten, die von Basecamp als Suchkriterien unterstützt werden.
SELECT * FROM Projects WHERE Drafts = True
SELECT * FROM Projects WHERE Advanced = True
SELECT * FROM Projects WHERE ID = '11111111'
Einfügen
Geben Sie mindestens die Eigenschaften „Name“ und „Beschreibung“ an, um ein neues Projekt zu erstellen.
INSERT INTO Projects (Name, Description) VALUES ('Test Proj', 'This is a new test project.')
Aktualisieren und löschen
Legen Sie einfach die Projekt-ID fest, um ein Projekt zu aktualisieren oder zu löschen, auf das Sie Zugriff haben.
UPDATE Projects SET Name = 'Updated Proj', Description = 'This is an updated test project.' WHERE Id = '11111111'
DELETE FROM Projects WHERE ID = '11111111'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die eindeutige Kennung des Projekts. | |
AccessesAppUrl | String | True | Die App-URL, auf die zugegriffen wird. | |
AccessesCount | Integer | True | Die Zugriffe zählen. | |
AccessesUpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung der Zugriffe. | |
AccessesUrl | String | True | Die Zugriffs URL. | |
AppUrl | String | True | Die App-URL. | |
Archived | Boolean | Falsch | Wenn der Benutzer ein Projekt archiviert, wird dieser Wert auf „True“ gesetzt. | |
AttachmentsAppUrl | String | True | Die URL der Anhänge-App. | |
AttachmentsCount | Integer | Stimmt | Die Anhänge zählen. | |
AttachmentsUpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung der Anhänge. | |
AttachmentsUrl | String | True | Die URL des Anhangs. | |
CalendarEventsAppUrl | String | True | Die URL der App für Kalenderereignisse. | |
CalendarEventsCount | Integer | Wahr | Die Kalenderereignisse zählen. | |
CalendarEventsUpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung der Kalenderereignisse. | |
CalendarEventsUrl | String | True | Die URL der Kalenderereignisse. | |
Color | String | Wahr | Farbe. | |
CreatedAt | Datetime | True | Die Erstellungszeit des Projekts. | |
CreatorAvatarUrl | String | Falsch | Ersteller-Avatar-URL. | |
CreatorFullsizeAvatarUrl | String | Falsch | URL des Avatars des Erstellers in voller Größe. | |
CreatorId | String | Falsch | Die ID des Erstellers. | |
CreatorName | String | Falsch | Der Name des Erstellers. | |
Description | String | Falsch | Die Beschreibung des Projekts. | |
DocumentsAppUrl | String | True | Die URL der Dokumenten-App. | |
DocumentsCount | Integer | Stimmt | Die Dokumente zählen. | |
DocumentsUpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung der Dokumente. | |
DocumentsUrl | String | True | Die URL des Dokuments. | |
Drafts | Boolean | Falsch | Boolescher Wert für ein Entwurfsprojekt. | |
ForwardsAppUrl | String | True | Die URL der Weiterleitungs-App. | |
ForwardsCount | Integer | Stimmt | Die Stürmer zählen. | |
ForwardsUpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung der Weiterleitungen. | |
ForwardsUrl | String | True | Die Weiterleitungs URL. | |
IsClientProject | Boolean | Falsch | Ob das Projekt kundenbezogen ist oder nicht. | |
LastEventAt | Datetime | Falsch | Zeitpunkt der letzten Änderung des Projekts. | |
Name | String | Falsch | Der Name des Projekts. | |
Starred | Boolean | Falsch | Boolescher Wert für ein mit Stern markiertes Projekt. | |
Template | Boolean | Falsch | Boolescher Wert für ein Vorlagenprojekt. | |
TodolistsAppUrl | String | True | Die URL der To-Do-Liste-App. | |
TodolistsCompletedCount | Integer | Wahr | Die Anzahl der abgeschlossenen To-Do-Listen. | |
TodolistsRemainingCount | Integer | Wahr | Die Anzahl der verbleibenden To-Do-Listen. | |
TodolistsUpdatedAt | Datetime | Wahr | Zeitpunkt der Aktualisierung der To-Do-Listen. | |
TodolistsUrl | String | Wahr | Die To-Do-Listen-URL. | |
TopicsAppUrl | String | True | Die URL der Themen-App. | |
TopicsCount | Integer | Stimmt | Die Themen zählen. | |
TopicsUpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung der Themen. | |
TopicsUrl | String | True | Die Themen URL. | |
Trashed | Boolean | Falsch | Boolescher Wert für ein gelöschtes Projekt. | |
UpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung des Projekts. | |
URL | String | True | Die URL des Projekts. |
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.
Basecamp Connector-Ansichten
Name | Beschreibung |
---|---|
Attachments | Anhänge auf Basecamp abrufen. |
Comments | Kalender auf Basecamp abrufen, erstellen, aktualisieren und löschen. |
Events | Aktivitätsereignisse auf Basecamp abrufen. |
Forwards | Weiterleitungen auf Basecamp abrufen. |
ToDoLists | ToDoListen auf Basecamp abrufen. |
ToDos | ToDos auf Basecamp abrufen. |
Topics | Themen auf Basecamp abrufen. |
Anlagen
Anhänge auf Basecamp abrufen.
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die ID des Anhangs. | |
Key | String | Der Schlüssel des Anhangs. | |
Name | String | Der Name des Anhangs. | |
ByteSize | Int | Die Größe des Anhangs in Bytes. | |
CreatedAt | Datetime | Das Datum, an dem der Anhang erstellt wurde. | |
UpdatedAt | Datetime | Das Datum, an dem der Anhang zuletzt aktualisiert wurde. | |
Url | String | Die URL des Anhangs. | |
AppUrl | String | Die AppUrl des Anhangs. | |
ThumbnailUrl | String | Die Miniaturansicht-URL des Anhangs. | |
Private | Boolean | Gibt an, ob der Anhang privat ist. | |
Trashed | Boolean | Gibt an, ob der Anhang in den Papierkorb verschoben wurde. | |
Tags | String | Die Tags des Anhangs. | |
CreatorId | String | Die ID des Erstellers des Anhangs. | |
CreatorName | String | Der Name des Erstellers des Anhangs. | |
CreatorAvatarUrl | String | Die Avatar-URL des Erstellers des Anhangs. | |
CreatorFullsizeAvatarUrl | String | Die URL des Avatars des Erstellers des Anhangs in voller Größe. | |
AttachableId | String | Die ID des Anfügbaren. | |
AttachableType | String | Der Typ des Anfügbaren. | |
AttachableUrl | String | Die URL des Anfügbaren. | |
AttachableAppUrl | String | Die AppUrl des Anfügbaren. |
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 |
---|---|---|
ProjectId | String |
Kommentare
Rufen Sie Kalender auf Basecamp ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Auswählen
Sie können alle aktiven Kommentare auf der Plattform abrufen und jedes Feld der Tabelle kann das Ergebnis filtern.
SELECT * FROM Comments WHERE ProjectId = '1111111' AND ItemType = 'Message'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung für den Kommentar. | |
ProjectId [KEY] | String | Die eindeutige Kennung für das Projekt, in dem der Kommentar enthalten ist. | |
ItemId | String | Die eindeutige Kennung für das Thema, das den Kommentar enthält. | |
ItemType | String | Typ des Objekts, das den Kommentar enthält. Gültige Werte sind: Nachricht, Dokument, Weiterleiten, Kalenderereignis, Hochladen, Aufgabenliste, Aufgabenliste. | |
AttachmentsAggregate | String | Die zum Kommentar gehörenden Anhänge. | |
Content | String | Der Inhalt des Kommentars. | |
Private | Boolean | Datenschutz des Kommentars | |
Trashed | Boolean | Ob der Kommentar gelöscht wurde oder nicht. | |
CreatedAt | Datetime | Datum und Uhrzeit der Dokumenterstellung. | |
CreatorAvatarUrl | String | URL des Avatars des Erstellers. | |
CreatorFullsizeAvatarUrl | String | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Die ID des Erstellers des Kommentars. | |
CreatorName | String | Der Name des Erstellers des Kommentars. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Kommentars. |
Veranstaltungen
Rufen Sie Aktivitätsereignisse auf Basecamp ab.
Tabellenspezifische Informationen
Wählen
Sie können alle Aktivitätsereignisse abrufen oder Daten nach dem Erstellungsdatum filtern. Die von Basecamp als Suchkriterien unterstützten Spalten und Operatoren werden unten angezeigt.
Spalte | Operatoren |
---|---|
ProjectId | = |
PersonId | = |
CreatedAt | >, >= |
Die folgende Abfrage ruft beispielsweise die Aktivitäten ab, die nach dem angegebenen Datum für die angegebene Person aufgetreten sind:
SELECT * FROM Events WHERE CreatedAt >= '2016-01-01' AND PersonId = '1111111'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung des Ereignisses. | |
Action | String | Die Aktionsbeschreibung für das Ereignis. | |
BucketAppUrl | String | Die URL der App für Kalenderereignisse. | |
BucketColor | String | Die Bucket-Ereignisfarbe. | |
BucketId | String | Die Bucket-Ereignis-ID. | |
BucketName | String | Der Name des Bucket-Ereignisses. | |
BucketType | String | Der Bucket-Ereignistyp. | |
BucketUrl | String | Die Bucket-Ereignis-URL. | |
CreatedAt | Datetime | Datum und Uhrzeit der Ereigniserstellung. | |
CreatorAvatarUrl | String | URL des Avatars des Erstellers. | |
CreatorFullsizeAvatarUrl | String | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Die ID des Ereigniserstellers. | |
CreatorName | String | Der Name des Ereigniserstellers. | |
EventableAppUrl | String | URL der Eventable-App. | |
EventableId | String | Ereignisfähige ID. | |
EventableType | String | Ereignisfähiger Typ. | |
EventableUrl | String | Ereignisfähige URL. | |
Excerpt | String | Der Auszugstyp für dieses Ereignis. | |
HtmlUrl | String | Die HTML URL des Ereignisses. | |
Private | Boolean | Ob die Veranstaltung privat ist. | |
RawExcerpt | String | Der Rohauszugstyp für dieses Ereignis. | |
Summary | String | Die Zusammenfassung der Veranstaltung. | |
Target | String | Das Zielprojekt dieser Veranstaltung. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Ereignisses. | |
URL | String | Die URL der Veranstaltung. |
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 |
---|---|---|
ProjectId | String | |
PersonId | String |
Stürmer
Weiterleitungen auf Basecamp abrufen.
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die ID des Weiterleiters. | |
Subject | String | Das Thema des Weiterleitungstextes. | |
From | String | ||
CreatedAt | Datetime | Das Datum, an dem die Weiterleitung erstellt wurde. | |
UpdatedAt | Datetime | Das Datum der letzten Aktualisierung der Weiterleitung. | |
Url | String | Die URL der Weiterleitung. | |
AppUrl | String | Die AppUrl der Weiterleitung. | |
Private | Boolean | Gibt an, ob die Weiterleitung privat ist. | |
Trashed | Boolean | Gibt an, ob die Weiterleitung gelöscht wurde. | |
BucketId | String | Die Bucket-ID der Weiterleitung. | |
BucketName | String | Der Bucket-Name des Weiterleiters. | |
BucketType | String | Der Schaufeltyp des Stürmers. | |
BucketUrl | String | Die Bucket-URL der Weiterleitung. | |
BucketAppUrl | String | Die Bucket-App-URL der Weiterleitung. |
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 |
---|---|---|
ProjectId | String |
ToDoListen
ToDoLists auf Basecamp abrufen.
Tabellenspezifische Informationen
Wählen
Die folgenden Spalten werden von Basecamp als Suchkriterien unterstützt:
- ProjektID
- Ausweis
- Personen-ID
- Vollendet
- Weggeworfen
- Erstellt am
CreatedAt kann mit den Operatoren „>“ oder „>=“ verwendet werden.
Die folgende Abfrage ruft nur abgeschlossene ToDoListen ab, die zu einem bestimmten Projekt gehören und seit einem bestimmten Datum gültig sind.
SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND Completed = True AND CreatedAt > '2016-01-01'M
Die folgende Abfrage ruft eine einzelne ToDoList aus einem bestimmten Projekt ab.
SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ID = '123456789'
Die folgende Abfrage ruft ToDoListen ab, die einer bestimmten Person zugewiesen sind.
SELECT * FROM ToDoLists WHERE PersonId = '11111111'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung des Themas. | |
AppUrl | String | Die App-URL. | |
AssignedTodos | String | Zugewiesene Aufgaben. | |
BucketAppUrl | String | Die URL der Themen-Bucket-App. | |
BucketColor | String | Die Farbe des To-Do-Eimers. | |
BucketId | String | Die To-Do-Bucket-ID. | |
BucketName | String | Der Name des Aufgabenbereichs. | |
BucketType | String | Der Aufgaben-Bucket-Typ. | |
BucketUrl | String | Die URL des Aufgabenbereichs. | |
Completed | Boolean | Ob die Aufgabenliste abgearbeitet ist. | |
CompletedCount | Integer | Anzahl erledigter Aufgaben. | |
CreatedAt | Datetime | Datum und Uhrzeit der Datensatzerstellung. | |
CreatorAvatarUrl | String | URL des Avatars des Erstellers. | |
CreatorFullsizeAvatarUrl | String | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Die ID des Erstellers. | |
CreatorName | String | Der Name des Erstellers. | |
Description | String | Die Beschreibung der Aufgabenliste. | |
Name | String | Der Name der Aufgabenliste. | |
Position | Integer | Positionsnummer der aktuellen Aufgabenliste. | |
Private | Boolean | Ob die Aufgabenliste privat ist. | |
RemainingCount | Integer | Anzahl der unerledigten Aufgaben. | |
SubscribersId | String | Die ID des Abonnenten. | |
SubscribersName | String | Der Name des Abonnenten. | |
ToDos | String | Aufgabenliste. | |
Trashed | Boolean | Boolescher Wert für gelöschte Aufgabenlisten. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
URL | String | Die URL der Aufgabenliste. |
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 |
---|---|---|
ProjectId | String | |
PersonId | String |
Aufgaben
ToDos auf Basecamp abrufen.
Tabellenspezifische Informationen
Wählen
Die folgenden Spalten werden von Basecamp als Suchkriterien unterstützt:
- ProjektID
- ToDoListId
- Ausweis
- Vollendet
- Übrig
- Weggeworfen
- Fällig bei
- DueOn
DueAt und DueOn können mit den Operatoren „>“ oder „>=“ verwendet werden.
Die folgende Abfrage ruft nur erledigte Aufgaben ab, die zu einem bestimmten Projekt gehören.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND Completed = True
Die folgende Abfrage filtert ToDos heraus, die seit einem bestimmten Datum fällig sind.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND DueAt > '2016-01-01'
Die folgende Abfrage listet die restlichen ToDos auf, die zu einer ToDo-Liste gehören.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ToDoListId = '123456789' AND Remaining = true
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung des Themas. | |
AppUrl | String | Die App-URL. | |
AssigneeId | String | ID der zugewiesenen Person. | |
AssigneeName | String | Name der zugewiesenen Person. | |
AssigneeType | String | Art des Zessionars. | |
CommentsCount | Integer | Anzahl der Kommentare zu dieser Aufgabe. | |
Completed | Boolean | Ob die Aufgabe erledigt ist. | |
Content | String | Beschreibung der Aufgabe. | |
CreatedAt | Datetime | Datum und Uhrzeit der Datensatzerstellung. | |
CreatorAvatarUrl | String | URL des Avatars des Erstellers. | |
CreatorFullsizeAvatarUrl | String | URL des Avatars in voller Größe des Erstellers. | |
CreatorId | String | Die ID des Erstellers. | |
CreatorName | String | Der Name des Erstellers. | |
DueAt | Datetime | Datum und Uhrzeit der Fälligkeit der Aufgabe. | |
DueOn | Datetime | Datum und Uhrzeit der Fälligkeit der Aufgabe. | |
Position | Integer | Positionsnummer der aktuellen Aufgabe auf der Liste. | |
Private | Boolean | Ob diese Aufgabe privat ist. | |
Remaining | Boolean | Boolescher Wert für verbleibende Aufgaben. | |
SubscribersId | String | Die ID des Abonnenten. | |
SubscribersName | String | Der Name des Abonnenten. | |
ToDoList | String | Aufgabenliste. | |
ToDoListId | String | Die ID der Aufgabenliste. | |
Trashed | Boolean | Boolescher Wert für gelöschte Aufgaben. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
URL | String | Die URL der Aufgabe. |
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 |
---|---|---|
ProjectId | String |
Themen
Themen auf Basecamp abrufen.
Tabellenspezifische Informationen
Wählen
Sie können alle aktiven Themen abrufen, Themen sortieren, die zu einem Projekt gehören, oder nur archivierte Themen auflisten (ProjectId und Archived sind die einzigen Spalten, die von Basecamp als Suchkriterien unterstützt werden).
SELECT * FROM Topics WHERE ProjectId = '1111111' ORDER BY UpdatedAt ASC
SELECT * FROM Topics WHERE ProjectId = '1111111' AND Archived = True
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | String | Die eindeutige Kennung des Themas. | |
Archived | Boolean | Boolescher Wert für archivierte Themen. | |
Attachments | Integer | Die Anzahl der Anhänge zum Thema. | |
BucketAppUrl | String | Die URL der Themen-Bucket-App. | |
BucketColor | String | Die Farbe des Bucket-Themas. | |
BucketId | String | Die Bucket-Themen-ID. | |
BucketName | String | Der Name des Bucket-Themas. | |
BucketType | String | Der Bucket-Thementyp. | |
BucketUrl | String | Die Bucket-Themen-URL. | |
CreatedAt | Datetime | Datum und Uhrzeit der Datensatzerstellung. | |
Excerpt | String | Der Auszug aus dem neusten Kommentar zum Thema. | |
LastUpdaterId | String | Die ID der Person, die den letzten Kommentar abgegeben hat. | |
LastUpdaterName | String | Der Name der Person, die das Thema zuletzt aktualisiert hat. | |
Private | Boolean | Ob das Thema privat ist. | |
Title | String | Der Titel des Themas. | |
TopicableAppUrl | String | Die URL der thematisch relevanten Basecamp Entität. | |
TopicableId | String | Die ID der thematisch relevanten Basecamp Entität. | |
TopicableType | String | Der Typ der thematisch anpassbaren Basecamp Entität. | |
TopicableUrl | String | Die URL der thematisch relevanten Basecamp Entität. | |
Trashed | Boolean | Boolescher Wert für gelöschte Themen. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. |
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 |
---|---|---|
ProjectId | String |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Basecamp hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Basecamp zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren für den Basecamp Connector
Name | Beschreibung |
---|---|
GetOAuthAccessToken | Ruft den OAuth-Zugriffstoken von Basecamp ab. |
GetOAuthAuthorizationURL | Ruft die Basecamp Autorisierungs URL ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge zu Basecamp verwendet werden kann. |
PublishProject | Veröffentlicht (aktiviert) ein aus einer Vorlage erstelltes Projekt (Projektentwurf). |
RefreshOAuthAccessToken | Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Basecamp Diensten verwendet wird. |
StarProject | Wird ein angegebenes Projekt mit einem Stern markieren. |
UnstarProject | Entfernt den Stern aus einem angegebenen Projekt. |
GetOAuthAccessToken
Ruft den OAuth-Zugriffstoken von Basecamp ab.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AuthMode | String | True | WEB oder APP. Der Basecamp Authentifizierungsmodus. Standard ist APP. Der Standardwert ist APP. |
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. |
Verifier | String | Falsch | Das von Basecamp zurückgegebene Verifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich. |
State | String | Falsch | Dieses Feld zeigt jeden Status an, der für Ihre Anwendung nach Erhalt der Antwort nützlich sein kann. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Basecamp Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das OAuth-Token. |
OAuthRefreshToken | String | Das OAuth-Aktualisierungstoken. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens in Sekunden. |
GetOAuthAuthorizationURL
Ruft die Basecamp Autorisierungs URL ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge zu Basecamp verwendet werden kann.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
CallbackUrl | String | Falsch | Die URL, zu der Basecamp zurückkehrt, nachdem der Benutzer Ihre App autorisiert hat. |
State | String | Falsch | Dieses Feld zeigt jeden Status an, der für Ihre Anwendung nach Erhalt der Antwort nützlich sein kann. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Basecamp Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die URL, die in einen Webbrowser eingegeben werden muss, um das Prüftoken abzurufen und den Datenanbieter damit zu autorisieren. |
Projekt veröffentlichen
Veröffentlicht (aktiviert) ein aus einer Vorlage erstelltes Projekt (Projektentwurf).
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
ProjectId | String | True | ID des Projekts. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Result | String | Ergebnis der Projekterstellung. |
Aktualisieren Sie das OAuthAccessToken
Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Basecamp-Diensten verwendet wird.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
OAuthRefreshToken | String | True | Das Aktualisierungstoken wurde mit dem vorherigen Zugriffstoken zurückgegeben. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von Basecamp zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. |
StarProject
Wird ein bestimmtes Projekt mit einem Stern markieren.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
ProjectId | String | True | ID des Projekts. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Result | String | Projekt-Star-Ergebnis. |
UnstarProject
Entfernt den Stern für ein bestimmtes Projekt.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
ProjectId | String | True | ID des Projekts. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
Result | String | Projekt-Stern entfernen-Ergebnis. |
Basecamp 3-Datenmodell
Dieser Abschnitt dokumentiert die Tabellen, Ansichten und Gespeicherte Prozeduren zum Verbinden mit Basecamp 3-Konten verfügbar.
Tabellen
Der Connector modelliert die Daten in Basecamp als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.
Basecamp Connector-Tabellen
Name | Beschreibung |
---|---|
CalendarEvents | Kalenderereignisse auf Basecamp 3 abrufen. |
Comments | Kommentare zu einer Basecamp 3-Aufzeichnung abrufen. |
Documents | Abrufen, Erstellen, Aktualisieren und Löschen von Dokumenten auf Basecamp 3. |
Messages | Nachrichten auf Basecamp 3 abrufen. |
Projects | Abrufen, Erstellen, Aktualisieren und Löschen von Projekten auf Basecamp 3. |
ToDoLists | ToDoListen auf Basecamp 3 abrufen. |
ToDos | ToDos auf Basecamp 3 abrufen. |
Vaults | Tresore (Ordner) in Basecamp 3-Ordnern abrufen. |
KalenderVeranstaltungen
Rufen Sie Kalenderereignisse auf Basecamp 3 ab.
Tabellenspezifische Informationen
Sie können Kalenderereignisse im angegebenen Projekt Abfrage.
Wählen
Die folgenden Spalten werden von Basecamp als Suchkriterien unterstützt:
- ProjektID
- Kalender-ID
- Status (standardmäßig werden nur aktive Ereignisse abgerufen)
Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM CalendarEvents WHERE ProjectId = '11111111' AND CalendarId = '22222222' AND Status = 'active'
Sie können auch ein einzelnes Kalenderereignis abrufen, indem Sie die ID angeben.
SELECT * FROM CalendarEvents WHERE ProjectId = '11111111' AND ID = '33333333'
Einfügen
Sie können ein neues Kalenderereignis einfügen, indem Sie als erforderliche Parameter die Projekt-ID, Kalender-ID, StartsAt, EndsAt und Zusammenfassung angeben.
INSERT INTO CalendarEvents (ProjectId, CalendarId, Summary, StartsAt, EndsAt, Description, Notify, ParticipantsIds ) VALUES ( '1111111', '2222222', 'summary test', '2017-11-11 09:00Z', '2017-11-11 11:00Z', 'description', 'false', '3333333, 4444444')
Aktualisieren
Sie können das Kalenderereignis auch ändern, indem Sie die Projekt-ID und die Ereignis-ID angeben.
UPDATE CalendarEvents SET Summary = 'Updated summary', StartsAt = '2017-11-12', EndsAt = '2017-11-12', AllDay = 'true' WHERE ProjectId = '11111111' AND ID = '1234567689'
Löschen
Kalenderereignisse können nicht gelöscht werden.
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung des Kalenderereignisses. | |
ProjectId | Long | Wahr | Projekte.Id | Die mit dem Zeitplan verknüpfte Projekt-ID. |
CalendarId | Long | Wahr | Projekte.CalendarId | Die Kalender-ID, zu der das Ereignis gehört. |
Status | String | True | Der Status des Kalenderereignisses. | |
Type | String | True | Der Typ des zurückgegebenen Datensatzes. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Erstellung des Kalenderereignisses. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Kalenderereignisses. | |
Description | String | Falsch | Beschreibung für das Kalenderereignis bereitgestellt. | |
AllDay | Boolean | Falsch | Gibt an, dass es sich bei der Veranstaltung um eine ganztägige Veranstaltung handelt. | |
StartsAt | Datetime | Falsch | Datum und Uhrzeit des Beginns des Kalenderereignisses. | |
EndsAt | Datetime | Falsch | Datum und Uhrzeit des Endes des Kalenderereignisses. | |
Summary | String | Falsch | Zusammenfassung für das Kalenderereignis bereitgestellt. | |
ParticipantsIds | String | Falsch | Eine Liste mit durch Kommas getrennten Teilnehmer-IDs. | |
ParticipantsNames | String | True | Eine Liste mit durch Kommas getrennten Teilnehmernamen. | |
ParentTitle | String | Wahr | Titel des übergeordneten Elements. | |
ParentType | String | Wahr | Typ des übergeordneten Elements. | |
BucketName | String | True | Name des enthaltenen Buckets. | |
BucketType | String | True | Typ des enthaltenen Buckets. | |
CreatorId | Long | Wahr | Leute.Id | Die ID des Erstellers. |
CreatorName | String | True | Der Name des Erstellers. | |
CommentsCount | Integer | True | Anzahl der Kommentare, die das Dokument hat. |
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 |
---|---|---|
Notify | String | Wenn auf „true“ gesetzt, werden die Teilnehmer über das Ereignis benachrichtigt. |
Kommentare
Rufen Sie Kommentare zu einer Basecamp 3-Aufzeichnung ab.
Tabellenspezifische Informationen
Wählen
Die Spalten in den Kommentaren werden clientseitig gefiltert. Sie können entweder alle Kommentare zu einer Aufzeichnung abrufen, indem Sie die RecordingId angeben, oder Sie können einen bestimmten Kommentar abrufen, indem Sie dessen ID angeben.
Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM Comments WHERE ProjectId = '11111111' AND RecordingId = '222222222' AND Content = 'Exempli gratia' AND CreatedAt < '2017-04-18T15:53:38.040-06:00'
Sie können auch einen einzelnen Kommentar abrufen, indem Sie die ID angeben (vorausgesetzt, Sie haben die Projekt-ID in der Verbindung angegeben)
SELECT * FROM Comments WHERE ID = '1234567'
Einfügen
Sie können einen neuen Kommentar einfügen, indem Sie die erforderlichen Projekt-IDs, Aufnahme-IDs und Inhalte angeben.
INSERT INTO Comments (Content, ProjectId, RecordingId) VALUES ('Very informative document. Thanks!', 114857506, 392946856)
Aktualisieren
Sie können die Spalten, die nicht schreibgeschützt sind, ändern, indem Sie die ID, die Projekt-ID und neue Werte angeben.
UPDATE Comments SET Content = 'I like this better now' WHERE ProjectId = '18061798' AND ID = '1308746423'
Löschen
Kommentare können nicht gelöscht werden (wird von der API nicht unterstützt).
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | String | True | Die ID des Kommentars. | |
Content | String | Falsch | Der Inhalt des Kommentars. | |
Title | String | True | Der Titel des Kommentars. | |
Status | String | True | Der Status des Kommentars. | |
CreatedAt | Datetime | True | Der Zeitpunkt, zu dem der Kommentar erstellt wurde. | |
UpdatedAt | Datetime | True | Der Zeitpunkt der letzten Aktualisierung des Kommentars. | |
InheritsStatus | Boolean | True | Ob dieser Kommentar seinen Status erbt oder nicht. | |
URL | String | True | Die URL des Kommentars. | |
VisibleToClients | Boolean | True | Ob dieser Kommentar für Clients sichtbar ist oder nicht. | |
ProjectId | Long | Falsch | Projekte.Id | Die ID des Projekts, dem dieser Kommentar untergeordnet ist. Ein Projekt enthält Aufzeichnungen. |
ProjectName | String | True | Der Name des Projekts, dem dieser Kommentar untergeordnet ist. | |
RecordingId | Long | Falsch | Aufnahmen.Id | Die ID der Aufzeichnung, zu der der Kommentar geschrieben wurde. Eine Aufzeichnung kann ein Kommentar, ein Dokument, eine Nachricht, eine Frage:Antwort, ein Zeitplan:Eintrag, eine Aufgabe, eine Aufgabenliste oder ein Upload sein. |
CommenterId | String | True | Die ID des Kommentators. | |
CommenterName | String | True | Der Name des Kommentators. | |
CommenterIsAdmin | Boolean | Wahr | Ob der Kommentator ein Administrator ist oder nicht. | |
CommenterIsOwner | Boolean | Wahr | Ob der Kommentator der Eigentümer der Aufzeichnung ist oder nicht. | |
CommenterTitle | String | Wahr | Der Titel des Kommentators. | |
CommenterEmail | String | True | Die Email Adresse des Kommentators. | |
CommenterAvatarURL | String | True | Die URL des Avatars des Kommentators. | |
CommenterCompanyId | String | True | Die Firmen-ID des Kommentators. | |
CommenterCompanyName | String | Wahr | Der Name des Unternehmens des Kommentators. | |
AppURL | String | True | Die URL der App, zu der dieser Kommentar gehört. | |
BookmarkURL | String | True | Die URL des Lesezeichens. | |
CommenterAttachableSGID | String | True | Die anfügbare SGID des Kommentators. |
Dokumente
Rufen Sie Dokumente auf Basecamp 3 ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Wählen
Sie können alle Dokumente abrufen, die nur zu einem bestimmten Projekt und Vault gehören, oder gleichzeitig ein Projekt und ein bestimmtes Dokument angeben (ProjectId, VaultId und ID sind die einzigen Spalten, die von Basecamp als Suchkriterien unterstützt werden).
Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM Documents WHERE ProjectId = '11111111' AND VaultId = '222222222'
SELECT * FROM Documents WHERE ProjectId = '11111111' AND ID = '1234567689'
Einfügen
Um einem großen Projekt ein neues Dokument hinzuzufügen, müssen Sie die Projekt-ID, die Vault-ID, den Titel, den Inhalt und den Status (optional) angeben.
INSERT INTO Documents (ProjectId, Vaultid, Title, Content, Status) VALUES ('11111111', '222222222', 'Memo', 'This is our document content', 'active')
Aktualisieren
Geben Sie die Projekt-ID und die Dokument-ID an, um ein Dokument zu aktualisieren.
UPDATE Documents SET Title = 'Updated Memo3', Content = 'Updated Content of Memo.' WHERE ProjectId = '11111111' AND ID = '1234567689'
Löschen
LÖSCHEN wird für diese Tabelle nicht unterstützt.
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung für das Dokument. | |
ProjectId | Long | Wahr | Projekte.Id | Die ID des mit dem Dokument verknüpften Projekts. |
VaultId | Long | Wahr | Tresore.Id | Die mit dem Dokument verknüpfte Vault-ID. |
Status | String | Falsch | Der Status des Tresors. | |
Title | String | Falsch | Der Titel des Dokuments. | |
Content | String | Falsch | Der Inhalt des Dokuments | |
Type | String | True | Der Typ des zurückgegebenen Datensatzes. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Dokumenterstellung. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Dokuments. | |
ParentTitle | String | Wahr | Titel des übergeordneten Elements. | |
ParentType | String | True | Typ des übergeordneten Elements. | |
BucketName | String | True | Name des enthaltenen Buckets. | |
BucketType | String | True | Typ des enthaltenen Buckets. | |
CreatorId | Long | Wahr | Leute.Id | Die ID des Erstellers. |
CreatorName | String | True | Der Name des Erstellers. | |
CommentsCount | Integer | True | Anzahl der Kommentare, die das Dokument hat. |
Nachrichten
Rufen Sie Nachrichten auf Basecamp 3 ab.
Tabellenspezifische Informationen
Sie können Nachrichten Abfrage, die im Message Board des angegebenen Projekts gepostet wurden.
Wählen
Die von Basecamp als Suchkriterien unterstützten Spalten sind ProjectId und MessageBoardId.
Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM Messages WHERE ProjectId = '11111111' AND MessageBoardId = '22222222'
Sie können auch eine einzelne Nachricht abrufen, indem Sie die ID angeben.
SELECT * FROM Messages WHERE ProjectId = '11111111' AND ID = '33333333'
Einfügen
Sie können eine neue Nachricht einfügen, indem Sie zusätzlich zu den nachrichtenbezogenen Parametern die erforderliche ProjectId, MessageBoardId und den Betreff angeben.
INSERT INTO Messages (ProjectId, MessageBoardId, Content, Subject, Status ) VALUES ('1111111', '2222222', 'Content test', 'Subject test', 'active')
Aktualisieren
Sie können Nachrichten auch aktualisieren, indem Sie die Projekt-ID und die Nachrichten-ID angeben.
UPDATE Messages SET subject = 'Updated subject', content = 'Updated content' WHERE ProjectId = '11111111' AND ID = '1234567689'
Löschen
Nachrichten können nicht gelöscht werden.
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung der Nachricht. | |
ProjectId | Long | Wahr | Projekte.Id | Die mit dem Zeitplan verknüpfte Projekt-ID. |
MessageBoardId | Long | Wahr | Projekte.MessageBoardId | Die Message Board-ID, zu der die Nachricht gehört. |
Status | String | Falsch | Der Status der Nachricht | |
Type | String | True | Der Typ des zurückgegebenen Datensatzes. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Erstellung der Nachricht. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung der Nachricht. | |
Content | String | Falsch | Bereitgestellter Inhalt für die Nachricht | |
Subject | String | Falsch | Betreff der Nachricht | |
ParentTitle | String | Wahr | Titel des übergeordneten Elements. | |
ParentType | String | Wahr | Typ des übergeordneten Elements. | |
BucketName | String | True | Name des enthaltenen Buckets. | |
BucketType | String | True | Typ des enthaltenen Buckets. | |
CreatorId | Long | Wahr | Leute.Id | Die ID des Erstellers. |
CreatorName | String | True | Der Name des Erstellers. | |
CategoryId | Long | Falsch | Die ID der Kategorie. | |
CategoryName | String | True | Der Name der Kategorie. | |
CommentsCount | Integer | True | Anzahl der Kommentare, die das Dokument hat. |
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 |
---|---|---|
IncludeReplies | Boolean | Setzen Sie dies auf „True“, um Antworten für jede Nachricht abzurufen. |
Projekte
Rufen Sie Projekte auf Basecamp 3 ab, erstellen, aktualisieren und löschen Sie sie.
Tabellenspezifische Informationen
Wählen
Sie können alle aktiven Projekte aus der Organisation abrufen oder eine Projekt-ID festlegen, um ein einzelnes Projekt abzurufen. Die ID ist die einzige Spalte, die von Basecamp als Suchkriterium unterstützt wird.
SELECT * FROM Projects WHERE ID = '11111111'
Einfügen
Geben Sie mindestens den Namen und optional die Beschreibungseigenschaften an, um ein neues Projekt zu erstellen.
INSERT INTO Projects (Name, Description) VALUES ('Test Proj', 'This is a new test project.')
Aktualisieren und löschen
Legen Sie die Projekt-ID fest, um ein Projekt zu aktualisieren oder zu löschen, auf das Sie Zugriff haben.
UPDATE Projects SET Name = 'Updated Project', Description = 'This is an updated test project.' WHERE Id = '11111111'
DELETE FROM Projects WHERE ID = '11111111'
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung des Projekts. | |
Status | String | True | Der Status des Projekts. | |
Purpose | String | Richtig | Der Zweck des Projekts. | |
CreatedAt | Datetime | True | Die Erstellungszeit des Projekts. | |
UpdatedAt | Datetime | True | Zeitpunkt der Aktualisierung des Projekts. | |
Description | String | Falsch | Die Beschreibung des Projekts. | |
Name | String | Falsch | Der Name des Projekts. | |
Bookmarked | Boolean | Falsch | Boolescher Wert für ein mit Lesezeichen versehenes Projekt. | |
CalendarId | Long | True | ID des Projektkalenders. | |
ChatId | Long | True | ID des Chats des Projekts. | |
ToDoSetId | Long | True | ID des ToDo-Sets des Projekts. | |
MessageBoardId | Long | True | ID des Message Boards des Projekts. | |
QuestionnaireId | Long | True | ID des Projektfragebogens. | |
VaultId | Long | True | ID des Vaults des Projekts. | |
InboxId | Long | True | ID des Posteingangs des Projekts. | |
KanbanBoardId | Long | True | ID des Kanban-Boards des Projekts. |
ToDoListen
ToDoLists auf Basecamp 3 abrufen.
Tabellenspezifische Informationen
Wählen
Die folgenden Spalten werden von Basecamp als Suchkriterien unterstützt:
- ProjektID
- ToDoSetId und Status
- Projekt-ID und ID
ToDoSetId kann in der Projekttabelle abgerufen werden.
Die folgende Abfrage ruft nur abgeschlossene Aufgabenlisten ab, die zu einem bestimmten Projekt und einem bestimmten Status gehören. Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ToDoSetId = '2222222' AND Status = 'active'
Die folgende Abfrage ruft eine einzelne ToDoList aus einem bestimmten Projekt ab.
SELECT * FROM ToDoLists WHERE ProjectId = '11111111' AND ID = '123456789'
Einfügen
Geben Sie den Namen, die Projekt-ID, die Beschreibung (optional) und die ToDoSet-ID an, um eine Aufgabenliste einzufügen.
INSERT INTO ToDoLists (Name, Description, ProjectId, ToDoSetId ) VALUES ('Name', 'desc', '11111111', '2222222')
Aktualisieren
Basecamp ermöglicht das Ändern des Namens und der Beschreibung der Aufgabenliste, vorausgesetzt, dass die Projekt-ID und die Aufgabenlisten-ID in der Abfrage enthalten sind:
UPDATE ToDoLists SET Name = 'Updated Name', Description = 'Updated desc' WHERE ProjectId = '11111111' AND ID = '1234567689'
Löschen
To-Do-Listen können nicht gelöscht werden.
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung des Themas. | |
ProjectId | Long | Wahr | Projekte.Id | Die ID des mit der Aufgabenliste verknüpften Projekts. |
ToDoSetId | Long | Wahr | Projekte.ToDoSetId | Die ID des To-Do-Sets, zu dem die To-Do-Liste gehört. |
Status | String | True | Der Aufgabenstatus. | |
Type | String | True | Der Datensatztyp. | |
Name | String | Falsch | Der Name der Aufgabe. | |
Completed | Boolean | Wahr | Der Status „Zu erledigen“. | |
CompletedRatio | String | True | Der Aufgabenstatus im Verhältnis. | |
Description | String | Falsch | Die Beschreibung der Aufgabenliste. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Ereigniserstellung. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
BucketName | String | True | Der Name des Aufgabenlisten-Buckets. | |
BucketType | String | True | Der Bucket-Typ der Aufgabenliste. | |
ParentTitle | String | Wahr | Titel des übergeordneten Elements. | |
ParentType | String | Wahr | Typ des übergeordneten Elements. | |
CreatorId | Long | Wahr | Leute.Id | ID des Ereigniserstellers. |
CreatorAttachableSgid | String | Wahr | Anfügbare SGID des Ereigniserstellers. | |
CreatorName | String | Wahr | Name des Ereigniserstellers. | |
CreatorEmailAddress | String | Wahr | Email Adresse des Veranstaltungserstellers. | |
CreatorTitle | String | Wahr | Titel des Ereigniserstellers. | |
CreatorBio | String | Stimmt | Biografie des Event-Erstellers. | |
CreatorCreatedAt | Datetime | Wahr | Erstellungsdatum und -zeit des Ereigniserstellers. | |
CreatorUpdatedAt | Datetime | Wahr | Aktualisierungsdatum und -uhrzeit des Ereigniserstellers. | |
CreatorAdmin | Boolean | True | Boolesche Angabe, ob der Ersteller der Veranstaltung ein Administrator ist. | |
CreatorOwner | Boolean | True | Boolesche Angabe, ob der Ersteller des Ereignisses ein Eigentümer ist. | |
CreatorTimeZone | String | True | Zeitzone des Ereigniserstellers. | |
CreatorCompanyId | Long | True | Firmen-ID des Ereigniserstellers | |
CreatorCompanyName | String | True | Firmenname des Event-Erstellers. | |
CommentsCount | Integer | True | Anzahl der Kommentare, die das Dokument hat. |
Aufgaben
ToDos auf Basecamp 3 abrufen.
Tabellenspezifische Informationen
Wählen
Die folgenden Spalten werden von Basecamp als Suchkriterien unterstützt:
- ProjektID
- ToDoListId
- Ausweis
- Vollendet
- Status
Standardmäßig werden nur aktive Aufgaben abgerufen.
Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ToDoListId = '222222222' AND Status = 'active' AND Completed = True
Sie können auch eine einzelne Aufgabe abrufen, indem Sie die ID angeben.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ID = '33333333'
Einfügen
Sie können eine neue Aufgabe einfügen, indem Sie zusätzlich zu den Aufgabenparametern die erforderlichen Projekt-IDs, Aufgabenlisten-IDs und Inhalte angeben.
INSERT INTO ToDos (Content, Description, DueOn, StartsOn, AssigneeIds, ProjectId, ToDoListId ) VALUES ('What to do', 'description', '2017-11-11', '2017-11-12', '333333333', '1111111111', '22222222')
Aktualisieren
Sie können die Spalten, die nicht schreibgeschützt sind, ändern, indem Sie die Projekt-ID, die Aufgaben-ID und neue Werte angeben.
UPDATE ToDos SET Content = 'Updated content' WHERE ProjectId = '11111111' AND ID = '1234567689'
Sie können den Status „Abgeschlossen“ der Aufgabe ändern, indem Sie die Projekt-ID und die Aufgaben-ID angeben. Die Spalte „Abgeschlossen“ kann nur eigenständig aktualisiert werden, andere Spalten können in derselben Abfrage nicht aktualisiert werden.
UPDATE ToDos SET Completed = True WHERE ProjectId = '11111111' AND ID = '1234567689'
Löschen
Aufgaben können nicht gelöscht werden.
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung der Aufgabe. | |
ProjectId | Long | Wahr | Projekte.Id | Die ID des mit der Aufgabenliste verknüpften Projekts. |
ToDoListId | Long | Wahr | ToDoLists.Id | Die ID der Aufgabenliste, zu der die Aufgabe gehört. |
Status | String | Stimmt | Der Staat hat die Aufgaben zu erledigen. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Ereigniserstellung. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
StartsOn | Date | Falsch | Datum und Uhrzeit, wann die Aufgabe beginnen soll. | |
DueOn | Date | Falsch | Datum und Uhrzeit der Fälligkeit der Aufgabe. | |
CommentsCount | Integer | True | Anzahl der Kommentare, die das Dokument hat. | |
Description | String | Falsch | Die Beschreibung der Aufgabenliste. | |
Content | String | Falsch | Was tun. | |
AssigneesIds | String | Falsch | Liste der zugewiesenen Benutzer-IDs. | |
Completed | Boolean | Falsch | Der To-Do-Status. | |
CompletedAt | Datetime | True | Datum und Uhrzeit der Erledigung der Aufgabe. | |
CompletionCreatorId | String | True | Die ID des Benutzers, der die Aufgabe erledigt hat. | |
CompletionCreatorName | String | True | Der Name des Benutzers, der die Aufgabe erledigt hat. | |
BucketName | String | True | Der Name des Aufgabenlisten-Buckets. | |
BucketType | String | True | Der Bucket-Typ der Aufgabenliste. | |
ParentTitle | String | Wahr | Titel des übergeordneten Elements. | |
ParentType | String | Wahr | Typ des übergeordneten Elements. | |
CreatorId | Long | Wahr | Leute.Id | ID des Ereigniserstellers. |
CreatorAttachableSgid | String | Wahr | Anfügbare SGID des Ereigniserstellers. | |
CreatorName | String | Wahr | Name des Ereigniserstellers. | |
CreatorEmailAddress | String | Wahr | Email Adresse des Veranstaltungserstellers. | |
CreatorTitle | String | Wahr | Titel des Ereigniserstellers. | |
CreatorBio | String | Stimmt | Biografie des Event-Erstellers. | |
CreatorCreatedAt | Datetime | Wahr | Erstellungsdatum und -zeit des Ereigniserstellers. | |
CreatorUpdatedAt | Datetime | Wahr | Aktualisierungsdatum und -uhrzeit des Ereigniserstellers. | |
CreatorAdmin | Boolean | True | Boolesche Angabe, ob der Ersteller der Veranstaltung ein Administrator ist. | |
CreatorOwner | Boolean | True | Boolesche Angabe, ob der Ersteller des Ereignisses ein Eigentümer ist. | |
CreatorTimeZone | String | True | Zeitzone des Ereigniserstellers. | |
CreatorCompanyId | String | True | Firmen-ID des Ereigniserstellers | |
CreatorCompanyName | String | True | Firmenname des Event-Erstellers. |
Tresore
Rufen Sie Tresore (Ordner) in Basecamp 3-Ordnern ab.
Tabellenspezifische Informationen
Alle Projekte haben einen primären Tresor (Ordner). Zusätzliche Tresore können unter dem primären Tresor oder einem untergeordneten Tresor verschachtelt sein.
Wählen
Die von Basecamp als Suchkriterien unterstützten Spalten sind ProjectId, VaultId und Id. Wenn ProjectId in der Abfrage nicht angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM Vaults WHERE ProjectId = '11111111' AND VaultId = '222222222'
Sie können auch eine einzelne Aufgabe abrufen, indem Sie die ID angeben.
SELECT * FROM Vaults WHERE ProjectId = '11111111' ID = '333333333'
EINFÜGEN
Sie können einen neuen Tresor einfügen, indem Sie die erforderlichen Parameter ProjectId, VaultId und Title angeben.
INSERT INTO Vaults (Title, ProjectId, Vaultid) VALUES ('InsertedVault', '11111111', '222222222')
Aktualisieren
Sie können den Vault-Titel aktualisieren, indem Sie die Projekt-ID, die Vault-ID und den neuen Titel angeben.
UPDATE Vaults SET Title = 'Updated title' WHERE ProjectId = '11111111' AND ID = '333333333'
Löschen
Tresore können nicht gelöscht werden.
Spalten
Name | Typ | Nur Lesen | Referenzen | Beschreibung |
---|---|---|---|---|
Id [KEY] | Long | True | Die eindeutige Kennung des Themas. | |
ProjectId | Long | Wahr | Projekte.Id | Die mit dem Tresor verknüpfte Projekt-ID. |
Status | String | True | Der Status des Tresors. | |
Title | String | Falsch | Der Titel des zurückgegebenen Datensatzes. | |
Type | String | True | Der Typ des zurückgegebenen Datensatzes. | |
CreatedAt | Datetime | True | Datum und Uhrzeit der Datensatzerstellung. | |
UpdatedAt | Datetime | True | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
ParentId | Long | True | ID des übergeordneten Elements. | |
ParentTitle | String | Wahr | Titel des übergeordneten Elements. | |
ParentType | String | Wahr | Typ des übergeordneten Elements. | |
BucketId | Long | True | ID des enthaltenen Buckets. | |
BucketName | String | True | Name des enthaltenen Buckets. | |
BucketType | String | True | Typ des enthaltenen Buckets. | |
CreatorId | Long | Wahr | Leute.Id | Die ID des Erstellers. |
CreatorName | String | True | Der Name des Erstellers. | |
DocumentsCount | Integer | True | Anzahl der im Tresor enthaltenen Dokumente. | |
UploadsCount | Integer | True | Anzahl der Uploads, die der Tresor enthält. | |
VaultsCount | Integer | True | Anzahl der Tresore, die der Tresor enthält. |
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 |
---|---|---|
VaultId | Long | Die Tresor-ID, zu der der Datensatz gehört. |
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.
Basecamp Connector-Ansichten
Name | Beschreibung |
---|---|
Assignments | Aufgaben auf Basecamp 3 abrufen. |
Calendars | Kalender auf Basecamp 3 abrufen. |
Events | Aktivitätsereignisse auf Basecamp 3 abrufen. |
People | Personen auf Basecamp 3 abrufen. |
ProjectTools | Projekttools auf Basecamp 3 abrufen. |
Recordings | Aufnahmen aus Basecamp 3-Ordnern abrufen. |
Uploads | Uploads auf Basecamp 3 abrufen. |
Aufgaben
Rufen Sie Aufgaben auf Basecamp 3 ab.
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | Long | Die eindeutige Kennung der Person. | |
TodoListId | Long | ToDoListen.Id | Die eindeutige Kennung für die To-Do-Liste. |
ProjectId | Long | Projekte.Id | Verwenden Sie den Filter, um aktive Personen im Projekt mit der angegebenen ID abzurufen. |
Name | String | Der Name der Person. | |
Owner | Boolean | Boolescher Wert, um anzuzeigen, ob die aktuelle Person der Kontoinhaber ist. | |
Admin | Boolean | Boolescher Wert, um anzuzeigen, ob die aktuelle Person ein Administrator ist oder nicht. | |
Title | String | Der Titel der Person. | |
Bio | String | Biografische Beschreibung der Person. | |
CreatedAt | Datetime | Datum und Uhrzeit der Datensatzerstellung. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
EmailAddress | String | Die Email Adresse der Person. | |
AttachableSgid | String | Die anfügbare Set-Gruppen-ID. | |
PersonableType | String | Personentyp. | |
TimeZone | String | Für den Benutzer lesbare Zeitzone. | |
CompanyId | Long | ID des Benutzerunternehmens. | |
CompanyName | String | Name des Unternehmens des Benutzers. |
Kalender
Kalender auf Basecamp 3 abrufen.
Tabellenspezifische Informationen
In jedem Basecamp-Projekt gibt es nur einen Kalender (Zeitplan).
Wählen
Rufen Sie weitere Details zu einem bestimmten Kalender ab (ProjectId und ID sind die einzigen Spalten, die von Basecamp als Suchkriterien unterstützt werden). Wenn ProjectId in der Abfrage nicht angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM Calendars WHERE ProjectId = '111111111' AND ID = '123456789'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | Long | Projekte.CalendarId | Die eindeutige Kennung des Kalenders. |
ProjectId | Long | Projekte.Id | Die mit dem Kalender verknüpfte Projekt-ID. |
Status | String | Der Status des Kalenders. | |
Type | String | Der Typ des zurückgegebenen Datensatzes. | |
CreatedAt | Datetime | Datum und Uhrzeit der Kalendererstellung. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Kalenders. | |
Title | String | Titel des Kalenders. | |
EntriesCount | Integer | Anzahl der Kalenderereignisse. | |
BucketId | Long | ID des enthaltenen Buckets. | |
BucketName | String | Name des enthaltenen Buckets. | |
BucketType | String | Typ des enthaltenen Buckets. | |
CreatorId | Long | Personen.Id | Die ID des Erstellers. |
CreatorName | String | Der Name des Erstellers. |
Veranstaltungen
Rufen Sie Aktivitätsereignisse auf Basecamp 3 ab.
Spezifische Informationen anzeigen
Immer wenn sich eine Aufzeichnung ändert, wird ein Ereignis erstellt.
Wählen
Sie können alle Aktivitätsereignisse im angegebenen Projekt und in der angegebenen Aufzeichnung abrufen. Die von Basecamp als Suchkriterien unterstützten Spalten sind ProjectId und RecordingId.
Wenn in der Abfrage keine ProjectId angegeben ist, wird die Standard-ProjectId verwendet.
SELECT * FROM Events WHERE ProjectId = '1111111' AND RecordingId = '22222222'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | Long | Die eindeutige Kennung des Ereignisses. | |
ProjectId | Long | Projekte.Id | Die ID des mit dem Dokument verknüpften Projekts. |
RecordingId | Long | Aufnahmen.Id | Die ID der mit diesem Ereignis verknüpften Aufzeichnung. |
Action | String | Die Aktionsbeschreibung für das Ereignis. | |
Details | String | Details zur Veranstaltung. | |
CreatedAt | Datetime | Datum und Uhrzeit der Ereigniserstellung. | |
CreatorId | Long | Personen.Id | ID des Ereigniserstellers. |
CreatorAttachableSgid | String | Anfügbare SGID des Ereigniserstellers. | |
CreatorName | String | Name des Veranstaltungserstellers. | |
CreatorEmailAddress | String | Email Adresse des Veranstaltungserstellers. | |
CreatorTitle | String | Titel des Veranstaltungserstellers. | |
CreatorBio | String | Biografie des Veranstaltungserstellers. | |
CreatorCreatedAt | Datetime | Erstellungsdatum und -zeit des Ereigniserstellers. | |
CreatorUpdatedAt | Datetime | Datum und Uhrzeit der Aktualisierung des Ereigniserstellers. | |
CreatorAdmin | Boolean | Boolesche Angabe, ob der Ersteller der Veranstaltung ein Administrator ist. | |
CreatorOwner | Boolean | Boolesche Angabe, ob der Ersteller des Ereignisses ein Eigentümer ist. | |
CreatorTimeZone | String | Zeitzone des Event-Erstellers. | |
CreatorCompanyId | Long | Firmen-ID des Event-Erstellers | |
CreatorCompanyName | String | Firmenname des Event-Erstellers. |
Menschen
Rufen Sie Personen auf Basecamp 3 ab.
Spezifische Informationen anzeigen
Wählen
Rufen Sie alle für den aktuellen Benutzer sichtbaren Personen ab, listen Sie Personen nach Projekt auf oder geben Sie eine ID an, um weitere Informationen zu erhalten. ID und ProjectId sind die von Basecamp als Suchkriterien unterstützten Spalten.
SELECT * FROM People WHERE Id = '123456789'
SELECT * FROM People WHERE ProjectId = '5168618'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | Long | Die eindeutige Kennung der Person. | |
Name | String | Der Name der Person. | |
Owner | Boolean | Boolescher Wert, um anzuzeigen, ob die aktuelle Person der Kontoinhaber ist. | |
Admin | Boolean | Boolescher Wert, um anzuzeigen, ob die aktuelle Person ein Administrator ist oder nicht. | |
Title | String | Der Titel der Person. | |
Bio | String | Biografische Beschreibung der Person. | |
CreatedAt | Datetime | Datum und Uhrzeit der Datensatzerstellung. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes. | |
EmailAddress | String | Die Email Adresse der Person. | |
AttachableSgid | String | Die anfügbare Set-Gruppen-ID. | |
PersonableType | String | Personentyp. | |
TimeZone | String | Für den Benutzer lesbare Zeitzone. | |
CompanyId | Long | ID des Benutzerunternehmens. | |
CompanyName | String | Name des Unternehmens des Benutzers. |
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 |
---|---|---|
ProjectId | Long |
ProjektTools
Rufen Sie Projekttools auf Basecamp 3 ab.
Tabellenspezifische Informationen
Auswählen
Für diese Tabelle werden serverseitig keine Filter unterstützt. Alle Kriterien werden clientseitig innerhalb des Connectors verarbeitet.
Beispielsweise werden die folgenden Abfragen serverseitig verarbeitet:
SELECT * FROM ProjectTools
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id | Long | Die ID des mit dem Projekt verknüpften Tools. | |
Name | String | Der Name des mit dem Projekt verknüpften Tools. | |
AppUrl | String | Die App-URL des mit diesem Projekt verknüpften Tools. | |
Enabled | Boolean | Boolescher Wert für ein Tool des Projekts. | |
Position | Int | Die Position des mit diesem Projekt verknüpften Tools. | |
Title | String | Der Titel des mit diesem Projekt verknüpften Tools. | |
Url | String | Die URL des mit diesem Projekt verknüpften Tools. | |
ProjectId | Long | Die eindeutige Kennung des Projekts. |
Aufnahmen
Rufen Sie Aufzeichnungen aus Basecamp 3-Ordnern ab.
Spezifische Informationen anzeigen
Rufen Sie die meisten Datenstrukturen in Basecamp 3 ab, die als „Aufzeichnungen“ dargestellt werden.
Wählen
Die von Basecamp als Suchkriterien unterstützten Spalten sind Typ (erforderlicher Parameter), Bucket und Status.
SELECT * FROM Recordings WHERE type = 'Upload' AND Bucket = '1111111, 22222222' AND Status = 'active'
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | Long | Die eindeutige Kennung des Themas. | |
Status | String | Der Status des Tresors. Die zulässigen Werte sind aktiv, archiviert, gelöscht. | |
Type | String | Der Typ des Tresors. Die zulässigen Werte sind Kommentar, Dokument, Nachricht, Frage:Antwort, Zeitplan:Eintrag, Aufgabenliste, Aufgabenliste, Hochladen. | |
CreatedAt | Datetime | Datum und Uhrzeit der Ereigniserstellung. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Änderung des Ereignisses. | |
CreatorId | Long | Personen.Id | Ereignisersteller. |
CreatorName | String | Ereignisersteller. |
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 |
---|---|---|
Bucket | String |
Uploads
Uploads auf Basecamp 3 abrufen.
Spalten
Name | Typ | Referenzen | Beschreibung |
---|---|---|---|
Id [KEY] | Long | Die eindeutige Kennung für die hochgeladene Datei. | |
ProjectId | Long | Projekte.Id | Die ID des Projekts, das mit der hochgeladenen Datei verknüpft ist. |
VaultId | Long | Tresore.Id | Die mit der hochgeladenen Datei verknüpfte Vault-ID. |
Status | String | Der Status des Tresors. | |
Title | String | Der Titel der hochgeladenen Datei. | |
ContentType | String | Der Inhaltstyp der hochgeladenen Datei | |
Type | String | Der Typ des zurückgegebenen Datensatzes. | |
CreatedAt | Datetime | Datum und Uhrzeit der Erstellung der hochgeladenen Datei. | |
UpdatedAt | Datetime | Datum und Uhrzeit der letzten Aktualisierung der hochgeladenen Datei. | |
ParentTitle | String | Titel des übergeordneten Elements. | |
ParentType | String | Typ des übergeordneten Elements. | |
BucketName | String | Name des enthaltenen Buckets. | |
BucketType | String | Typ des enthaltenen Buckets. | |
CreatorId | Long | Personen.Id | Die ID des Erstellers. |
CreatorName | String | Der Name des Erstellers. | |
CommentsCount | Integer | Anzahl der Kommentare, die die hochgeladene Datei hat. | |
DownloadURL | String | Anzahl der Kommentare, die die hochgeladene Datei hat. | |
ByteSize | Integer | Anzahl der Kommentare, die die hochgeladene Datei hat. |
Gespeicherte Prozeduren
Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit Basecamp hinaus erweitern.
Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von Basecamp zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.
Gespeicherte Prozeduren für den Basecamp Connector
Name | Beschreibung |
---|---|
GetOAuthAccessToken | Ruft den OAuth-Zugriffstoken von Basecamp ab. |
GetOAuthAuthorizationURL | Ruft die Basecamp Autorisierungs URL ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge zu Basecamp verwendet werden kann. |
RefreshOAuthAccessToken | Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Basecamp Diensten verwendet wird. |
GetOAuthAccessToken
Ruft den OAuth-Zugriffstoken von Basecamp ab.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
AuthMode | String | True | WEB oder APP. Der Basecamp Authentifizierungsmodus. Standard ist APP. Der Standardwert ist APP. |
CallbackUrl | String | Falsch | Die URL, zu der der Benutzer nach der Autorisierung Ihrer Anwendung weitergeleitet wird. |
Verifier | String | Falsch | Das von Basecamp zurückgegebene Verifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich. |
State | String | Falsch | Dieses Feld zeigt jeden Status an, der für Ihre Anwendung nach Erhalt der Antwort nützlich sein kann. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Basecamp Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das OAuth-Token. |
OAuthRefreshToken | String | Das OAuth-Aktualisierungstoken. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens in Sekunden. |
GetOAuthAuthorizationURL
Ruft die Basecamp Autorisierungs URL ab. Greifen Sie in einem Webbrowser auf die in der Ausgabe zurückgegebene URL zu. Dadurch wird das Zugriffstoken angefordert, das als Teil der Verbindungszeichenfolge zu Basecamp verwendet werden kann.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
CallbackUrl | String | Falsch | Die URL, zu der Basecamp zurückkehrt, nachdem der Benutzer Ihre App autorisiert hat. |
State | String | Falsch | Dieses Feld zeigt jeden Status an, der für Ihre Anwendung nach Erhalt der Antwort nützlich sein kann. Ihre Anwendung erhält denselben Wert, den sie gesendet hat, da dieser Parameter einen Hin- und Rückweg zum Basecamp Autorisierungsserver und zurück durchführt. Zu den Verwendungsmöglichkeiten gehören die Umleitung des Benutzers zur richtigen Ressource auf Ihrer Site, die Verwendung von Nonces und die Minderung von Cross-Site-Request-Forgery. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
URL | String | Die URL, die in einen Webbrowser eingegeben werden muss, um das Prüftoken abzurufen und den Datenanbieter damit zu autorisieren. |
Aktualisieren Sie das OAuthAccessToken
Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Basecamp-Diensten verwendet wird.
Eingang
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
OAuthRefreshToken | String | True | Das Aktualisierungstoken wurde mit dem vorherigen Zugriffstoken zurückgegeben. |
Ergebnissatzspalten
Name | Typ | Beschreibung |
---|---|---|
OAuthAccessToken | String | Das von Basecamp zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden. |
OAuthRefreshToken | String | Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann. |
ExpiresIn | String | Die verbleibende Lebensdauer des Zugriffstokens. |
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 Basecamp 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:
- 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 „Projekte“ zurück:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Projects'
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 „RefreshOAuthAccessToken“ zurück:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' 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 „Projekte“ ab:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Projects'
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:basecamp: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 Verbindung erforderlich ist. |
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 | Verschiedene 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. |
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 | Der zu verwendende Authentifizierungstyp für die Verbindung mit Basecamp. |
Schema | Geben Sie die Basecamp-Version an, mit der eine Verbindung hergestellt werden soll. |
User | Benutzername des aktuell authentifizierten Benutzers. |
Password | Passwort des aktuell authentifizierten Benutzers. |
AccountId | Konto-ID des aktuell authentifizierten Benutzers. |
ProjectId | Die Projekt-ID des aktuell authentifizierten Benutzers. |
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. |
OAuthAuthorizationURL | Die Autorisierungs-URL für den OAuth-Dienst. |
OAuthAccessTokenURL | Die URL, von der das OAuth-Zugriffstoken abgerufen werden soll. |
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 |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
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 |
---|---|
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. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
Authentifizierung
Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.
Eigenschaft | Beschreibung |
---|---|
AuthScheme | Der zu verwendende Authentifizierungstyp für die Verbindung mit Basecamp. |
Schema | Geben Sie die Basecamp-Version an, mit der eine Verbindung hergestellt werden soll. |
User | Benutzername des aktuell authentifizierten Benutzers. |
Password | Passwort des aktuell authentifizierten Benutzers. |
AccountId | Konto-ID des aktuell authentifizierten Benutzers. |
ProjectId | Die Projekt-ID des aktuell authentifizierten Benutzers. |
AuthScheme
Der Authentifizierungstyp, der bei der Verbindung mit Basecamp verwendet werden soll.
Mögliche Werte
Auto
, OAuth
, Basic
Datentyp
string
Standardwert
Auto
Hinweise
- Automatisch: Lässt den Treiber automatisch basierend auf den anderen von Ihnen festgelegten Verbindungseigenschaften entscheiden.
- Basic: Legen Sie diese Option fest, um die BASIC-Benutzer-/Passwort-Authentifizierung zu verwenden.
- OAuth: Legen Sie diese Option fest, um eine OAuth-Authentifizierung durchzuführen.
Schema
Geben Sie die Basecamp-Version an, mit der eine Verbindung hergestellt werden soll.
Mögliche Werte
V2
, V3
Datentyp
string
Standardwert
V2
Hinweise
Die verfügbaren Schemas sind V2 (zur Verwendung der Basecamp 2 API) und V3 (zur Verwendung der Basecamp 3 API).
Benutzer
Benutzername des aktuell authentifizierten Benutzers.
Datentyp
string
Standardwert
""
Hinweise
Benutzername des aktuell authentifizierten Benutzers. Diese Eigenschaft ist zum Ausführen von Befehlen erforderlich.
Passwort
Passwort des aktuell authentifizierten Benutzers.
Datentyp
string
Standardwert
""
Hinweise
Passwort des aktuell authentifizierten Benutzers. Diese Eigenschaft ist zum Ausführen von Befehlen erforderlich.
Konto-ID
Konto-ID des aktuell authentifizierten Benutzers.
Datentyp
string
Standardwert
""
Hinweise
Konto-ID des aktuell authentifizierten Benutzers. Diese Eigenschaft ist zum Ausführen von Befehlen erforderlich.
ProjektID
Die Projekt-ID des aktuell authentifizierten Benutzers.
Datentyp
string
Standardwert
""
Hinweise
Die Projekt-ID des aktuell authentifizierten Benutzers. Standardmäßig wird sie auf die erste Projekt-ID Ihrer Projektliste gesetzt.
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. |
OAuthAuthorizationURL | Die Autorisierungs-URL für den OAuth-Dienst. |
OAuthAccessTokenURL | Die URL, von der das OAuth-Zugriffstoken abgerufen werden soll. |
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%\CData\Acumatica Data Provider\OAuthSettings.txt
Hinweise
Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH
oder REFRESH
, der Treiber 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 auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit '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%\CData\ Acumatica Data Provider\OAuthSettings.txt“ mit %APPDATA%
auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind
- Windows: "
register://%DSN
" - Unix: "%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 |
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.
OAuthAuthorizationURL
Die Autorisierungs URL für den OAuth-Dienst.
Datentyp
string
Standardwert
""
Hinweise
Die Autorisierungs-URL für den OAuth-Dienst. Unter dieser URL meldet sich der Benutzer beim Server an und erteilt der Anwendung Berechtigungen. In OAuth 1.0 wird das Anforderungstoken autorisiert, wenn Berechtigungen erteilt werden.
OAuth-ZugriffstokenURL
Die URL, von der das OAuth-Zugriffstoken abgerufen werden soll.
Datentyp
string
Standardwert
""
Hinweise
Die URL, von der der OAuth-Zugriffstoken abgerufen werden soll. In OAuth 1.0 wird unter dieser URL der autorisierte Anforderungstoken gegen den Zugriffstoken ausgetauscht.
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 |
---|---|
SSLServerCert | Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL. |
SSLServerCert
Das vom Server zu akzeptierende Zertifikat bei einer Verbindung über TLS/SSL.
Datentyp
string
Standardwert
""
Hinweise
Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.
Diese Eigenschaft kann folgende Formen annehmen:
Beschreibung | Beispiel |
---|---|
Ein vollständiges PEM-Zertifikat (Beispiel der Kürze halber gekürzt) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
Ein Pfad zu einer lokalen Datei, die das Zertifikat enthält | C:\\cert.cer |
Der öffentliche Schlüssel (Beispiel der Kürze halber gekürzt) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
Der MD5-Fingerabdruck (Hexadezimalwerte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) | ecadbdda5a1529c58a1e9e09828d70e4 |
Der SHA1-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Wenn nicht angegeben, wird jedes vom Computer vertrauenswürdige Zertifikat akzeptiert.
Zertifikate werden vom Computer basierend auf dem Trust Store des Systems als vertrauenswürdig validiert. Der verwendete Trust Store ist der für das System angegebene Wert „javax.net.ssl.trustStore“. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Standard-Trust Store von Java verwendet (z. B. JAVA_HOME\lib\security\cacerts).
Verwenden Sie „*“, um anzugeben, dass alle Zertifikate akzeptiert werden. Beachten Sie, dass dies aus Sicherheitsgründen nicht empfohlen wird.
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%\Basecamp 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
Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen möchten (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.
Notiz
Da dieser Connector mehrere Schemas unterstützt, ist die Struktur für benutzerdefinierte Basecamp Schema wie folgt:
- Jedem Schema wird ein Ordner zugewiesen, der diesem Schema entspricht.
- Diese Schema sind in einem übergeordneten Ordner enthalten.
- Der
parent folder
sollte als gesetzt werdenLocation
, kein Ordner eines einzelnen Schemas.
Wenn nichts angegeben wird, ist der Standardspeicherort "%APPDATA%\ Basecamp 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 |
---|---|
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. |
Other | Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet. |
PseudoColumns | Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht. |
Timeout | Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird. |
UserDefinedViews | Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält. |
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.
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. |
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. „*=*“.
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.
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 Projects 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
Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.