Sepolo

Byg med Sepolo. Åben fra første API-kald.

Udforsk godkendelse, endpoints og datakontrakter uden login. Forbind dine systemer med Sepolo gennem organisationsafgrænsede API-kald. Indeholder kontrakter for kunde-, leverandør- og reservedelsopslag.

Læs, udforsk og download uden en konto. API-kald bruger din organisations nøgle og rettigheder.

Download OpenAPI-definitionDownload Postman-samling

Dit servicelag. Med eller uden ERP.

Giv serviceteamet ét sted til planlægning, teknikerstøtte og overblik over aktivernes omkostninger. Forbind Sepolo med økonomisystemet, eller begynd med egne servicedata.

Behold ERP som økonomisk centrum.

Brug Sepolo til serviceplanlægning, mobilrapporter, reservedele, tid og forbundet udstyr. Hent stamdata gennem den konfigurerede ERP-integration, og forbered økonomisk overdragelse via det understøttede leverandørflow. Aftal operationer og datamapping før udrulning.

Begynd med service. Tilslut flere systemer efter behov.

Driv service med lokale kunde-, aktiv- og vareregistre i onlineportalen og mobilappen. En ERP-forbindelse er valgfri. Sepolo håndterer serviceleverance og driftsomkostninger; det erstatter ikke et komplet regnskabs- eller ERP-system.

Vælg den rette ERP-forbindelse

Microsoft Dynamics 365 Business Central
Dynamics 365 Business Central har en leverandørimplementering til synkronisering af stamdata og understøttede økonomiforløb. Validér tenantforbindelse, rettigheder, varemapping og den ønskede overdragelse med implementeringsteamet.
SAP
Behandl SAP som et afgrænset integrationsprojekt. Den nuværende SAP-vareklient er en prototype, og automatisk økonomisk levering til SAP kan endnu ikke loves som en standardforbindelse. Aftal først SAP-grænseflader, implementering og accepttest.
e-conomic · Dinero · Uniconta · AutoCount · SQL Account
Andre leverandørimplementeringer omfatter e-conomic, Dinero, Uniconta, AutoCount og SQL Account. Understøttede operationer og opsætning varierer. Kildekode dokumenterer ikke, at en kundeintegration er udrullet eller certificeret.

Beslut, hvem der ejer data

Med ERP bør de aftalte kunde-, leverandør-, vare- og økonomistamdata ejes dér. Sepolo forbinder dem med aktiver, besøg, rapporter, reservedele og tid. Opslags-API’erne læser organisationens Sepolo-data; aktualiteten følger den konfigurerede synkronisering og er ikke et direkte ERP-opslag ved hvert kald.

Forstå indholdet af opslags-API’erne

Kunde- og reservedelsopslag er skrivebeskyttede. Reservedele kommer fra organisationens fysiske servicekatalog: lokale varer og mappede ERP-varer, som lager- og positionspolitikken tillader, frem for hele ERP-varecachen. Rene serviceydelser er udeladt. Katalogmængden garanterer ikke aktuel ERP-lagerbeholdning. Disse endpoints opretter ikke ERP-kunder eller varer og bogfører ikke fakturaer; bekræft katalogprisernes valuta under opsætningen.

Brug externalSystem sammen med externalCustomerId som kildeidentitet. customerNumber er aktuelt en kopi af externalCustomerId, ikke et særskilt fundet ERP-kontonummer. updatedAtUtc kan være null. Afstem via stabile ID’er: sideinddeling af levende data er ikke et transaktionssnapshot eller et ændringsfeed.

Afprøv ét komplet serviceforløb

Aftal dataejerskab, ERP-version, legitimationsoplysninger og nødvendige operationer. Kontrollér nøglen med /api/v1/me, læs leverandører, kunder og tilladte reservedele, og test derefter det valgte service-til-økonomi-flow i jeres miljø. Opbevar API-nøgler på betroede servere.

Dit første API-kald

Brug basis-URL’en for dit Sepolo-miljø. Eksemplet nedenfor kontrollerer nøglen, organisationen, klientidentiteten og de tilgængelige scopes.

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

Godkendelse og adgang

Send X-Sepolo-Api-Key: YOUR_API_KEY ved hvert kald, eller brug Authorization: Bearer YOUR_API_KEY. Nøglen bestemmer organisationen og giver ikke adgang til andre organisationer. Opbevar nøgler på serveren eller i et hemmelighedslager, aldrig i offentlig frontendkode.

Hver operation viser det nødvendige scope. Impact Mapping kræver desuden organisationens Impact Mapping-licens. Kontakt organisationens administrator for API-adgang.

Kald, datoer og sideinddeling

Brug UTC-tidsstempler i ISO 8601-format til datofiltre. Telemetri og PointGuard-cykluslister kræver from/to (eller fromUtc/toUtc) og højst 31 dage pr. kald. Bevægelsesvinduer tillader op til 366 dage. Aftaler i kalenderen og servicebesøg bruger som standard 60 dage, når datoer udelades, og højst 366 dage.

Hvor pageSize og cursor understøttes, bruges den returnerede nextCursor til næste side. Stop, når hasMore er false. Sidestørrelsen er begrænset til 500. Nogle listeendpoints returnerer én dataside uden en cursor-parameter; se den enkelte operation. Cursorværdier skal bruges uændret.

Endpointreference

Se de implementerede v1-operationer. Udvid en operation for parametre, rettigheder og felter. Tilgængeligheden i dit miljø afhænger af den installerede version og konfiguration.

Identitet

Kontrollér organisationen og de scopes, der er knyttet til nøglen.

GET/api/v1/me

Nødvendigt scope Gyldig organisations-API-nøgle

Svar ved succes 200 PublicApiMeResponse

Svarfelter

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

Leverandører

Læs organisationens lokale leverandører og eksterne ERP-leverandører.

GET/api/v1/vendors

Nødvendigt scope vendors.read

Svar ved succes 200 PublicApiPage<PublicApiVendorDto>

Svarfelter

  • 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

Kunder

Læs lokale og synkroniserede kunderegistre for nøglens organisation. Filtrér på externalSystem, og gennemgå resultaterne sidevis.

GET/api/v1/customers

Nødvendigt scope customers.read

Parametre

  • externalSystem · Forespørgsel · string?
  • pageSize · Forespørgsel · int · Standard 100
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiCustomerDto>

Svarfelter

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

Varer og reservedele

Læs tilladte fysiske servicevarer fra det lokale katalog og mappede ERP-varer med vare-ID’er, leverandør, katalogmængde, priser og ERP-referencer. Filtrér på vendorId og status.

GET/api/v1/inventory/parts

Nødvendigt scope inventory.read

Parametre

  • vendorId · Forespørgsel · Guid?
  • status · Forespørgsel · string?
  • pageSize · Forespørgsel · int · Standard 100
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiInventoryPartDto>

Svarfelter

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

Kalenderaftaler

Læs kalenderaftaler, eventuelt filtreret efter bruger.

GET/api/v1/appointments

Nødvendigt scope appointments.read

Parametre

  • fromUtc · Forespørgsel · DateTime?
  • toUtc · Forespørgsel · DateTime?
  • userId · Forespørgsel · Guid?

Svar ved succes 200 PublicApiPage<PublicApiAppointmentDto>

Svarfelter

  • 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

Servicebesøg

Læs planlagt arbejde, status, aktivkontekst og tilgængelige aftalefelter.

GET/api/v1/service-visits

Nødvendigt scope service_visits.read

Parametre

  • fromUtc · Forespørgsel · DateTime?
  • toUtc · Forespørgsel · DateTime?

Svar ved succes 200 PublicApiPage<PublicApiServiceVisitDto>

Svarfelter

  • 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?

Aftaler

Læs SLA-, service- og fjernsupportaftaler samt deres dækning.

GET/api/v1/agreements

Nødvendigt scope agreements.read

Parametre

  • type · Forespørgsel · string?
  • customerId · Forespørgsel · string?
  • status · Forespørgsel · string?
  • pageSize · Forespørgsel · int · Standard 100
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiAgreementDto>

Svarfelter

  • 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}

Nødvendigt scope agreements.read

Parametre

  • agreementId · Sti · Guid

Svar ved succes 200 PublicApiAgreementDetailDto

Svarfelter

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

Fjernsupport

Læs supportsager, SLA-kontekst og registreret tidsforbrug.

GET/api/v1/remote-support-cases

Nødvendigt scope remote_support.read

Parametre

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

Svar ved succes 200 PublicApiPage<PublicApiRemoteSupportCaseDto>

Svarfelter

  • 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}

Nødvendigt scope remote_support.read

Parametre

  • serviceReportId · Sti · Guid

Svar ved succes 200 PublicApiRemoteSupportCaseDetailDto

Svarfelter

  • 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>

Enheder og telemetri

Læs enheder, telemetri, bevægelser, PointGuard-cyklusser og målepunkter.

GET/api/v1/devices

Nødvendigt scope devices.read

Parametre

  • updatedSince · Forespørgsel · DateTime?
  • groupId · Forespørgsel · int?
  • status · Forespørgsel · string?
  • pageSize · Forespørgsel · int · Standard 100
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiDeviceDto>

Svarfelter

  • 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}

Nødvendigt scope devices.read

Parametre

  • deviceId · Sti · string

Svar ved succes 200 PublicApiDeviceDto

Svarfelter

  • 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

Nødvendigt scope telemetry.read

Parametre

  • deviceId · Sti · string
  • from · Forespørgsel · DateTime?
  • to · Forespørgsel · DateTime?
  • fromUtc · Forespørgsel · DateTime?
  • toUtc · Forespørgsel · DateTime?
  • metrics · Forespørgsel · string?
  • telemetryType · Forespørgsel · int?
  • cycleId · Forespørgsel · string?
  • pageSize · Forespørgsel · int · Standard 500
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiTelemetryDto>

Svarfelter

  • 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

Nødvendigt scope movements.read

Parametre

  • deviceId · Sti · string
  • from · Forespørgsel · DateTime?
  • to · Forespørgsel · DateTime?
  • fromUtc · Forespørgsel · DateTime?
  • toUtc · Forespørgsel · DateTime?
  • minDurationSeconds · Forespørgsel · int · Standard 0
  • pageSize · Forespørgsel · int · Standard 500
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiMovementDto>

Svarfelter

  • 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

Nødvendigt scope movements.read

Parametre

  • deviceId · Sti · string
  • movementId · Sti · Guid

Svar ved succes 200 PublicApiMovementSignatureDto

Svarfelter

  • 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

Nødvendigt scope telemetry.read

Parametre

  • deviceId · Sti · string
  • from · Forespørgsel · DateTime?
  • to · Forespørgsel · DateTime?
  • fromUtc · Forespørgsel · DateTime?
  • toUtc · Forespørgsel · DateTime?
  • pageSize · Forespørgsel · int · Standard 500
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiPointGuardCycleDto>

Svarfelter

  • 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

Nødvendigt scope telemetry.read

Parametre

  • deviceId · Sti · string
  • cycleId · Sti · string
  • pageSize · Forespørgsel · int · Standard 500
  • cursor · Forespørgsel · string? · Standard null

Svar ved succes 200 PublicApiPage<PublicApiTelemetryDto>

Svarfelter

  • 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

Læs og vedligehold afhængigheder, forretningsfunktioner, konsekvensanalyser og importer.

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

Nødvendigt scope impact_mapping.read · Impact Mapping-licens påkrævet

Svar ved succes 200 IReadOnlyList<PublicApiImpactRelationshipTypeDto>

Svarfelter

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

Nødvendigt scope impact_mapping.read · Impact Mapping-licens påkrævet

Parametre

  • assetId · Forespørgsel · Guid

Svar ved succes 200 PublicApiPage<PublicApiImpactRelationshipDto>

Svarfelter

  • 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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

JSON i forespørgslen PublicApiCreateImpactRelationshipRequest

Svar ved succes 201 CreatedId

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

Parametre

  • relationshipId · Sti · Guid

JSON i forespørgslen PublicApiCreateImpactRelationshipRequest

Svar ved succes 204

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

Parametre

  • relationshipId · Sti · Guid

Svar ved succes 204

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

Nødvendigt scope impact_mapping.read · Impact Mapping-licens påkrævet

Svar ved succes 200 PublicApiPage<PublicApiBusinessCapabilityDto>

Svarfelter

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

JSON i forespørgslen PublicApiCreateBusinessCapabilityRequest

Svar ved succes 201 CreatedId

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

Parametre

  • businessCapabilityId · Sti · Guid

JSON i forespørgslen PublicApiCreateBusinessCapabilityRequest

Svar ved succes 204

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

Parametre

  • businessCapabilityId · Sti · Guid

Svar ved succes 204

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

JSON i forespørgslen PublicApiLinkAssetCapabilityRequest

Svar ved succes 204

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

Parametre

  • linkId · Sti · Guid

JSON i forespørgslen PublicApiUpdateAssetCapabilityLinkRequest

Svar ved succes 204

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

Parametre

  • linkId · Sti · Guid

Svar ved succes 204

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

Nødvendigt scope impact_mapping.read · Impact Mapping-licens påkrævet

Parametre

  • assetId · Forespørgsel · Guid

Svar ved succes 200 PublicApiPage<PublicApiAssetCapabilityLinkDto>

Svarfelter

  • 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}

Nødvendigt scope impact_mapping.read · Impact Mapping-licens påkrævet

Parametre

  • assetId · Sti · Guid
  • maxDepth · Forespørgsel · int · Standard 5

Svar ved succes 200 PublicApiImpactAnalysisDto

Svarfelter

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

Nødvendigt scope impact_mapping.read · Impact Mapping-licens påkrævet

Parametre

  • assetId · Sti · Guid
  • maxDepth · Forespørgsel · int · Standard 5

Svar ved succes 200 PublicApiImpactGraphDto

Svarfelter

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

JSON i forespørgslen PublicApiImpactMappingImportRequest

Svar ved succes 200 PublicApiImpactMappingImportResponse

Svarfelter

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

Nødvendigt scope impact_mapping.write · Impact Mapping-licens påkrævet

JSON i forespørgslen PublicApiImpactMappingImportRequest

Svar ved succes 200 PublicApiImpactMappingImportResponse

Svarfelter

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

Svar og fejlhåndtering

400
Ugyldigt kald, manglende værdi eller ugyldigt datovindue. Kontrollér operationens parametre.
401
API-nøglen mangler eller er ugyldig. Kontrollér miljøet og organisationens nøgle.
403
Det nødvendige scope eller den nødvendige licens mangler. Bed organisationens administrator om adgang.
404
Den ønskede post er utilgængelig eller findes ikke i organisationens kontekst.
503
Datakilden til kunder eller reservedele er midlertidigt utilgængelig. Prøv igen senere; dette svar er ikke en vellykket, tom eksport.
Offentlig API-dokumentation | Sepolo