API / MCP-Server

Ihre Daten. Mehr Möglichkeiten.

Verbinden Sie die Ressourcenplanung mit Ihren Systemen und KI-Werkzeugen. Rufen Sie Informationen ab, erstellen Sie eigene Übersichten und führen Sie unterstützte Aktionen mit geregeltem Zugriff aus.

Für Ihre Systeme

REST API

Rufen Sie strukturierte JSON-Daten für Berichte, Integrationen und eigene Abläufe ab. Unterstützte Schreiboperationen können Informationen in RessursAgent erstellen und aktualisieren.

  • Berichte und Übersichten erstellen
  • Projekt- und Ressourcendaten zwischen Systemen verbinden
  • Unterstützte Aufgaben automatisieren
Für Ihre KI-Werkzeuge

MCP-Server

Mit dem Model Context Protocol kann ein kompatibler KI-Client RessursAgent als Werkzeug nutzen. Fragen Sie nach Daten Ihrer Organisation und fordern Sie unterstützte Aktionen mit Ihrem Konto und Ihren Rechten an.

  • Fragen zum Plan in eigenen Worten stellen
  • Kapazität, Bedarf und Qualifikationen zusammenführen
  • Änderungen im Rahmen Ihrer Rechte anfordern

Objekte, Felder und Aktionen.

Erfahren Sie, was Ihre Systeme und KI-Werkzeuge in RessursAgent lesen, erstellen und ändern können. Die Übersicht zeigt zentrale Objekte und ausgewählte Felder, die REST API und MCP unterstützen.

Die Feldnamen entsprechen den tatsächlichen Namen im Datenmodell. Schreibfelder gelten für das Erstellen, Aktualisieren oder eine eigene Aktion; nicht alle lassen sich nach dem Erstellen ändern. Projekte und Ressourcen werden normalerweise über eine ID verknüpft.

Ressourcen und Projekte

Personal, Maschinen, Kontaktdaten, Positionen, Fachbereiche, Projektzeiträume, Kunden und Standorte.

Ressourcen: Personal und Geräte

  • Lesen
  • Erstellen
  • Ändern

Lesbare Felder

  • name
  • resource_type
  • ownership
  • is_active
  • discipline
  • position
  • department
  • email
  • phone
  • equipment_type
  • equipment_model
  • supplier
  • work_base_address
  • external_id

Schreibbare Felder

  • name
  • resource_type
  • ownership
  • is_active
  • discipline
  • position
  • department
  • email
  • phone
  • equipment_type
  • equipment_model
  • supplier
  • employed_from
  • employed_until
  • work_base_address
  • external_id
  • note

Projekte

  • Lesen
  • Erstellen
  • Ändern

Lesbare Felder

  • name
  • project_number
  • status
  • start_date
  • end_date
  • customer_name
  • location_address
  • project_type
  • is_template

Schreibbare Felder

  • name
  • project_number
  • status
  • start_date
  • end_date
  • customer_name
  • location_address
  • location_postal_code
  • external_id
  • worklist_code
  • note
  • project_type
  • is_template

HMS-Karten

  • Lesen
  • Ändern
  • Entfernen

Lesbare Felder

  • resource_id
  • card_id
  • expires_at

Schreibbare Felder

  • card_number
  • expires_at

Die Kartennummer wird nicht zurückgegeben. Die Registrierung erfordert einen angemeldeten Benutzer mit besonderer HMS-Berechtigung. Das Ablaufdatum lässt sich separat verlängern.

Plan, Bedarf und Kapazität

Zuweisungen, Auslastung, Ressourcenbedarf, Nichtverfügbarkeit und berechnete Kapazität je Ressource und Tag.

Zuweisungen

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • project_id
  • resource_id
  • start_date
  • end_date
  • allocation_percent
  • activity_id
  • project_position
  • work_schedule_template_id

Schreibbare Felder

  • project_id
  • resource_id
  • start_date
  • end_date
  • allocation_percent
  • work_schedule_template_id
  • work_schedule_anchor_date

Ressourcenbedarf

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • project_id
  • resource_type
  • status
  • quantity
  • start_date
  • end_date
  • allocation_percent
  • position
  • equipment_model
  • activity_id

Schreibbare Felder

  • project_id
  • resource_type
  • quantity
  • start_date
  • end_date
  • allocation_percent
  • discipline
  • position
  • equipment_type
  • equipment_model
  • work_schedule_template_id

Bedarfe können über eigene Aktionen auch eingereicht, abgelehnt, storniert und erfüllt werden.

Abwesenheiten und Nichtverfügbarkeit

  • Lesen
  • Erstellen
  • Entfernen

Lesbare Felder

  • resource_id
  • start_date
  • end_date
  • reason
  • unavailable_percent

Schreibbare Felder

  • resource_id
  • start_date
  • end_date
  • reason
  • unavailable_percent

Berechnete Kapazität

  • Lesen

Lesbare Felder

  • resource_id
  • capacity_date
  • scheduled_hours
  • scheduled_capacity_percent
  • unavailable_percent
  • effective_capacity_percent

Nur lesen

Dies sind berechnete Ergebnisse zum Lesen. Sie beeinflussen sie durch Änderungen an Grundlagen wie Zuweisungen, Zeiträumen, Standorten und Qualifikationen.

Qualifikationen und Schichten

Qualifikationskatalog, erfasste Qualifikationen und Gültigkeit, Projektanforderungen, Schichtvorlagen und Tagesausnahmen.

Qualifikationskatalog

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name
  • code
  • category
  • description
  • requires_expiry
  • source_system

Schreibbare Felder

  • name
  • code
  • category
  • description
  • is_hms_card
  • requires_expiry

Qualifikationen einer Ressource

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • resource_id
  • competency_id
  • level
  • valid_from
  • valid_until
  • documentation_status
  • source_system

Schreibbare Felder

  • resource_id
  • competency_id
  • level
  • valid_from
  • valid_until
  • certificate_number
  • comment
  • documentation_confirmed

Qualifikationen eines externen Quellsystems müssen dort aktualisiert werden. Zertifikatsnummern und Kommentare können erfasst werden, werden in diesem Leseobjekt aber nicht zurückgegeben.

Qualifikationsanforderungen

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • scope
  • entity_id
  • competency_id
  • is_mandatory
  • resource_type
  • valid_from

Schreibbare Felder

  • scope
  • entity_id
  • competency_id
  • is_mandatory
  • resource_type
  • valid_from
  • comment

Schichtvorlagen

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name
  • workday_pattern
  • hours_pattern
  • standard_hours_per_workday
  • start_weekday
  • project_scope
  • is_active
  • is_night_shift

Schreibbare Felder

  • name
  • description
  • workday_pattern
  • hours_pattern
  • standard_hours_per_workday
  • start_weekday
  • project_scope
  • project_ids
  • is_active
  • is_night_shift

Tagesausnahmen

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • resource_id
  • exception_date
  • exception_type
  • planned_hours

Schreibbare Felder

  • resource_id
  • exception_date
  • exception_type
  • planned_hours
  • comment

Kurspläne

  • Lesen
  • Ändern

Lesbare Felder

  • competency_id
  • plans

Schreibbare Felder

  • resource_ids
  • planned_on
Teams, Zusammenarbeit und Analysen

Planungsteams, Projektteams und Mitglieder, Aktivitäten und Projektrollen. REST API und MCP liefern auch geografische Cluster, Zusammenarbeitspaare und berechnete Tauschvorschläge.

Planungsteams

  • Lesen
  • Erstellen
  • Ändern

Lesbare Felder

  • name
  • leader_resource_id
  • end_date
  • archived_at

Schreibbare Felder

  • name
  • leader_resource_id
  • end_date
  • competency_ids

Projektteams

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • project_id
  • name
  • note
  • work_schedule_template_id
  • planned_start_date
  • planned_end_date

Schreibbare Felder

  • project_id
  • name
  • note
  • work_schedule_template_id
  • planned_start_date
  • planned_end_date

Teammitglieder

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • project_team_id
  • resource_id
  • is_lead

Schreibbare Felder

  • project_team_id
  • resource_id
  • is_lead

Projektaktivitäten

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • project_id
  • name
  • code
  • parent_id
  • sort_order
  • lead_resource_id
  • planned_start_date
  • planned_end_date

Schreibbare Felder

  • project_id
  • name
  • description
  • code
  • note
  • lead_resource_id
  • planned_start_date
  • planned_end_date
  • parent_id
  • position

Projektrollen

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • project_id
  • resource_id
  • role
  • responsibility
  • effective_from
  • effective_until

Schreibbare Felder

  • project_id
  • resource_id
  • role
  • responsibility
  • effective_from
  • effective_until

Verknüpfte Ressourcen

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name
  • project_id
  • start_date
  • end_date
  • note
  • members

Schreibbare Felder

  • name
  • project_id
  • start_date
  • end_date
  • note
  • members

Geografische Cluster

  • Lesen

Lesbare Felder

  • axis
  • radius_km
  • resource_category
  • project_count
  • resource_count
  • span_km
  • projects
  • members

Nur lesen

Dies sind berechnete Ergebnisse zum Lesen. Sie beeinflussen sie durch Änderungen an Grundlagen wie Zuweisungen, Zeiträumen, Standorten und Qualifikationen.

Zusammenarbeitsbeziehungen

  • Lesen

Lesbare Felder

  • resource_id
  • partner_id
  • strength
  • overlap_days
  • shared_project_count
  • has_operator_link
  • has_shared_project_team

Nur lesen

Dies sind berechnete Ergebnisse zum Lesen. Sie beeinflussen sie durch Änderungen an Grundlagen wie Zuweisungen, Zeiträumen, Standorten und Qualifikationen.

Optimierungsvorschläge

  • Lesen

Lesbare Felder

  • type
  • score
  • start_date
  • end_date
  • project_ids
  • incoming_resource_ids
  • outgoing_resource_ids
  • travel_saving_km
  • own_production_gain
  • manual_planning_required

Nur lesen

Dies sind berechnete Ergebnisse zum Lesen. Sie beeinflussen sie durch Änderungen an Grundlagen wie Zuweisungen, Zeiträumen, Standorten und Qualifikationen.

Angebote und Register

Angebote mit Status, Wahrscheinlichkeit und Bedarf. Tags, Positionen, Fachgebiete, Maschinentypen und -modelle, Lieferanten und Maschinenstandorte.

Angebote und Simulation

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name
  • customer_name
  • status
  • win_probability
  • start_date
  • end_date
  • estimated_value
  • currency_code
  • simulation_inclusion

Schreibbare Felder

  • name
  • customer_name
  • status
  • win_probability
  • start_date
  • end_date
  • estimated_value
  • currency_code
  • requirements
  • simulation_inclusion

Angebotsbedarfe enthalten Kategorie, Katalogreferenz, Menge und Zeitraum (category, catalog_item_id, quantity, start_date, end_date). Status und Teilnahme an Simulationen werden über eigene Aktionen geändert.

Schlüsselpersonen im Angebot

  • Lesen
  • Erstellen
  • Entfernen

Lesbare Felder

  • bid_opportunity_id
  • resource_id
  • responsibility

Schreibbare Felder

  • bid_opportunity_id
  • resource_id
  • responsibility

Tags

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name

Schreibbare Felder

  • name

Tags lassen sich auch mit Projekten, Ressourcen und Ressourcenbedarfen verknüpfen oder daraus entfernen.

Positionen, Fachbereiche, Gerätetypen, Gerätemodelle und Lieferanten

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name

Schreibbare Felder

  • name

Gerätestandorte

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • name
  • postal_code

Schreibbare Felder

  • name
  • postal_code

Mietsätze für Positionen und Gerätemodelle

  • Lesen
  • Ändern

Lesbare Felder

  • kind
  • hire_day_rate
  • hire_currency_code

Schreibbare Felder

  • hire_day_rate
  • hire_currency_code
Benachrichtigungen und Verlauf

Benachrichtigungen, Ereignisse, Kommentare und ein begrenzter Auszug aus dem Änderungsprotokoll. Zugriff auf die jeweiligen Datenbereiche ist erforderlich.

Benachrichtigungen

  • Lesen

Lesbare Felder

  • notification_event_id
  • recipient_resource_id
  • status
  • read_at
  • dismissed_at
  • scheduled_for

Nur lesen

Benachrichtigungsereignisse

  • Lesen

Lesbare Felder

  • event_type
  • entity_type
  • entity_id
  • project_id
  • severity
  • title
  • message
  • occurred_at

Nur lesen

Änderungsprotokoll

  • Lesen

Lesbare Felder

  • entity_type
  • entity_id
  • action
  • message
  • actor_display_name
  • source
  • created_at

Nur lesen

Kommentare

  • Lesen
  • Erstellen
  • Ändern
  • Entfernen

Lesbare Felder

  • entity_type
  • entity_id
  • comment
  • applies_from
  • applies_until
  • version

Schreibbare Felder

  • entity_type
  • entity_id
  • comment
  • applies_from
  • applies_until
  • expected_version
Ihre eigenen Informationen

Profil-Nutzer können ihren eigenen Plan, ihre Kompetenzen und Änderungen über einen persönlichen API/MCP-Zugang abrufen. Die Verbindung folgt den Rechten des angemeldeten Nutzers und erfordert eine verknüpfte Personenressource.

Eigenes Profil

  • Lesen

Lesbare Felder

  • name
  • discipline
  • position
  • phone
  • email
  • supplier
  • employed_from

Nur lesen

Liest die eigenen Daten der angemeldeten Person und erfordert eine Verknüpfung mit einer Personalressource.

Eigener Plan

  • Lesen

Lesbare Felder

  • projectName
  • startDate
  • endDate
  • activityName
  • projectPosition
  • meetingPoint
  • managerName
  • managerPhone
  • allocationPercent
  • machineNames
  • schedule

Nur lesen

Liest die eigenen Daten der angemeldeten Person und erfordert eine Verknüpfung mit einer Personalressource.

Eigene Qualifikationen

  • Lesen

Lesbare Felder

  • register
  • gaps
  • met
  • competencyName
  • status
  • level
  • validFrom
  • validUntil

Nur lesen

Liest die eigenen Daten der angemeldeten Person und erfordert eine Verknüpfung mit einer Personalressource.

Eigene Änderungen

  • Lesen

Lesbare Felder

  • resource_id
  • changes

Nur lesen

Liest die eigenen Daten der angemeldeten Person und erfordert eine Verknüpfung mit einer Personalressource.

Aus Informationen wird praktischer Nutzen.

Beispiele / Arbeitsabläufe mit API

  1. Ressourcenregister aktuell halten

    Erstellen Sie Personal oder Geräte und aktualisieren Sie Kontaktdaten, Abteilung, Fachbereich und externe Referenzen.

  2. Projektdaten mit der Planung verbinden

    Aktualisieren Sie Projektzeiträume und Kundendaten. Erstellen Sie Bedarfe und ändern Sie Zuweisungsdaten, Auslastung und Schichtvorlagen.

  3. Eigene Berichte erstellen

    Kombinieren Sie Kapazität, Qualifikationen, Cluster und Angebote in eigenen Berichten. Nutzen Sie berechnete Ergebnisse als Entscheidungsgrundlage.

Beispiele / Fragen an einen KI-Client

  • Welche Ressourcenanfragen sind nächste Woche offen?

  • Zeige die Kapazität der nächsten Woche und finde Ressourcen mit gültiger Maschinenführerqualifikation.

  • Erstelle einen Ressourcenbedarf für das Projekt mit der vereinbarten Position, dem Zeitraum und der Zuweisung.

Die Beispiele zeigen mögliche Anwendungen, keine ausgeführten Aktionen. Ergebnisse hängen von erfassten Daten, Client und Zugriffsrechten ab. Prüfen Sie vorgeschlagene Änderungen, bevor Sie deren Ausführung anfordern.

Zugriff passend zur Aufgabe.

Berechtigungen folgen den Daten

Lesen und Ändern hängen von Organisation, Benutzerrolle und erteilten Rechten ab. Verfügbare Aktionen hängen auch vom Objektstatus und den Validierungsregeln der Anwendung ab.

Grundlagen der Auswertungen ändern

Kapazität, Cluster und Optimierungsvorschläge werden aus erfassten Daten berechnet. Ergebnisse werden nicht direkt geschrieben.

Historie und persönliche Ansicht

Benachrichtigungen und Protokollereignisse lassen sich lesen. Kommentare sind eigene bearbeitbare Objekte. Meine Seite zeigt die Daten der jeweiligen Person.

Was möchten Sie verbinden?

Beschreiben Sie die benötigten Daten und Abläufe. Wir helfen Ihnen, Zugriff, Verbindung und unterstützte Aktionen zu klären.

Über API und MCP sprechen