Freigeben über


Finalcad One Connect 4.0 (Vorschau)

Finalcad One ist eine Baumanagementplattform zur Verbesserung der Zusammenarbeit, zum Nachverfolgen des Fortschritts und zur Optimierung von Feldvorgängen. Mit diesem Connector können Sie Finalcad One mit Hunderten anderer Anwendungen integrieren, um die Projektnachverfolgung zu vereinfachen, sich wiederholende Vorgänge zu automatisieren und die Gesamteffizienz zu verbessern.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Finalcad
URL https://www.finalcad.com/contact
Email support@finalcad.com
Connectormetadaten
Herausgeber FINALCAD
Webseite https://developer.finalcad.com/
Datenschutzrichtlinie https://www.finalcad.com/apps-privacy-policy
Kategorien Produktivität

Fc1 Connector

Voraussetzungen

To use this connector, you need a Finalcad API key.

Auslöser

When a form is created or updated
When an observation is created or updated
When a document is created

Aktionen

Read form details
Read observation details
Read project information
Read current user information

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Schlüssel securestring Der API-Schlüssel für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Arbeitsbereich – Mitglieder hinzufügen

Hinzufügen von Mitgliedern zu einem Arbeitsbereich

Liste der Zeitzonen abrufen

Abrufen der Liste der verfügbaren Zeitzonen

Medien – Abbrechen des Blockuploads

Abbrechen des aktuellen Blockuploadvorgangs und Verwerfen aller empfangenen Teile.

Medien – Medienressourcen-URL abrufen

Abrufen der URL für den Zugriff auf eine Medienressource

Medien – Starten des Blockuploads

Initiieren Sie den Vorgang zum Hochladen einer Mediendatei in Blöcken.

Medien – Teil "Block anfügen"

Fügen Sie einen einzelnen Block an die laufende Medienuploadsitzung an.

Medien – Überprüfen des Blockuploads

Bestätigen und abschließen Sie den Upload, indem Sie überprüfen, ob alle Blöcke korrekt empfangen wurden.

Organisation – Anfordern vorgeschlagener Module

Abrufen vorgeschlagener Module im Zusammenhang mit Ihrer Organisation

Organisation – Arbeitsbereiche abrufen

Abrufen von Arbeitsbereichen im Zusammenhang mit Ihrer Organisation

Organisation – Erstellen eines Projekts

Erstellen eines Projekts

Organisation – Formularstatus abrufen

Abrufen des Formularstatus in einer Vorlage

Organisation – Mitglieder hinzufügen

Hinzufügen von Mitgliedern zu einer Organisation

Organisation – Organisationsliste abrufen

Abrufen der Liste aller Organisationen, in denen Sie Mitglied sind

Organisation – Projektliste abrufen

Abrufen der Liste aller Ihre Projekte in einer bestimmten Organisation

Organisation – Rollen abrufen

Organisationsrollen abrufen

Organisation – Verbundene Benutzer abrufen

Abrufen ihrer Benutzerinformationen

Project – Benutzer abrufen

Abrufen der Benutzer in Ihrem Projekt

Project – Benutzer hinzufügen

Hinzufügen von Benutzern in Ihrem Projekt

Project – Rollen abrufen

Abrufen von Projektrollen

Projekt - Beobachtungsmodule abrufen

Abrufen der Liste aller vorhandenen Beobachtungsmodule für ein bestimmtes Projekt

Projekt - Unternehmen abrufen

Holen Sie sich die Unternehmen in Ihr Projekt

Projekt – Abrufen von Beobachtungsdetails

Abrufen der Details einer bestimmten Beobachtung (Beschreibung, Status, Zugewiesener,...)

Projekt – Abrufen von Beobachtungsmodellen

Beobachtungsmodelle abrufen (Die Kategorie wurde früher als Handel bezeichnet)

Projekt – Abrufen von Beobachtungsstatus

Abrufen des Beobachtungsstatus in Ihrem Projekt

Projekt – Abrufen von Dokumenten oder Ordnern

Abrufen eines Dokuments oder Ordners

Projekt – Abrufen von Dokumentordnern

Abrufen von Dokumentordnern in Ihrem Projekt

Projekt – Abrufen von Formularmodulen

Abrufen der Liste aller vorhandenen Formularmodule für ein bestimmtes Projekt

Projekt – Abrufen von Formularprioritäten

Abrufen der Formularprioritäten in Ihrem Projekt

Projekt – Abrufen von Formularvorlagen

Abrufen von Formularvorlagen

Projekt – Abrufen von Plänen oder Ordnern

Abrufen der Pläne oder Ordner in Ihrem Projekt

Projekt – Beobachtungskategorien abrufen

Beobachtungskategorien abrufen (früher Handel)

Projekt – Diskussionsgruppen abrufen

Abrufen der Diskussionsgruppen in Ihrem Projekt

Projekt – Erstellen einer Beobachtung

Erstellen einer Beobachtung

Projekt – Erstellen eines Dokuments

Projekt – Erstellen eines Dokuments

Projekt – Erstellen eines Formulars

Erstellen eines Formulars

Projekt – Formulardetails abrufen

Abrufen der Details eines bestimmten Formulars (Beschreibung, Vorlagenname, Zuweisender,...)

Projekt – Formularkategorien abrufen

Formularkategorien abrufen

Projekt – Phasen abrufen

Abrufen der Phasen in Ihrem Projekt

Projekt – Prioritäten für Beobachtungen abrufen

Abrufen der Beobachtungsprioritäten in Ihrem Projekt

Projekt – Projektdetails abrufen

Abrufen der Details eines bestimmten Projekts (Zeitzone, Sprache, Aktualisierungsdatum,...)

Setup – Projekt

Einrichten der Projektkonfiguration

Setup – Sprache und Zeitzone

Einrichten der Sprach- und Zeitzonenkonfiguration

Sprachen abrufen

Abrufen aller verfügbaren Sprachen für Bibliotheken und Elemente

Arbeitsbereich – Mitglieder hinzufügen

Hinzufügen von Mitgliedern zu einem Arbeitsbereich

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Arbeitsbereichs-ID
workspaceId True string

Arbeitsbereichs-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Benutzer-ID
user_id string

Benutzer-ID

Benutzer-E-Mail
user_email string

Benutzer-E-Mail

Gibt zurück

Liste der Zeitzonen abrufen

Abrufen der Liste der verfügbaren Zeitzonen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Anzahl der abzurufenden Zeitzonen.
limit string

Anzahl der abzurufenden Zeitzonen.

Nth Zeitzone.
offset string

Nth Zeitzone.

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Medien – Abbrechen des Blockuploads

Abbrechen des aktuellen Blockuploadvorgangs und Verwerfen aller empfangenen Teile.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Medien-ID
mediaId True string

Medien-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Block-ID
chunk_id True string

Block-ID

Gibt zurück

Body
Media

Medien – Medienressourcen-URL abrufen

Abrufen der URL für den Zugriff auf eine Medienressource

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Medien-ID
mediaId True string

Medien-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Medien – Starten des Blockuploads

Initiieren Sie den Vorgang zum Hochladen einer Mediendatei in Blöcken.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Name der Mediendatei
file_name True string

Name der Mediendatei

Mediengesamtgröße in Byte
total_bytes True integer

Medien gesamtgröße in Byte

Medien MD5
md5 string

Medien MD5

Gibt zurück

Medien – Teil "Block anfügen"

Fügen Sie einen einzelnen Block an die laufende Medienuploadsitzung an.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Medien-ID
mediaId True string

Medien-ID

Language
Accept-Language string

Language

Block-ID
chunk_id True string

Block-ID

Segmentnummer
segment_index True integer

Blocknummer

Letzter Aufruf?
last_chunk boolean

Letzter Aufruf?

filename
filename True string
Inhaltstyp
contentType True string
Inhalt
content True byte

Medien – Überprüfen des Blockuploads

Bestätigen und abschließen Sie den Upload, indem Sie überprüfen, ob alle Blöcke korrekt empfangen wurden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Medien-ID
mediaId True string

Medien-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Block-ID
chunk_id True string

Block-ID

Gibt zurück

Body
Media

Organisation – Anfordern vorgeschlagener Module

Abrufen vorgeschlagener Module im Zusammenhang mit Ihrer Organisation

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Arbeitsbereichs-ID
workspace_id string

Arbeitsbereichs-ID

Maximale Anzahl von Modulen
limit string

Maximale Anzahl von Modulen

Nth-Modul
offset string

Nth-Modul

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Organisation – Arbeitsbereiche abrufen

Abrufen von Arbeitsbereichen im Zusammenhang mit Ihrer Organisation

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Id des übergeordneten Arbeitsbereichs
parent_id string

Id des übergeordneten Arbeitsbereichs

Einschließen von untergeordneten Elementen
with_children string

Einschließen von untergeordneten Elementen

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Organisation – Erstellen eines Projekts

Erstellen eines Projekts

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Projektname
name True string

Projektname

Projektarbeitsbereich-ID
workspace_id string

Projektarbeitsbereich-ID

Projektmodul-IDs
module_ids array of string

Projektmodul-IDs

Projektbeschreibung
description string

Projektbeschreibung

Projektsprache
language string

Projektsprache

Zeitzone des Projekts
time_zone string

Projektzeitzone

Projektreferenz
case_number string

Projektreferenz

Projektadresse
address string

Projektadresse

Enddatum des Projekts
end_date string

Enddatum des Projekts

Gibt zurück

Organisation – Formularstatus abrufen

Abrufen des Formularstatus in einer Vorlage

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Formularvorlagen-ID
formId True string

Formularvorlagen-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Organisation – Mitglieder hinzufügen

Hinzufügen von Mitgliedern zu einer Organisation

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Rollen-ID
role_id string

Rollen-ID

Benutzer-E-Mail
users_info array of string

Benutzer-E-Mail

Organisation – Organisationsliste abrufen

Abrufen der Liste aller Organisationen, in denen Sie Mitglied sind

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Name Pfad Typ Beschreibung
array of object
id
id string

id

name
name string

name

Organisation – Projektliste abrufen

Abrufen der Liste aller Ihre Projekte in einer bestimmten Organisation

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Arbeitsbereichs-ID
workspace_id string

Arbeitsbereichs-ID

Untergeordnete Arbeitsbereiche einschließen
with_workspace_children boolean

Untergeordnete Arbeitsbereiche einschließen

Suchbegriff
search_term string

Suchbegriff

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Organisation – Rollen abrufen

Organisationsrollen abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
organizationId True string

Organisations-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetRoles

Organisation – Verbundene Benutzer abrufen

Abrufen ihrer Benutzerinformationen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Project – Benutzer abrufen

Abrufen der Benutzer in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

Maximale Anzahl der abzurufenden Mitglieder
limit integer

Maximale Anzahl der abzurufenden Mitglieder

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetMembers

Project – Benutzer hinzufügen

Hinzufügen von Benutzern in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Keine E-Mails an Benutzer senden
doNotSendEmail boolean

Keine E-Mails an Benutzer senden

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Benutzer-E-Mail
email True string

Benutzer-E-Mail

Benutzerrollen-ID
project_role_id True string

Benutzerrollen-ID

Gibt zurück

Body
AddMembers

Project – Rollen abrufen

Abrufen von Projektrollen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projekt-ID
projectId True string

Projekt-ID

Maximale Anzahl der abzurufenden Projektrollen
limit string

Maximale Anzahl der abzurufenden Projektrollen

Nth-Rolle
offset string

Nth-Rolle

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt - Beobachtungsmodule abrufen

Abrufen der Liste aller vorhandenen Beobachtungsmodule für ein bestimmtes Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

Maximale Anzahl der abzurufenden Module
limit integer

Maximale Anzahl der abzurufenden Module

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetModules

Projekt - Unternehmen abrufen

Holen Sie sich die Unternehmen in Ihr Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

Maximale Anzahl von Unternehmen, die abgerufen werden sollen
limit integer

Maximale Anzahl von Unternehmen, die abgerufen werden sollen

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Beobachtungsdetails

Abrufen der Details einer bestimmten Beobachtung (Beschreibung, Status, Zugewiesener,...)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Beobachtungs-ID
observationId True string

Beobachtungs-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Beobachtungsmodellen

Beobachtungsmodelle abrufen (Die Kategorie wurde früher als Handel bezeichnet)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Kategorie-ID
tradeId True string

Kategorie-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Beobachtungsstatus

Abrufen des Beobachtungsstatus in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

Maximale Anzahl des abzurufenden Status
limit integer

Maximale Anzahl des abzurufenden Status

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Dokumenten oder Ordnern

Abrufen eines Dokuments oder Ordners

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Dokument-ID
documentId True string

Dokument-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
Document

Projekt – Abrufen von Dokumentordnern

Abrufen von Dokumentordnern in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

ID des übergeordneten Ordners
parent_id string

ID des übergeordneten Ordners

FilterInhaltstyp ÔÇıfolder', 'documentÔÇÖ oder nichts.
type string

FilterInhaltstyp ÔÇıfolder', 'documentÔÇÖ oder nichts.

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Formularmodulen

Abrufen der Liste aller vorhandenen Formularmodule für ein bestimmtes Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

Maximale Anzahl der abzurufenden Module
limit integer

Maximale Anzahl der abzurufenden Module

Gelöschte Elemente einschließen
with_deleted boolean

Gelöschte Elemente einschließen

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Formularprioritäten

Abrufen der Formularprioritäten in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

Maximale Anzahl der abzurufenden Prioritäten
limit integer

Maximale Anzahl der abzurufenden Prioritäten

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Abrufen von Formularvorlagen

Abrufen von Formularvorlagen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Modul-ID
module_id string

Modul-ID

Kategorie-ID
category_id string

Kategorie-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetForms

Projekt – Abrufen von Plänen oder Ordnern

Abrufen der Pläne oder Ordner in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Ordner-ID
folder_id string

Ordner-ID

Nur Pläne oder Ordner einschließen
type string

Nur Pläne oder Ordner einschließen

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Beobachtungskategorien abrufen

Beobachtungskategorien abrufen (früher Handel)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Modul-ID
module_id string

Modul-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Diskussionsgruppen abrufen

Abrufen der Diskussionsgruppen in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Maximale Anzahl von Diskussionsgruppen, die abgerufen werden sollen
limit integer

Maximale Anzahl von Diskussionsgruppen, die abgerufen werden sollen

Die nth Diskussionsgruppe, aus der ich die Diskussionsgruppen abrufen möchte
offset integer

Die nth Diskussionsgruppe, aus der ich die Diskussionsgruppen abrufen möchte

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetGroups

Projekt – Erstellen einer Beobachtung

Erstellen einer Beobachtung

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Beobachtungsmodul-ID
module_id True string

Beobachtungsmodul-ID

Beobachtungskategorie-ID
trade_id string

Die Kategorie wurde früher als Handel bezeichnet

Beobachtungsmodell-ID
common_observation_id string

Das Modell wurde früher als gemeinsame Beobachtung bezeichnet.

Beobachtungsbeschreibung
description string

Beobachtungsbeschreibung

Beobachtungsstatus-ID
status_id string

Beobachtungsstatus-ID

Beobachtungs-Firmen-ID
company_id string

Beobachtung zugewiesene Firmen-ID

Beobachtungsempfänger-ID
assignee_id string

Zugewiesene Benutzer-ID der Beobachtung

Beobachtungsplan-ID
plan_id string

Beobachtungsplan-ID

Beobachtungs-X-Position auf Plan
position_x decimal

Beobachtungs-X-Position zwischen 0 und 1

Beobachtungsposition Y auf Plan
position_y decimal

Beobachtungsposition Y zwischen 0 und 1

Beobachtungsprioritäts-ID
priority_id string

Beobachtungsprioritäts-ID

Beobachtungsfälligkeitsdatum
due_date string

Fälligkeitsdatum der Beobachtung

Beobachtungsphase-ID
phase_id string

Beobachtungsphasen-ID

Beobachtungsdiskysionsgruppen-ID
group_id string

Die Diskussionsgruppe, in der die Beobachtung über ihre Schaffung geteilt werden sollte

Beobachtungsbreite
latitude decimal

Beobachtungsbreite

Länge der Beobachtung
longitude decimal

Länge der Beobachtung

Beobachtungs-ID
id string

Beobachtungs-ID

Gibt zurück

Projekt – Erstellen eines Dokuments

Projekt – Erstellen eines Dokuments

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Dokumentname
name True string

Dokumentname

Übergeordnete Dokument-ID
parent_id string

ID des übergeordneten Ordners

Dokumentmedien-ID
media_id string

Wenn das Feld nicht ausgefüllt ist, wird ein Ordner erstellt.

Gibt zurück

Projekt – Erstellen eines Formulars

Erstellen eines Formulars

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Formularmodul-ID
module_id True string

Formularmodul-ID

Formularvorlage
form_id True string

Formularvorlagen-ID

Formularname
name True string

Formularname

Formularkategorie-ID
category_id string

Formularkategorie-ID

Formularstatus-ID
status_id string

Formularstatus-ID

Firmen-ID des Formulars
company_id string

Formular zugewiesene Firmen-ID

Formularzuweisungs-ID
assignee_id string

Formular zugewiesene Benutzer-ID

Formularplan-ID
plan_id string

Formularplan-ID

Form X-Position
position_x decimal

Form X-Position im Plan zwischen 0 und 1

Form Y-Position
position_y decimal

Form Y-Position im Plan zwischen 0 und 1

Form Latitude
latitude decimal

Breitengrad der Form

Längengrad des Formulars
longitude decimal

Länge des Formulars

Formularprioritäts-ID
priority_id string

Formularprioritäts-ID

Fälligkeitsdatum des Formulars
due_date string

Fälligkeitsdatum des Formulars

Formularphasen-ID
phase_id string

Formularphasen-ID

Formular-ID
id string

Formular-ID

Gibt zurück

Projekt – Formulardetails abrufen

Abrufen der Details eines bestimmten Formulars (Beschreibung, Vorlagenname, Zuweisender,...)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Formular-ID
formId True string

Formular-ID

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Formularkategorien abrufen

Formularkategorien abrufen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Modul-ID
module_id string

Modul-ID

Übergeordnete Kategorie-ID
category_id string

Übergeordnete Kategorie-ID

Deaktiviert einschließen
with_disabled string

Deaktiviert einschließen

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Phasen abrufen

Abrufen der Phasen in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

N. Phase
offset string

N. Phase

Maximale Anzahl der abzurufenden Phasen
limit integer

Maximale Anzahl der abzurufenden Phasen

Gelöschte Elemente einschließen
with_deleted boolean

Gelöschte Elemente einschließen

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetPhases

Projekt – Prioritäten für Beobachtungen abrufen

Abrufen der Beobachtungsprioritäten in Ihrem Projekt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Fortlaufendes Token
continuous_token string

Fortlaufendes Token

N. Priorität
offset string

N. Priorität

Maximale Anzahl der abzurufenden Prioritäten
limit integer

Maximale Anzahl der abzurufenden Prioritäten

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Projekt – Projektdetails abrufen

Abrufen der Details eines bestimmten Projekts (Zeitzone, Sprache, Aktualisierungsdatum,...)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Projektkennung
projectId True string

Projektkennung

Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Body
GetProject

Setup – Projekt

Einrichten der Projektkonfiguration

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Organisations-ID
business_organization_id string

Organisations-ID

Projektkennung
project_id string

Projektkennung

Gibt zurück

Name Pfad Typ Beschreibung
business_organization_id
business_organization_id string
project_id
project_id string

Setup – Sprache und Zeitzone

Einrichten der Sprach- und Zeitzonenkonfiguration

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Language
language string

Language

Zeitzone
timezone string

Zeitzone des Benutzers (im IANA-Format)

Gibt zurück

Name Pfad Typ Beschreibung
language
language string
timezone
timezone string

Sprachen abrufen

Abrufen aller verfügbaren Sprachen für Bibliotheken und Elemente

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Language
Accept-Language string

Language

TimeZone
X-TimeZone string

TimeZone

Gibt zurück

Trigger

Trigger - Beobachtung aktualisiert

Auslösen des Flusses, wenn eine Beobachtung aktualisiert wird

Trigger - Beobachtung erstellt

Auslösen des Flusses, wenn eine Beobachtung erstellt wird

Trigger - Formular erstellt

Auslösen des Flusses beim Erstellen eines Formulars

Trigger – Dokument erstellt

Auslösen des Ablaufs beim Erstellen eines Dokuments

Trigger – Formular aktualisiert

Auslösen des Flusses, wenn ein Formular aktualisiert wird

Trigger - Beobachtung aktualisiert

Auslösen des Flusses, wenn eine Beobachtung aktualisiert wird

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
business_organization_id
business_organization_id True string

Organisations-ID

project_id
project_id True string

Projektkennung

Gibt zurück

Name Pfad Typ Beschreibung
parent_id
parent_id string

parent_id

Ereignis
event integer

Ereignis

element_id
element_id string

element_id

Data1
data1 string

Data1

data2
data2 string

data2

Data3
data3 string

Data3

Trigger - Beobachtung erstellt

Auslösen des Flusses, wenn eine Beobachtung erstellt wird

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
business_organization_id
business_organization_id True string

Organisations-ID

project_id
project_id True string

Projektkennung

Gibt zurück

Name Pfad Typ Beschreibung
parent_id
parent_id string

parent_id

Ereignis
event integer

Ereignis

element_id
element_id string

element_id

Data1
data1 string

Data1

data2
data2 string

data2

Data3
data3 string

Data3

Trigger - Formular erstellt

Auslösen des Flusses beim Erstellen eines Formulars

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
business_organization_id
business_organization_id True string

Organisations-ID

project_id
project_id True string

Projektkennung

Gibt zurück

Name Pfad Typ Beschreibung
parent_id
parent_id string

parent_id

Ereignis
event integer

Ereignis

element_id
element_id string

element_id

Data1
data1 string

Data1

data2
data2 string

data2

Data3
data3 string

Data3

Trigger – Dokument erstellt

Auslösen des Ablaufs beim Erstellen eines Dokuments

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
business_organization_id
business_organization_id True string

Organisations-ID

project_id
project_id True string

Projektkennung

Gibt zurück

Name Pfad Typ Beschreibung
parent_id
parent_id string

parent_id

Ereignis
event integer

Ereignis

element_id
element_id string

element_id

Data1
data1 string

Data1

data2
data2 string

data2

Data3
data3 string

Data3

Trigger – Formular aktualisiert

Auslösen des Flusses, wenn ein Formular aktualisiert wird

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
business_organization_id
business_organization_id True string

Organisations-ID

project_id
project_id True string

Projektkennung

Gibt zurück

Name Pfad Typ Beschreibung
parent_id
parent_id string

parent_id

Ereignis
event integer

Ereignis

element_id
element_id string

element_id

Data1
data1 string

Data1

data2
data2 string

data2

Data3
data3 string

Data3

Definitionen

AddMembers

Name Pfad Typ Beschreibung
Benutzerliste
project_roles array of ProjectRole

Benutzerliste

Firma

Name Pfad Typ Beschreibung
Unternehmens-ID
id string

Unternehmens-ID

Unternehmensname
name string

Unternehmensname

Unternehmen ist aktiviert
enabled boolean

Unternehmen ist aktiviert

Unternehmensmitglieder
user_ids array of string

Unternehmensmitglieder

Unternehmensreferenz
reference string

Unternehmensreferenz

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

CreateDocument

Name Pfad Typ Beschreibung
Dokument-ID
id string

Dokument-ID

Dokumenttyp
type string

Dokumenttyp

Dokumentname
name string

Dokumentname

Id des übergeordneten Dokumentordners
parent_id string

Id des übergeordneten Dokumentordners

media_resource
media_resource Media
Dokument ist aktiviert
enabled boolean

Dokument ist aktiviert

Dokumenttyp
file_type string

Dokumenttyp

Dokumentquelle
item_source string

Dokumentquelle

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

CreateFormInstance

Name Pfad Typ Beschreibung
Formular-ID
id string

Formular-ID

Formularname
name string

Formularname

Formularvorlagen-ID
form_id string

Formularvorlagen-ID

Formularstatus-ID
status_id string

Formularstatus-ID

Formularprioritäts-ID
priority_id string

Formularprioritäts-ID

Formularplan-ID
plan_id string

Formularplan-ID

Form X-Position
position_x decimal

Form X-Position

Form Y-Position
position_y decimal

Form Y-Position

Breitengrad der Form
latitude decimal

Breitengrad der Form

Länge des Formulars
longitude decimal

Länge des Formulars

Formularbenutzer-ID
assignee_id string

Formular zugewiesene Benutzer-ID

Formular-Firmen-ID
company_id string

Formular zugewiesene Firmen-ID

Fälligkeitsdatum des Formulars
due_date string

Fälligkeitsdatum des Formulars

Erstellungsdatum des Formulars
client_created_at string

Formularerstellungs-ID

Datum der Formularaktualisierung
client_updated_at string

Formularaktualisierungs-ID

Formularmodul-ID
module_id string

Formularmodul-ID

Formularphasen-ID
phase_id string

Formularphasen-ID

Formularkategorie-ID
category_id string

Formularkategorie-ID

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

CreateObservation

Name Pfad Typ Beschreibung
id
id string
project_id
project_id string
Beschreibung
description string
status_id
status_id string
priority_id
priority_id string
plan_id
plan_id string
position_x
position_x decimal
position_y
position_y decimal
latitude
latitude decimal
longitude
longitude decimal
assignee_id
assignee_id string
company_id
company_id string
trade_id
trade_id string
common_observation_id
common_observation_id string
due_date
due_date string
client_created_at
client_created_at string
client_updated_at
client_updated_at string
module_id
module_id string
phase_id
phase_id string
Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

CreateProject

Name Pfad Typ Beschreibung
Projektadresse
address string

Projektadresse

Zeitzone des Projekts
time_zone string

Project IANA Zeitzone

Projektsprache
language string

Projektsprache

Projektkennung
project_id string

Projektkennung

Projektorganisations-ID
organization_id string

Projektorganisations-ID

Projektname
name string

Projektname

Projektfall
case_number string

Projektfall

Projektarbeitsbereich-ID
workspace_id string

Projektarbeitsbereich-ID

Projektbeschreibung
description string

Projektbeschreibung

Enddatum des Projekts
end_date string

Enddatum des Projekts

Anzahl der Project-Mitglieder
member_count integer

Anzahl der Project-Mitglieder

Projekt wird archiviert
is_archived boolean

Projekt wird archiviert

media_resource
media_resource Media
Ist der aktuelle Benutzer im Projekt
current_user_in_project boolean

Ist der aktuelle Benutzer im Projekt?

Project ist aktiv
is_active boolean

Project ist aktiv

Status des Projekts
status string

Status des Projekts

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

Dokument

Name Pfad Typ Beschreibung
Dokument-ID
id string

Dokument-ID

Dokumenttyp
type string

Dokumenttyp

Dokumentname
name string

Dokumentname

Id des übergeordneten Dokumentordners
parent_id string

Id des übergeordneten Dokumentordners

media_resource
media_resource Media
Dokument ist aktiviert
enabled boolean

Dokument ist aktiviert

Dokumenttyp
file_type string

Dokumenttyp

Dokumentquelle
item_source string

Dokumentquelle

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

FolderContent

Name Pfad Typ Beschreibung
Ordnerinhalts-ID
id string

Ordnerinhalts-ID

Ordnerinhaltstyp
type string

Ordnerinhaltstyp

Ordnerinhaltsname
name string

Ordnerinhaltsname

Ordnerinhaltsreihenfolge
order double

Ordnerinhaltsreihenfolge

Erstellungsdatum des Ordnerinhalts
created_at string

Erstellungsdatum des Ordnerinhalts

Aktualisierungsdatum des Ordnerinhalts
updated_at string

Aktualisierungsdatum des Ordnerinhalts

Ordnerinhaltsquelle
source string

Inhalt des Ordners

Ordnerinhaltsordnerquelle
sources_contained string

Ordnerinhaltsordnerquelle

Ordnerinhalt ist aktiviert
enabled boolean

Ordnerinhalt ist aktiviert

Formular

Name Pfad Typ Beschreibung
Vorlagen-ID
id string

Vorlagen-ID

Vorlagenname
name string

Vorlagenname

Vorlage aktiviert
enabled boolean

Vorlage aktiviert ja/nein

Versionsnummer der Vorlage
version integer

Versionsnummer der Vorlage

Vorlagenmodul-ID
module_id string

Vorlagenmodul-ID

Vorlagenkategorie-ID
category_id string

Vorlagenkategorie-ID

Erstellungsdatum der Vorlage
created_at string

Erstellungsdatum der Vorlage

Datum der Vorlagenaktualisierung
updated_at string

Datum der Vorlagenaktualisierung

GetCommonObsByTrade

Name Pfad Typ Beschreibung
CommonObs
common_observations array of ObservationCommonObservation

CommonObs

GetCompanies

Name Pfad Typ Beschreibung
Unternehmen
companies array of Company

Unternehmen

Liste ist nicht abgeschlossen
need_to_relaunch boolean

Liste ist nicht abgeschlossen

Fortlaufendes Token
continuous_token string

Token zum Abrufen der nächsten Elemente

Anzahl der Elemente
count integer

Anzahl der Elemente

Gesamtzahl der Elemente
total_count integer

Gesamtzahl der Elemente

GetDocumentsFiltered

Name Pfad Typ Beschreibung
Urkunden
documents array of Document
count
count integer

GetFolderContent

Name Pfad Typ Beschreibung
Ordnerinhalt
contents array of FolderContent

Ordnerinhalt

count
count integer

GetFormFull

Name Pfad Typ Beschreibung
Formular-ID
id string

Formular-ID

Formularnummer
legacy_id integer

Formularnummer

Formular aktiviert
enabled boolean

Formular aktiviert

Formularvorlagen-ID
form_id string

Formularvorlagen-ID

Organisations-ID
organization_id string

Organisations-ID

Name der Organisation
organization_name string

Name der Organisation

Projekt-ID
project_id string

Projektkennung

Projektname
project_name string

Projektname

Formularbeschreibung
description string

Formularbeschreibung

Formularvorlagenname
template_name string

Formularvorlagenname

Formularstatus-ID
status_id string

Formularstatus-ID

Formularstatusname
status_name string

Formularstatusname

Formularprioritäts-ID
priority_id string

Formularprioritäts-ID

Formularprioritätsname
priority_name string

Formularprioritätsname

Formularbenutzer-ID
assignee_id string

Formular zugewiesene Benutzer-ID

Formularbenutzername
assignee_name string

Formular zugewiesener Benutzername

Formular-Firmen-ID
company_id string

Formular-Firmen-ID

Firmenname des Formulars
company_name string

Formular zugewiesener Firmenname

Fälligkeitsdatum des Formulars
due_date string

Fälligkeitsdatum des Formulars

Formularplan-ID
plan_id string

Formularplan-ID

Formularplanname
plan_name string

Formularplanname

Form X-Position
position_x string

Form X-Position

Form Y-Position
position_y string

Form Y-Position

Breitengrad der Form
latitude string

Breitengrad der Form

Länge des Formulars
longitude string

Länge des Formulars

Formularmodul-ID
module_id string

Formularmodul-ID

Formularmodulname
module_name string

Formularmodulname

Formularphasen-ID
phase_id string

Formularphasen-ID

Formularphasenname
phase_name string

Formularphasenname

Formularkategorie-ID
category_id string

Formularkategorie-ID

Formularkategoriename
category_name string

Formularkategoriename

Formularlöschdatum
deleted_at string

Formularlöschdatum

Formular gelöscht von
deleted_by string

Formular, das von der Benutzer-ID gelöscht wurde

Erstellungsdatum des Formulars
client_created_at string

Erstellungsdatum des Formulars

Datum der Formularaktualisierung
client_updated_at string

Datum der Formularaktualisierung

Formular-URL
web_url string

Formular-URL

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

GetFormStatuses

Name Pfad Typ Beschreibung
Status
statuses array of StatusResponseWithoutLanguage

Status

count
count integer

GetForms

Name Pfad Typ Beschreibung
Liste der Vorlagen
forms array of Form

Liste der Vorlagen

count
count integer

GetGroup

Name Pfad Typ Beschreibung
Gruppen-ID
id string

Gruppen-ID

Gruppenname
name string

Gruppenname

GetGroups

Name Pfad Typ Beschreibung
Gruppen
groups array of GetGroup

Gruppen

count
count integer
total_count
total_count integer
Begrenzung
limit integer
offset
offset integer

GetLanguage

Name Pfad Typ Beschreibung
Sprachcode
code string

Sprachcode

Sprachbeschreibung
name string

Sprachbeschreibung

GetLanguages

Name Pfad Typ Beschreibung
Sprachenliste
langs array of GetLanguage

Sprachenliste

Anzahl der Sprachen
count integer

Anzahl der Sprachen

GetMembers

Name Pfad Typ Beschreibung
Project-Mitglieder
project_members array of Member

Project-Mitglieder

Liste ist nicht abgeschlossen
need_to_relaunch boolean

Liste ist nicht abgeschlossen

Fortlaufendes Token
continuous_token string

Token zum Abrufen der nächsten Elemente

Anzahl der Elemente
count integer

Anzahl der Elemente

Gesamtzahl der Elemente
total_count integer

Gesamtzahl der Elemente

GetModules

Name Pfad Typ Beschreibung
Modulliste
modules array of Module

Liste der Projektmodule

need_to_relaunch
need_to_relaunch boolean
continuous_token
continuous_token string
offset
offset string
count
count integer

GetModulesCategories

Name Pfad Typ Beschreibung
Kategorien
categories array of ModuleCategory

Kategorien

count
count integer

GetModulesForm

Name Pfad Typ Beschreibung
Modulliste
modules array of ModuleForm

Modulliste

Liste ist nicht abgeschlossen
need_to_relaunch boolean

Liste ist nicht abgeschlossen

Fortlaufendes Token
continuous_token string

Token zum Abrufen der nächsten Elemente

Anzahl der Elemente
count integer

Anzahl der Elemente

Gesamtzahl der Elemente
total_count integer

Gesamtzahl der Elemente

GetModulesOrgaSuggestion

Name Pfad Typ Beschreibung
Anregungen
suggestions array of ModuleOrgaSuggestion

Anregungen

count
count integer
total_count
total_count integer
Begrenzung
limit integer
offset
offset integer

GetObservationFull

Name Pfad Typ Beschreibung
Beobachtungs-ID
id string

Beobachtungs-ID

Beobachtungszahl
legacy_id integer

Beobachtungszahl

Beobachtung ist aktiviert
enabled boolean

Beobachtung ist aktiviert

Beobachtungsprojekt-ID
project_id string

Beobachtungsprojekt-ID

Name des Beobachtungsprojekts
project_name string

Name des Beobachtungsprojekts

Beobachtungsorganisations-ID
organization_id string

Beobachtungsorganisations-ID

Name der Beobachtungsorganisation
organization_name string

Name der Beobachtungsorganisation

Beobachtungsbeschreibung
description string

Beobachtungsbeschreibung

Beobachtungsstatus-ID
status_id string

Beobachtungsstatus-ID

Name des Beobachtungsstatus
status_name string

Name des Beobachtungsstatus

Beobachtungsprioritäts-ID
priority_id string

Beobachtungsprioritäts-ID

Name der Beobachtungspriorität
priority_name string

Name der Beobachtungspriorität

Beobachtungsplan-ID
plan_id string

Beobachtungsplan-ID

Name des Beobachtungsplans
plan_name string

Name des Beobachtungsplans

BeobachtungS-X-Position
position_x decimal

BeobachtungS-X-Position

Beobachtungsposition Y
position_y decimal

Beobachtungsposition Y

Beobachtungsbreite
latitude decimal

Beobachtungsbreite

Länge der Beobachtung
longitude decimal

Länge der Beobachtung

Beobachtungsbenutzer-ID
assignee_id string

Zugewiesene Benutzer-ID der Beobachtung

Beobachtungsbenutzername
assignee_name string

Beobachtung zugewiesener Benutzername

Beobachtungs-Firmen-ID
company_id string

Beobachtung zugewiesene Firmen-ID

Name des Beobachtungsunternehmens
company_name string

Beobachtung zugewiesener Firmenname

Beobachtungshandels-ID
trade_id string

Beobachtungshandels-ID

Beobachtungshandelsname
trade_name string

Beobachtungshandelsname

Beobachtung commonobs id
common_observation_id string

Beobachtung allgemeiner Beobachtungs-ID

Commonobs-Name der Beobachtung
common_observation_name string

Beobachtung allgemeiner Beobachtungsname

Fälligkeitsdatum der Beobachtung
due_date string

Fälligkeitsdatum der Beobachtung

Beobachtungsmodul-ID
module_id string

Beobachtungsmodul-ID

Name des Beobachtungsmoduls
module_name string

Name des Beobachtungsmoduls

deleted_at
deleted_at string
deleted_by
deleted_by string
Beobachtungsphasen-ID
phase_id string

Beobachtungsphasen-ID

Name der Beobachtungsphase
phase_name string

Name der Beobachtungsphase

Beobachtungsbilder
photos array of ObservationMediaResource

Beobachtungsbilder

Erstellungsdatum der Beobachtung
client_created_at string

Erstellungsdatum der Beobachtung

Aktualisierungsdatum der Beobachtung
client_updated_at string

Aktualisierungsdatum der Beobachtung

Beobachtungs-URL
web_url string

Beobachtungs-URL

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

GetPhases

Name Pfad Typ Beschreibung
Phasen
phases array of Phase

Phasen

Liste ist nicht abgeschlossen
need_to_relaunch boolean

Liste ist nicht abgeschlossen

Fortlaufendes Token
continuous_token string

Token zum Abrufen der nächsten Elemente

Anzahl der Elemente
count integer

Anzahl der Elemente

Gesamtzahl der Elemente
total_count integer

Gesamtzahl der Elemente

GetPriorities

Name Pfad Typ Beschreibung
Prioritäten
priorities array of Priority

Prioritäten

Liste ist nicht abgeschlossen
need_to_relaunch boolean

Liste ist nicht abgeschlossen

Fortlaufendes Token
continuous_token string

Token zum Abrufen der nächsten Elemente

Anzahl der Elemente
count integer

Anzahl der Elemente

Gesamtzahl der Elemente
total_count integer

Gesamtzahl der Elemente

GetProject

Name Pfad Typ Beschreibung
Projektadresse
address string

Projektadresse

Zeitzone des Projekts
time_zone string

Project IANA Zeitzone

Projektsprache
language string

Projektsprache

Projektkennung
project_id string

Projektkennung

Projektorganisations-ID
organization_id string

Projektorganisations-ID

Projektname
name string

Projektname

Projektfall
case_number string

Projektfall

Projektarbeitsbereich-ID
workspace_id string

Projektarbeitsbereich-ID

Projektbeschreibung
description string

Projektbeschreibung

Enddatum des Projekts
end_date string

Enddatum des Projekts

Anzahl der Project-Mitglieder
member_count integer

Anzahl der Project-Mitglieder

Projekt wird archiviert
is_archived boolean

Projekt wird archiviert

media_resource
media_resource Media
Ist der aktuelle Benutzer im Projekt
current_user_in_project boolean

Ist der aktuelle Benutzer im Projekt?

Project ist aktiv
is_active boolean

Project ist aktiv

Status des Projekts
status string

Status des Projekts

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

GetProjectRoles

Name Pfad Typ Beschreibung
project_roles
project_roles array of ProjectRole
count
count integer
total_count
total_count integer
Begrenzung
limit integer
offset
offset integer

GetProjects

Name Pfad Typ Beschreibung
Projektliste
projects array of Project

Liste der Projekte

count
count integer
total_count
total_count integer
Begrenzung
limit integer
offset
offset integer

GetRole

Name Pfad Typ Beschreibung
Rollen-ID
id string

Rollen-ID

Rollenname
name string

Rollenname

Rollenbeschreibung
description string

Rollenbeschreibung

names
names LocalizedLabelFallback
Beschreibungen
descriptions LocalizedLabelFallback
Rolle ist Standard
is_default boolean

Rolle ist Standard

is_default_invitation_role
is_default_invitation_role boolean
user_count
user_count integer
Position
position integer
authorization_role_id
authorization_role_id string
higher_role_id
higher_role_id string
is_lower_role
is_lower_role boolean

GetRoles

Name Pfad Typ Beschreibung
organization_roles
organization_roles array of GetRole

GetStatuses

Name Pfad Typ Beschreibung
Status
statuses array of StatusResponseWithoutFlow

Status

Liste ist nicht abgeschlossen
need_to_relaunch boolean

Liste ist nicht abgeschlossen

Fortlaufendes Token
continuous_token string

Token zum Abrufen der nächsten Elemente

Anzahl der Elemente
count integer

Anzahl der Elemente

Gesamtzahl der Elemente
total_count integer

Gesamtzahl der Elemente

GetTimeZones

Name Pfad Typ Beschreibung
Zeitzonenliste
time_zones array of TimeZones

Zeitzonenliste

count
count integer
total_count
total_count integer
Begrenzung
limit integer
offset
offset integer

GetTradesByModule

Name Pfad Typ Beschreibung
Facharbeiten
trades array of ProjectTrade

Facharbeiten

GetUserInfo

Name Pfad Typ Beschreibung
Benutzer-ID
id string

Benutzer-ID

Vorname des Benutzers
first_name string

Vorname des Benutzers

Nachname des Benutzers
last_name string

Nachname des Benutzers

Benutzer-E-Mail
email string

Benutzer-E-Mail

Firmenname des Benutzers
company string

Firmenname des Benutzers

ist aktiv
is_active string

ist aktiv

email_validated
email_validated string
Erstellungsdatum des Benutzers
created_at string

Erstellungsdatum des Benutzers

updated_at
updated_at string
deleted_at
deleted_at string
media_resource
media_resource Media
Gebietsschema des Benutzers
locale string

Gebietsschema des Benutzers

GetWorkspaceMembers

Name Pfad Typ Beschreibung
workspace_members
workspace_members array of OrgaMemberResponses
count
count integer
total_count
total_count integer
Begrenzung
limit integer
offset
offset integer

GetWorkspaces

Name Pfad Typ Beschreibung
Arbeitsbereiche
workspaces array of Workspace

Arbeitsbereiche

IconTypeParameters

LocalizedLabel

Name Pfad Typ Beschreibung
language
language string
Übersetzung
translation string

LocalizedLabelFallback

Name Pfad Typ Beschreibung
translation_fallback
translation_fallback string
Übersetzungen
translations array of LocalizedLabel

Medien

Name Pfad Typ Beschreibung
Medien-ID
id string

Medien-ID

Name der Mediendatei
file_name string

Name der Mediendatei

Medien-MIME-Typ
mime_type string

Medien-MIME-Typ

Erstellungsdatum der Medien
created_at string

Erstellungsdatum der Medien

MediaResourceUrl

Name Pfad Typ Beschreibung
Medien-URL
url string

Medien-URL

Mitglied

Name Pfad Typ Beschreibung
Mitglieds-ID
user_id string

Mitglieds-ID

Vorname des Mitglieds
first_name string

Vorname des Mitglieds

Nachname des Mitglieds
last_name string

Nachname des Mitglieds

Mitglieds-E-Mail
email string

Mitglieds-E-Mail

Mitgliedsrollen-ID
project_role_id string

Mitgliedsrollen-ID

Bild
picture Media
Member ist aktiviert
enabled boolean

Member ist aktiviert

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

Modul

Name Pfad Typ Beschreibung
Modul-ID
id string

Modul-ID

project_id
project_id string
Modulname
name string

Modulname

Anzeigereihenfolge des Moduls
order double

Anzeigereihenfolge des Moduls

Modulsymbol
icon string

Modulsymbol

Modulfarbe
color string

Modulfarbe

Modultyp
type string

Modultyp

names
names array of LocalizedLabel
Erstellungsdatum des Moduls
created_at string

Erstellungsdatum des Moduls

Aktualisierungsdatum des Moduls
updated_at string

Aktualisierungsdatum des Moduls

Modul ist aktiviert
enabled boolean

Modul ist aktiviert

Einstellungen
settings ModuleSettings

ModuleCategory

Name Pfad Typ Beschreibung
Kategorie-ID
id string

Kategorie-ID

Kategoriemodul-ID
module_id string

Kategoriemodul-ID

Kategoriecontainer-ID
container_id string

Kategoriecontainer-ID

Kategoriename
name string

Kategoriename

Übergeordnete Kategorie-ID
parent_id string

Übergeordnete Kategorie-ID

Erstellungsdatum der Kategorie
created_at string

Erstellungsdatum der Kategorie

Datum der Kategorieaktualisierung
updated_at string

Datum der Kategorieaktualisierung

Kategorielöschdatum
deleted_at string

Kategorielöschdatum

Kategorie ist aktiviert
enabled boolean

Kategorie ist aktiviert

ModuleForm

Name Pfad Typ Beschreibung
Modul-ID
id string

Modul-ID

Projektkennung
project_id string

Projektkennung

Modulname
name string

Modulname

Modulreihenfolge
order double

Anzeigereihenfolge des Moduls

Modulsymbol
icon string

Modulsymbol

Modulfarbe
color string

Modulfarbe

Modultyp
type string

Modultyp

names
names array of LocalizedLabel
Erstellungsdatum des Moduls
created_at string

Moduleinstellungen

Aktualisierungsdatum des Moduls
updated_at string

Moduleinstellungen

Modul ist aktiviert
enabled boolean

Moduleinstellungen

ModuleOrgaSuggestion

Name Pfad Typ Beschreibung
Vorschlagsstandard
is_default boolean

Vorschlagsstandard

Vorschlagsnamen
names array of LocalizedLabel

Vorschlagsnamen

id
id string
container_id
container_id string
container_type
container_type string
Vorschlagsname
name string

Vorschlagsname

Ikone
icon string
color
color string
Vorschlagstyp
type string

Vorschlagstyp

Vorschlagssichtbarkeit
visibility string

Vorschlagssichtbarkeit

erstellt_am
created_at string
updated_at
updated_at string

ModuleSettings

Name Pfad Typ Beschreibung
is_observation_library_mandatory
is_observation_library_mandatory boolean
is_description_mandatory
is_description_mandatory boolean
is_photo_mandatory
is_photo_mandatory boolean
is_company_mandatory
is_company_mandatory boolean
is_group_mandatory
is_group_mandatory boolean
due_date_days_offset
due_date_days_offset string

ObservationCommonObservation

Name Pfad Typ Beschreibung
CommonObs-ID
id string

CommonObs-ID

CommonObs Trade Id
trade_id string

CommonObs Trade Id

CommonObs-Name
name string

CommonObs-Name

CommonObs-Namen
names array of LocalizedLabel

CommonObs-Namen

CommonObs ist aktiviert
enabled boolean

CommonObs ist aktiviert

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

ObservationMediaResource

Name Pfad Typ Beschreibung
Medien-ID
id string

Medien-ID

Medienreihenfolge
position string

Medienreihenfolge

Medien-MIME-Typ
mime_type string

Medien-MIME-Typ

Name der Mediendatei
file_name string

Name der Mediendatei

OrgaMemberResponses

Name Pfad Typ Beschreibung
Benutzer-ID
user_id string
E-Mail
email string
Vorname
first_name string
Nachname
last_name string
is_admin
is_admin boolean
is_pending
is_pending boolean
media_resource
media_resource Media

Phase

Name Pfad Typ Beschreibung
Phasen-ID
id string

Phasen-ID

Phasenreihenfolge
order double

Phasenreihenfolge

Name der Phase
name string

Name der Phase

Phasennamen
names array of LocalizedLabel

Phasennamen

Phase ist aktiviert
enabled boolean

Phase ist aktiviert

Erstellungsdatum der Phase
created_at string

Erstellungsdatum der Phase

Aktualisierungsdatum der Phase
updated_at string

Aktualisierungsdatum der Phase

Datum des Phasenlöschvorgangs
deleted_at string

Datum des Phasenlöschvorgangs

Priority

Name Pfad Typ Beschreibung
Prioritäts-ID
id string

Prioritäts-ID

Prioritätsname
name string

Prioritätsname

Prioritätsreihenfolge
position integer

Prioritätsreihenfolge

Prioritätsfarbe
color string

Prioritätsfarbe

Ikone
icon IconTypeParameters
Prioritäts-ID
is_default boolean

Prioritäts-ID

Priorität ist Standard
names array of LocalizedLabel

Priorität ist Standard

Priorität ist aktiviert
enabled boolean

Priorität ist aktiviert

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

Project

Name Pfad Typ Beschreibung
Projektkennung
project_id string

Projektkennung

Projektorganisations-ID
organization_id string

Projektorganisations-ID

Projektname
name string

Projektname

Projektfall
case_number string

Projektfall

Projektarbeitsbereich-ID
workspace_id string

Projektarbeitsbereich-ID

Projektbeschreibung
description string

Projektbeschreibung

Enddatum des Projekts
end_date string

Enddatum des Projekts

Anzahl der Project-Mitglieder
member_count integer

Anzahl der Project-Mitglieder

Projekt wird archiviert
is_archived boolean

Projekt wird archiviert

media_resource
media_resource Media
Ist der aktuelle Benutzer im Projekt
current_user_in_project boolean

Ist der aktuelle Benutzer im Projekt?

Project ist aktiv
is_active boolean

Project ist aktiv

Status des Projekts
status string

Status des Projekts

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

ProjectRole

Name Pfad Typ Beschreibung
Benutzerliste
user_ids array of string

Benutzerliste

Rollen-ID
id string

Rollen-ID

Rollenname
name string

Rollenname

Rollennamen
names array of LocalizedLabel

Rollennamen

Rollenbeschreibungen
descriptions array of LocalizedLabel

Rollenbeschreibungen

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

ProjectTrade

Name Pfad Typ Beschreibung
Handels-ID
id string

Trades ID

Ist aktiviert
enabled boolean

Ist aktiviert

Handelsname
name string

Handelsname

Markennamen
names array of LocalizedLabel

Markennamen

Modul-ID
module_id string

Modul-ID

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

StatusResponseWithoutFlow

Name Pfad Typ Beschreibung
Status-ID
id string

Status-ID

Statusname
name string

Statusname

Statusreihenfolge
position integer

Statusreihenfolge

Statusfarbe
color string

Statusfarbe

Status ist Standard
is_default boolean

Status ist Standard

Status ist aktiviert
enabled boolean

Status ist aktiviert

Statusnamen
names array of LocalizedLabel

Statusnamen

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach

StatusResponseWithoutLanguage

Name Pfad Typ Beschreibung
Status-ID
id string

Status-ID

Statusname
name string

Statusname

Statusreihenfolge
position integer

Statusreihenfolge

Statusfarbe
color string

Statusfarbe

Status ist aktiviert
enabled boolean

Status ist aktiviert

TimeZones

Name Pfad Typ Beschreibung
Zeitzonen-ID
id string

Zeitzonen-ID

Zeitzonenname
display_name string

Zeitzonenname

Standardname der Zeitzone
standard_name string

Standardname der Zeitzone

UTC-Offset der Zeitzone
utc_offset string

UTC-Offset der Zeitzone

UploadChunkInit

Name Pfad Typ Beschreibung
Uploadablaufverzögerung
expires_after_secs double

Uploadablaufverzögerung

Block-ID
chunk_id string

Block-ID

Medien-ID
media_id string

Medien-ID

Minimale Blockgröße
min_chunk_size integer

Minimale Blockgröße

Arbeitsbereich

Name Pfad Typ Beschreibung
Arbeitsbereichs-ID
workspace_id string

Arbeitsbereichs-ID

Arbeitsbereichname
name string

Arbeitsbereichname

Übergeordnete Arbeitsbereichs-ID
parent_id string

Übergeordnete Arbeitsbereichs-ID

Arbeitsbereichsreferenz
client_reference string

Arbeitsbereichsreferenz

media_resource
media_resource Media
Löschdatum des Arbeitsbereichs
deleted_by string

Löschdatum des Arbeitsbereichs

Arbeitsbereich gelöscht von
deleted_at string

Arbeitsbereich gelöscht von

Erstellungsdatum.
created_at string

Erstellungsdatum.

Erstellt von
created_by string

Erstellt von

Aktualisierungsdatum
updated_at string

Aktualisierungsdatum

Aktualisiert von
updated_by string

Aktualisieren nach