Aktivitäten in CentralStationCRM

API Navigation

Allgemeines: Grundlagen Authentifizierung Fehlerbehandlung Datenstruktur

Hauptmodelle: Personen Firmen Angebote Projekte Aufgaben

Sonstiges: Anschriften Kontaktdaten Wichtige Daten Individuelle Felder Positionen Notizen Dateianhänge Tags

Die Kür: Webhooks Nutzer Aktivitäten Filter Gruppen Individuelle Feld Typen

Bei den Aktivitäten in CentralStationCRM stehen die Actions index, show sowie count zur Verfügung. Die Aktivitäten können über die API also nur gelesen, nicht aber geschrieben werden. Bei der Erstellung von Objekten über die API (z.B. Personen oder Notizen), erstellen wir die korrekte Aktivität automatisch. Diese müssen also nicht manuell geschrieben werden. Jede Aktivität enthält die folgenden Felder:

Feldname Feldtyp Beschreibung
id INTEGER ID der Aktivität (Read only)
account_id INTEGER ID des Accounts (Read only, automatisch gesetzt)
user_id INTEGER ID des Users (Read only, automatisch gesetzt)
attachable_id INTEGER ID des verknüpften Objektes (Person, Company, Deal, Project, Task, Protocol) (Read only)
attachable_type VARCHAR(20) Typ des verknüpften Objektes, z.B. Angebot oder Projekt (Read only)
verb VARCHAR(120) Art der Aktivität (z.B. create, update, destroy ...) (Read only)
confidential BOOLEAN True, wenn die Aktivität vertraulich ist. (Read only)
change TEXT Änderung der Aktivität (Read only)
created_at TIMESTAMP Zeitpunkt der Erstellung (automatisch gesetzt, read only)
updated_at TIMESTAMP Zeitpunkt des letzten Updates (automatisch gesetzt, read only)

Action: Index

GET /activities.json
Mit der Index Action kann eine Liste aller Aktivitäten in einem Account (account_id), zu einem Nutzer (user_id), einer Person (person_id), einer Firma (company_id), einem Angebot (deal_id) oder einem Projekt (project_id) abgefragt werden. Die activities können entweder über die Subroute (/people/xy/activities.json) oder durch Angabe des Parameter (/activities.json?person_id=xy) abgefragt werden.

Verschachtelte Unterobjekte (optional)
Bei dem Aufruf der Index Funktion können die Unterobjekte über den includes Parameter im Format includes:'user attachable' direkt mit ausgeliefert werden. Mögliche Optionen sind: user attachable. Um alle genannten Optionen zu bekommen kann includes:'all' gesetzt werden.

Methods (optional)
Über den methods Parameter können einzelne Daten direkt in den JSON Hash eingebunden werden. Möglich ist methods=responsible_user_natural_name für den vollen Namen des verantwortlichen Nutzers sowie attachable für das Objekt, zu der die Aktivität gehört.

Einschränkung nach beliebigem Feld (optional)
Die Liste der Aktivitäten kann nach jedem der Aktivitätenfelder eingeschränkt werden. URL-Beispiele für die filter Parameter sind:

Beispiel für das Abrufen aller Aktivitäten eines Objektes via JSON:

  
curl -i
-H "Accept: application/json"
-X https://accountname.centralstationcrm.net/api/people/{id}/activities.json
  

Der Server gibt dann das erstellte Objekt zurück:

  
  {
    "activity":
      {
        "id":73224,
        "account_id":201,
        "attachable_type":"Person",
        "attachable_id":39725,
        "user_id":357,
        "verb":"update",
        "confidential":false,
        "change":{"person":{"action":"update"}},
        "created_at":"2011-06-22T15:06:38.000+02:00",
        "updated_at":"2011-06-22T15:06:38.000+02:00"
      }
    }
  

Beispiel für das Abrufen aller Aktivitäten, die ein spezieller Nutzer in jüngerer Vergangenheit erstellt hat:

  
    curl -i
    -H "Accept: application/json"
    -X https://accountname.centralstationcrm.net/api/activities.json?filter[user_id][equal]=1&filter[created_at][larger_than]=2019-09-07