Sepolo

Entwickeln mit Sepolo. Offen ab der ersten Anfrage.

Erkunden Sie Authentifizierung, Endpoints und Datenverträge ohne Anmeldung. Verbinden Sie Ihre Systeme über organisationsbezogene API-Anfragen mit Sepolo. Mit Datenverträgen für Kunden-, Lieferanten- und Serviceartikelabfragen.

Ohne Konto lesen, erkunden und herunterladen. API-Aufrufe verwenden den Schlüssel und die Berechtigungen Ihrer Organisation.

OpenAPI-Definition herunterladenPostman-Collection herunterladen

Ihre Serviceebene. Mit oder ohne ERP.

Ein gemeinsamer Ort für Einsatzplanung, Technikerunterstützung und Anlagenkosten. Verbinden Sie Sepolo mit Ihrem Finanzsystem oder starten Sie mit eigenen Servicedaten.

Das ERP bleibt Ihr finanzielles Zentrum.

Nutzen Sie Sepolo für Serviceplanung, mobile Berichte, Ersatzteile, Zeit und vernetzte Anlagen. Übernehmen Sie Stammdaten über die konfigurierte ERP-Integration und bereiten Sie die finanzielle Übergabe über unterstützte Anbieterabläufe vor. Vereinbaren Sie Operationen und Zuordnungen vor der Einführung.

Mit Service starten. Bei Bedarf Systeme anbinden.

Betreiben Sie Service mit lokalen Kunden-, Anlagen- und Artikeldaten im Onlineportal und in der mobilen App. Eine ERP-Anbindung ist optional. Sepolo verwaltet Serviceleistungen und Betriebskosten; es ersetzt kein vollständiges Buchhaltungs- oder ERP-System.

Die passende ERP-Anbindung wählen

Microsoft Dynamics 365 Business Central
Für Dynamics 365 Business Central gibt es eine Anbieterimplementierung für Stammdatensynchronisierung und unterstützte Finanzabläufe. Prüfen Sie Mandantenverbindung, Berechtigungen, Artikelzuordnungen und benötigte Übergaben mit Ihrem Implementierungsteam.
SAP
Planen Sie SAP als klar abgegrenztes Integrationsprojekt. Der aktuelle SAP-Artikelclient ist ein Prototyp; die automatische finanzielle Übergabe an SAP kann noch nicht als Standardanbindung zugesagt werden. Vereinbaren Sie zuerst SAP-Schnittstellen, Implementierung und Abnahmetests.
e-conomic · Dinero · Uniconta · AutoCount · SQL Account
Weitere Anbieterimplementierungen umfassen e-conomic, Dinero, Uniconta, AutoCount und SQL Account. Unterstützte Operationen und Einrichtung unterscheiden sich. Vorhandener Quellcode belegt keine bereitgestellte oder zertifizierte Kundenintegration.

Datenverantwortung festlegen

Mit ERP verbleiben vereinbarte Kunden-, Lieferanten-, Artikel- und Finanzstammdaten dort. Sepolo verbindet sie mit Anlagen, Einsätzen, Berichten, Ersatzteilen und Zeit. Die Lese-APIs greifen auf Sepolo-Daten Ihrer Organisation zu; die Aktualität folgt der konfigurierten Synchronisierung, nicht einer Live-ERP-Abfrage bei jedem Aufruf.

Den Inhalt der Lese-APIs verstehen

Kunden- und Ersatzteilabfragen sind schreibgeschützt. Ersatzteile stammen aus dem physischen Servicekatalog der Organisation: lokale und zugeordnete ERP-Artikel gemäß Lager- und Positionsregeln, statt des gesamten ERP-Artikelcaches. Reine Dienstleistungen sind ausgeschlossen. Die Katalogmenge garantiert keinen aktuellen ERP-Lagerbestand. Diese Endpoints erstellen keine ERP-Kunden oder Artikel und buchen keine Rechnungen; klären Sie die Währung der Katalogpreise bei der Einrichtung.

Verwenden Sie externalSystem zusammen mit externalCustomerId als Quellidentität. customerNumber entspricht derzeit externalCustomerId und ist keine separat ermittelte ERP-Kontonummer. updatedAtUtc kann null sein. Gleichen Sie über stabile IDs ab: die Seitennavigation über laufende Daten ist weder Transaktionssnapshot noch Änderungsfeed.

Einen vollständigen Serviceablauf erproben

Vereinbaren Sie Datenverantwortung, ERP-Version, Zugangsdaten und erforderliche Operationen. Prüfen Sie den Schlüssel mit /api/v1/me, lesen Sie Lieferanten, Kunden und zulässige Ersatzteile und testen Sie den ausgewählten Service-zu-Finanzen-Ablauf in Ihrer Umgebung. Bewahren Sie API-Schlüssel auf vertrauenswürdigen Servern auf.

Ihre erste Anfrage

Verwenden Sie die Basis-URL Ihrer Sepolo-Umgebung. Das folgende Beispiel prüft Schlüssel, Organisation, Client-Identität und verfügbare Scopes.

curl "https://app.sepolo.app/api/v1/me" -H "X-Sepolo-Api-Key: YOUR_API_KEY"

Authentifizierung und Zugriff

Senden Sie bei jeder Anfrage X-Sepolo-Api-Key: YOUR_API_KEY oder verwenden Sie Authorization: Bearer YOUR_API_KEY. Der Schlüssel bestimmt die Organisation und gewährt keinen Zugriff auf andere Organisationen. Bewahren Sie Schlüssel auf dem Server oder in einem Secret Store auf, niemals im öffentlichen Frontend-Code.

Jede Operation nennt den erforderlichen Scope. Impact Mapping erfordert zusätzlich die Impact-Mapping-Lizenz der Organisation. API-Zugriff erhalten Sie über Ihren Organisationsadministrator.

Anfragen, Zeiträume und Seitennavigation

Verwenden Sie UTC-Zeitstempel im ISO-8601-Format für Datumsfilter. Telemetrie und PointGuard-Zykluslisten erfordern from/to (oder fromUtc/toUtc) mit höchstens 31 Tagen pro Anfrage. Bewegungszeiträume erlauben bis zu 366 Tage. Kalendertermine und Serviceeinsätze nutzen ohne Datumsangaben standardmäßig 60 Tage, maximal 366 Tage.

Wo pageSize und cursor unterstützt werden, verwenden Sie nextCursor für die nächste Seite und beenden bei hasMore = false. Die Seitengröße ist auf 500 begrenzt. Einige Listen liefern eine Datenseite ohne cursor-Parameter; prüfen Sie die jeweilige Operation. Verwenden Sie Cursor unverändert.

Endpoint-Referenz

Erkunden Sie die implementierten v1-Operationen. Öffnen Sie eine Operation für Parameter, Berechtigungen und Anfragefelder. Die Verfügbarkeit in Ihrer Umgebung hängt von der bereitgestellten Version und Konfiguration ab.

Identität

Prüfen Sie die zum Schlüssel gehörende Organisation und die Scopes.

GET/api/v1/me

Erforderlicher Scope Gültiger Organisations-API-Schlüssel

Erfolgreiche Antwort 200 PublicApiMeResponse

Antwortfelder

  • organizationId · Guid
  • clientId · string
  • clientName · string
  • scopes · IReadOnlyList<string>
  • version · string
  • rateLimit · PublicApiRateLimitDto
  • allowedGroupIds · IReadOnlyList<int>
  • allowedCustomerIds · IReadOnlyList<string>

Lieferanten

Lesen Sie lokale Lieferanten und externe ERP-Lieferanten der Organisation.

GET/api/v1/vendors

Erforderlicher Scope vendors.read

Erfolgreiche Antwort 200 PublicApiPage<PublicApiVendorDto>

Antwortfelder

  • vendorId · Guid
  • name · string
  • contactName · string
  • contactEmail · string
  • contactPhone · string
  • city · string
  • country · string
  • isExternal · bool
  • externalSystem · string
  • externalVendorNumber · string
  • createdOn · DateTime
  • modifiedOn · DateTime
  • status · bool

Kunden

Lesen Sie lokale und synchronisierte Kundenverzeichniseinträge der zum Schlüssel gehörenden Organisation. Filtern Sie nach externalSystem und durchlaufen Sie die Ergebnisse seitenweise.

GET/api/v1/customers

Erforderlicher Scope customers.read

Parameter

  • externalSystem · Abfrage · string?
  • pageSize · Abfrage · int · Standard 100
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiCustomerDto>

Antwortfelder

  • customerDirectoryId · Guid?
  • externalSystem · string
  • externalCustomerId · string
  • customerNumber · string
  • name · string
  • email · string
  • phone · string
  • city · string
  • country · string
  • updatedAtUtc · DateTime?

Artikel und Ersatzteile

Lesen Sie zulässige physische Serviceartikel aus dem lokalen Katalog und zugeordneten ERP-Artikeln mit Artikelkennungen, Lieferant, Katalogmenge, Preisen und ERP-Referenzen. Filtern Sie nach vendorId und status.

GET/api/v1/inventory/parts

Erforderlicher Scope inventory.read

Parameter

  • vendorId · Abfrage · Guid?
  • status · Abfrage · string?
  • pageSize · Abfrage · int · Standard 100
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiInventoryPartDto>

Antwortfelder

  • partId · Guid
  • partName · string
  • partNumber · string
  • itemNo · string
  • vendorName · string
  • quantity · int
  • costPrice · decimal
  • salesPrice · decimal
  • status · bool
  • externalSystem · string
  • externalPartId · string
  • isErpManaged · bool

Kalendertermine

Lesen Sie Kalendertermine, optional nach Benutzer gefiltert.

GET/api/v1/appointments

Erforderlicher Scope appointments.read

Parameter

  • fromUtc · Abfrage · DateTime?
  • toUtc · Abfrage · DateTime?
  • userId · Abfrage · Guid?

Erfolgreiche Antwort 200 PublicApiPage<PublicApiAppointmentDto>

Antwortfelder

  • appointmentId · Guid
  • userId · Guid
  • subject · string
  • description · string
  • location · string
  • startTimeUtc · DateTime
  • endTimeUtc · DateTime
  • isAllDay · bool
  • calendarId · int
  • timezoneKey · string
  • recurrenceRule · string
  • recurrenceId · Guid?
  • recurrenceException · string
  • createdUtc · DateTime
  • updatedUtc · DateTime

Serviceeinsätze

Lesen Sie geplante Arbeit, Status, Anlagenkontext und verfügbare Vereinbarungsfelder.

GET/api/v1/service-visits

Erforderlicher Scope service_visits.read

Parameter

  • fromUtc · Abfrage · DateTime?
  • toUtc · Abfrage · DateTime?

Erfolgreiche Antwort 200 PublicApiPage<PublicApiServiceVisitDto>

Antwortfelder

  • serviceVisitId · Guid
  • title · string
  • type · Guid
  • typeText · string
  • state · int
  • stateText · string
  • startDate · DateTime?
  • endDate · DateTime?
  • startTime · TimeSpan?
  • endTime · TimeSpan?
  • assetId · Guid
  • externalSystem · string
  • externalCustomerId · string
  • estimatedCost · decimal?
  • actualCost · decimal?
  • slaServiceContractId · Guid?
  • slaResponseMinutes · int?
  • slaDueAt · DateTime?
  • maintenanceContractId · Guid?
  • maintenanceContractAssetId · Guid?

Vereinbarungen

Lesen Sie SLA-, Vor-Ort-Service- und Remote-Support-Vereinbarungen und deren Abdeckung.

GET/api/v1/agreements

Erforderlicher Scope agreements.read

Parameter

  • type · Abfrage · string?
  • customerId · Abfrage · string?
  • status · Abfrage · string?
  • pageSize · Abfrage · int · Standard 100
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiAgreementDto>

Antwortfelder

  • agreementId · Guid
  • agreementType · string
  • agreementKind · string
  • agreementNumber · string
  • name · string
  • status · string
  • customerDirectoryId · Guid?
  • externalSystem · string
  • externalCustomerId · string
  • customerName · string
  • startDate · DateTime
  • endDate · DateTime?
  • contractAmount · decimal
  • includesLabor · bool
  • includesTravel · bool
  • includesRemoteSupport · bool
  • partsCoverage · string
  • partsCoverageLimitText · string
  • serviceDeliveryManagerName · string
  • serviceDeliveryManagerEmail · string
  • proposedAt · DateTime?
  • followUpAt · DateTime?
  • wonAt · DateTime?
  • lostAt · DateTime?
  • createdUtc · DateTime
  • updatedUtc · DateTime?
GET/api/v1/agreements/{agreementId}

Erforderlicher Scope agreements.read

Parameter

  • agreementId · Pfad · Guid

Erfolgreiche Antwort 200 PublicApiAgreementDetailDto

Antwortfelder

  • agreement · PublicApiAgreementDto
  • sla · PublicApiSlaTermsDto?
  • coverage · IReadOnlyList<PublicApiAgreementCoverageDto>
  • assets · IReadOnlyList<PublicApiAgreementAssetDto>
  • resources · IReadOnlyList<PublicApiAgreementResourceDto>
  • supportHourBuckets · IReadOnlyList<PublicApiAgreementSupportBucketDto>

Remote-Support

Lesen Sie Supportfälle, SLA-Kontext und erfassten Zeitverbrauch.

GET/api/v1/remote-support-cases

Erforderlicher Scope remote_support.read

Parameter

  • status · Abfrage · string?
  • assetId · Abfrage · Guid?
  • slaOnly · Abfrage · bool?
  • customer · Abfrage · string?
  • pageSize · Abfrage · int · Standard 100
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiRemoteSupportCaseDto>

Antwortfelder

  • serviceReportId · Guid
  • serviceVisitId · Guid
  • assetId · Guid
  • caseNumber · string
  • reportNumber · string
  • title · string
  • reasonForService · string
  • customerName · string
  • assetName · string
  • state · int
  • stateText · string
  • createdAt · DateTime
  • plannedStart · DateTime?
  • actualStartOfInspection · DateTime?
  • actualEndOfInspection · DateTime?
  • hasActiveTimer · bool
  • activeTimerStartedAt · DateTime?
  • remoteWorkMinutes · int?
  • closedRemoteWorkMinutes · int?
  • timeEntryCount · int
  • remoteSupporters · string
  • remoteSupporterCount · int
  • lastRemoteSupporter · string
  • hasEscalation · bool
  • escalationLevel · string
  • hasSlaAgreement · bool
  • slaAgreementNumber · string
  • slaAgreementName · string
  • slaCoverageScope · string
  • slaResponseHours · int?
  • slaDueAt · DateTime?
  • slaMinutesRemaining · int?
GET/api/v1/remote-support-cases/{serviceReportId}

Erforderlicher Scope remote_support.read

Parameter

  • serviceReportId · Pfad · Guid

Erfolgreiche Antwort 200 PublicApiRemoteSupportCaseDetailDto

Antwortfelder

  • case · PublicApiRemoteSupportCaseDto
  • description · string
  • problemSummary · string
  • solution · string
  • customerEmail · string
  • customerPhone · string
  • customerAddress · string
  • primaryContactName · string
  • primaryContactJobTitle · string
  • primaryContactEmail · string
  • primaryContactPhone · string
  • timeEntries · IReadOnlyList<PublicApiRemoteSupportTimeEntryDto>

Geräte und Telemetrie

Lesen Sie Geräte, Telemetrie, Bewegungen, PointGuard-Zyklen und Messwerte.

GET/api/v1/devices

Erforderlicher Scope devices.read

Parameter

  • updatedSince · Abfrage · DateTime?
  • groupId · Abfrage · int?
  • status · Abfrage · string?
  • pageSize · Abfrage · int · Standard 100
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiDeviceDto>

Antwortfelder

  • deviceId · string
  • deviceName · string
  • deviceType · int
  • organizationId · Guid
  • groupId · int
  • deviceLocation · string
  • description · string
  • deviceStatus · int
  • modelId · Guid
  • modelName · string
  • equipmentType · string
  • calculatedNextService · DateTime
  • latitude · double
  • longitude · double
  • lastTelemetryAt · DateTime?
  • temperature · double?
  • humidity · double?
  • batteryVoltage · double?
  • batteryPercentage · double?
GET/api/v1/devices/{deviceId}

Erforderlicher Scope devices.read

Parameter

  • deviceId · Pfad · string

Erfolgreiche Antwort 200 PublicApiDeviceDto

Antwortfelder

  • deviceId · string
  • deviceName · string
  • deviceType · int
  • organizationId · Guid
  • groupId · int
  • deviceLocation · string
  • description · string
  • deviceStatus · int
  • modelId · Guid
  • modelName · string
  • equipmentType · string
  • calculatedNextService · DateTime
  • latitude · double
  • longitude · double
  • lastTelemetryAt · DateTime?
  • temperature · double?
  • humidity · double?
  • batteryVoltage · double?
  • batteryPercentage · double?
GET/api/v1/devices/{deviceId}/telemetry

Erforderlicher Scope telemetry.read

Parameter

  • deviceId · Pfad · string
  • from · Abfrage · DateTime?
  • to · Abfrage · DateTime?
  • fromUtc · Abfrage · DateTime?
  • toUtc · Abfrage · DateTime?
  • metrics · Abfrage · string?
  • telemetryType · Abfrage · int?
  • cycleId · Abfrage · string?
  • pageSize · Abfrage · int · Standard 500
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiTelemetryDto>

Antwortfelder

  • deviceId · string
  • stamp · DateTime
  • latitude · decimal
  • longitude · decimal
  • temperature · double
  • humidity · double
  • batteryVoltage · double
  • batteryCurrent · double
  • batteryPercentage · double
  • current · double
  • signalQuality · double
  • railTemperature · double
  • tiltX · double
  • tiltY · double
  • tiltZ · double
  • description · string
  • telemetryType · int?
  • cycleId · string
  • cycleSampleIndex · int?
  • cycleSampleOffsetMs · int?
  • cycleDurationMs · int?
  • cycleSampleCount · int?
  • schemaVersion · string
  • pressure1Bar · double?
  • pressure2Bar · double?
  • endStop1 · bool?
  • endStop2 · bool?
GET/api/v1/devices/{deviceId}/movements

Erforderlicher Scope movements.read

Parameter

  • deviceId · Pfad · string
  • from · Abfrage · DateTime?
  • to · Abfrage · DateTime?
  • fromUtc · Abfrage · DateTime?
  • toUtc · Abfrage · DateTime?
  • minDurationSeconds · Abfrage · int · Standard 0
  • pageSize · Abfrage · int · Standard 500
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiMovementDto>

Antwortfelder

  • id · Guid
  • deviceId · string
  • location · string
  • start · DateTime
  • stop · DateTime
  • duration · double
  • startCurrent · double
  • stopCurrent · double
  • averageCurrent · double
  • peakCurrent · double
  • cycleCount · int
  • isAnomalySuggested · bool
  • anomalyScore · double?
  • anomalyReason · string
  • modelVersion · string
  • baselineMean · double?
  • baselineStd · double?
  • anomalyDecisionLabel · string
  • anomalyDecisionAction · string
  • anomalyDecisionConfidence · decimal?
  • anomalyDecisionReason · string
  • anomalyPatternId · Guid?
  • estimatedNextService · DateTime?
  • currentSignature · PublicApiMovementSignatureDto?
GET/api/v1/devices/{deviceId}/movements/{movementId}/signature

Erforderlicher Scope movements.read

Parameter

  • deviceId · Pfad · string
  • movementId · Pfad · Guid

Erfolgreiche Antwort 200 PublicApiMovementSignatureDto

Antwortfelder

  • movementId · Guid
  • deviceId · string
  • start · DateTime
  • stop · DateTime
  • sampleCount · int?
  • medianSampleIntervalMs · double?
  • averageCurrent · double?
  • peakCurrent · double?
  • currentAreaAmpSeconds · double?
  • currentRms · double?
  • currentStdDev · double?
  • startupSlopeAmpPerSecond · double?
  • earlyMeanCurrent · double?
  • plateauMeanCurrent · double?
  • endMeanCurrent · double?
  • observedDurationSeconds · double?
  • highLoadDurationSeconds · double?
  • peakHoldDurationSeconds · double?
  • lowLoadTailDurationSeconds · double?
  • rampDownSlopeAmpPerSecond · double?
  • currentP10 · double?
  • currentP50 · double?
  • currentP90 · double?
  • clippedSampleRatio · double?
  • shapeJson · string
GET/api/v1/devices/{deviceId}/pointguard/cycles

Erforderlicher Scope telemetry.read

Parameter

  • deviceId · Pfad · string
  • from · Abfrage · DateTime?
  • to · Abfrage · DateTime?
  • fromUtc · Abfrage · DateTime?
  • toUtc · Abfrage · DateTime?
  • pageSize · Abfrage · int · Standard 500
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiPointGuardCycleDto>

Antwortfelder

  • deviceId · string
  • cycleId · string
  • start · DateTime
  • stop · DateTime
  • samples · int
  • cycleDurationMs · int?
  • cycleSampleCount · int?
  • averageCurrent · double?
  • peakCurrent · double?
  • minCurrent · double?
GET/api/v1/devices/{deviceId}/pointguard/cycles/{cycleId}/samples

Erforderlicher Scope telemetry.read

Parameter

  • deviceId · Pfad · string
  • cycleId · Pfad · string
  • pageSize · Abfrage · int · Standard 500
  • cursor · Abfrage · string? · Standard null

Erfolgreiche Antwort 200 PublicApiPage<PublicApiTelemetryDto>

Antwortfelder

  • deviceId · string
  • stamp · DateTime
  • latitude · decimal
  • longitude · decimal
  • temperature · double
  • humidity · double
  • batteryVoltage · double
  • batteryCurrent · double
  • batteryPercentage · double
  • current · double
  • signalQuality · double
  • railTemperature · double
  • tiltX · double
  • tiltY · double
  • tiltZ · double
  • description · string
  • telemetryType · int?
  • cycleId · string
  • cycleSampleIndex · int?
  • cycleSampleOffsetMs · int?
  • cycleDurationMs · int?
  • cycleSampleCount · int?
  • schemaVersion · string
  • pressure1Bar · double?
  • pressure2Bar · double?
  • endStop1 · bool?
  • endStop2 · bool?

Impact Mapping

Lesen und verwalten Sie Abhängigkeiten, Geschäftsfunktionen, Auswirkungsanalysen und Importe.

GET/api/v1/impact-mapping/relationship-types

Erforderlicher Scope impact_mapping.read · Impact-Mapping-Lizenz erforderlich

Erfolgreiche Antwort 200 IReadOnlyList<PublicApiImpactRelationshipTypeDto>

Antwortfelder

  • id · int
  • name · string
  • description · string?
  • directionLabel · string?
  • reverseLabel · string?
  • isSystemDefault · bool
GET/api/v1/impact-mapping/relationships

Erforderlicher Scope impact_mapping.read · Impact-Mapping-Lizenz erforderlich

Parameter

  • assetId · Abfrage · Guid

Erfolgreiche Antwort 200 PublicApiPage<PublicApiImpactRelationshipDto>

Antwortfelder

  • id · Guid
  • sourceAssetId · Guid
  • sourceAssetName · string?
  • targetAssetId · Guid
  • targetAssetName · string?
  • relationshipTypeId · int
  • relationshipTypeName · string?
  • impactLevel · int
  • isBlockingDependency · bool
  • hasRedundancy · bool
  • failureImpactDescription · string?
  • estimatedDowntimeCostPerHour · decimal?
  • notifyRole · string?
  • notifyEmail · string?
  • notes · string?
POST/api/v1/impact-mapping/relationships

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

JSON-Anfrageinhalt PublicApiCreateImpactRelationshipRequest

Erfolgreiche Antwort 201 CreatedId

PUT/api/v1/impact-mapping/relationships/{relationshipId}

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

Parameter

  • relationshipId · Pfad · Guid

JSON-Anfrageinhalt PublicApiCreateImpactRelationshipRequest

Erfolgreiche Antwort 204

DELETE/api/v1/impact-mapping/relationships/{relationshipId}

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

Parameter

  • relationshipId · Pfad · Guid

Erfolgreiche Antwort 204

GET/api/v1/impact-mapping/business-capabilities

Erforderlicher Scope impact_mapping.read · Impact-Mapping-Lizenz erforderlich

Erfolgreiche Antwort 200 PublicApiPage<PublicApiBusinessCapabilityDto>

Antwortfelder

  • id · Guid
  • name · string
  • description · string?
  • criticalityLevel · int
  • estimatedDowntimeCostPerHour · decimal?
  • ownerName · string?
  • ownerEmail · string?
POST/api/v1/impact-mapping/business-capabilities

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

JSON-Anfrageinhalt PublicApiCreateBusinessCapabilityRequest

Erfolgreiche Antwort 201 CreatedId

PUT/api/v1/impact-mapping/business-capabilities/{businessCapabilityId}

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

Parameter

  • businessCapabilityId · Pfad · Guid

JSON-Anfrageinhalt PublicApiCreateBusinessCapabilityRequest

Erfolgreiche Antwort 204

DELETE/api/v1/impact-mapping/business-capabilities/{businessCapabilityId}

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

Parameter

  • businessCapabilityId · Pfad · Guid

Erfolgreiche Antwort 204

POST/api/v1/impact-mapping/business-capability-links

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

JSON-Anfrageinhalt PublicApiLinkAssetCapabilityRequest

Erfolgreiche Antwort 204

PUT/api/v1/impact-mapping/business-capability-links/{linkId}

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

Parameter

  • linkId · Pfad · Guid

JSON-Anfrageinhalt PublicApiUpdateAssetCapabilityLinkRequest

Erfolgreiche Antwort 204

DELETE/api/v1/impact-mapping/business-capability-links/{linkId}

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

Parameter

  • linkId · Pfad · Guid

Erfolgreiche Antwort 204

GET/api/v1/impact-mapping/asset-capabilities

Erforderlicher Scope impact_mapping.read · Impact-Mapping-Lizenz erforderlich

Parameter

  • assetId · Abfrage · Guid

Erfolgreiche Antwort 200 PublicApiPage<PublicApiAssetCapabilityLinkDto>

Antwortfelder

  • id · Guid
  • assetId · Guid
  • assetName · string?
  • businessCapabilityId · Guid
  • businessCapabilityName · string?
  • criticalityLevel · int
  • impactLevel · int
  • isEssential · bool
  • notes · string?
GET/api/v1/impact-mapping/analysis/{assetId}

Erforderlicher Scope impact_mapping.read · Impact-Mapping-Lizenz erforderlich

Parameter

  • assetId · Pfad · Guid
  • maxDepth · Abfrage · int · Standard 5

Erfolgreiche Antwort 200 PublicApiImpactAnalysisDto

Antwortfelder

  • rootAssetId · Guid
  • rootAssetName · string
  • impactedAssets · IReadOnlyList<PublicApiImpactedAssetDto>
  • impactedCapabilities · IReadOnlyList<PublicApiImpactedCapabilityDto>
  • maxImpactLevel · int
  • estimatedTotalDowntimeCostPerHour · decimal
  • recommendation · PublicApiImpactRecommendationDto?
GET/api/v1/impact-mapping/analysis/{assetId}/graph

Erforderlicher Scope impact_mapping.read · Impact-Mapping-Lizenz erforderlich

Parameter

  • assetId · Pfad · Guid
  • maxDepth · Abfrage · int · Standard 5

Erfolgreiche Antwort 200 PublicApiImpactGraphDto

Antwortfelder

  • rootAsset · PublicApiImpactGraphRootDto
  • nodes · IReadOnlyList<PublicApiImpactGraphNodeDto>
  • links · IReadOnlyList<PublicApiImpactGraphLinkDto>
  • summary · PublicApiImpactGraphSummaryDto
  • recommendation · PublicApiImpactRecommendationDto?
POST/api/v1/impact-mapping/import/validate

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

JSON-Anfrageinhalt PublicApiImpactMappingImportRequest

Erfolgreiche Antwort 200 PublicApiImpactMappingImportResponse

Antwortfelder

  • committed · bool
  • validRows · int
  • skippedRows · int
  • businessFunctions · int
  • relationships · int
  • assetBusinessFunctionLinks · int
  • rows · IReadOnlyList<PublicApiImpactMappingImportRowResultDto>
POST/api/v1/impact-mapping/import/commit

Erforderlicher Scope impact_mapping.write · Impact-Mapping-Lizenz erforderlich

JSON-Anfrageinhalt PublicApiImpactMappingImportRequest

Erfolgreiche Antwort 200 PublicApiImpactMappingImportResponse

Antwortfelder

  • committed · bool
  • validRows · int
  • skippedRows · int
  • businessFunctions · int
  • relationships · int
  • assetBusinessFunctionLinks · int
  • rows · IReadOnlyList<PublicApiImpactMappingImportRowResultDto>

Antworten und Fehlerbehandlung

400
Ungültige Anfrage, fehlender Wert oder ungültiger Zeitraum. Prüfen Sie die Parameter der Operation.
401
API-Schlüssel fehlt oder ist ungültig. Prüfen Sie Umgebung und Organisationsschlüssel.
403
Der erforderliche Scope oder die Lizenz fehlt. Bitten Sie Ihren Organisationsadministrator um Zugriff.
404
Der angeforderte Datensatz ist im Organisationskontext nicht verfügbar oder wurde nicht gefunden.
503
Die Datenquelle für Kunden oder Ersatzteile ist vorübergehend nicht verfügbar. Versuchen Sie es später erneut; dies ist kein erfolgreicher leerer Export.
Öffentliche API-Dokumentation | Sepolo