Bina dengan Sepolo. Terbuka dari permintaan pertama.

Teroka pengesahan, endpoint dan kontrak data tanpa log masuk. Hubungkan sistem anda kepada Sepolo melalui permintaan API berskop organisasi. Termasuk kontrak carian pelanggan, pembekal dan alat ganti servis.

Baca, teroka dan muat turun tanpa akaun. Permintaan API menggunakan kunci dan kebenaran organisasi anda.

Muat turun definisi OpenAPI Muat turun koleksi Postman

Lapisan servis anda. Dengan atau tanpa ERP.

Satu tempat untuk pasukan merancang kerja, menyokong juruteknik dan memahami kos aset. Sambungkan Sepolo kepada sistem kewangan anda atau mulakan dengan rekod servis sendiri.

Kekalkan ERP sebagai pusat kewangan.

Gunakan Sepolo untuk perancangan servis, laporan mudah alih, alat ganti, masa dan peralatan terhubung. Bawa masuk data induk melalui integrasi ERP yang dikonfigurasi dan sediakan penyerahan kewangan melalui aliran penyedia yang disokong. Persetujui operasi dan pemetaan sebelum pelaksanaan.

Mulakan dengan servis. Tambah sambungan apabila perlu.

Jalankan operasi servis dengan rekod pelanggan, aset dan item tempatan dalam portal dalam talian dan aplikasi mudah alih. Penyambung ERP adalah pilihan. Sepolo mengurus penyampaian servis dan kos operasi; ia bukan pengganti lengkap sistem perakaunan atau ERP.

Pilih sambungan ERP yang sesuai

Microsoft Dynamics 365 Business Central: Dynamics 365 Business Central mempunyai pelaksanaan penyedia untuk penyegerakan data induk dan aliran kewangan yang disokong. Sahkan sambungan penyewa, kebenaran, pemetaan item dan penyerahan yang diperlukan bersama pasukan pelaksanaan.
SAP: Rancang SAP sebagai projek integrasi berskop. Klien item SAP semasa ialah prototaip, dan penghantaran kewangan SAP automatik belum boleh dijanjikan sebagai penyambung standard. Persetujui antara muka SAP, pelaksanaan dan ujian penerimaan dahulu.
e-conomic · Dinero · Uniconta · AutoCount · SQL Account: Pelaksanaan penyedia lain termasuk e-conomic, Dinero, Uniconta, AutoCount dan SQL Account. Operasi disokong dan persediaan berbeza mengikut penyedia. Kod sumber tidak membuktikan integrasi pelanggan telah digunakan atau diperakui.

Tentukan pemilik setiap rekod

Dengan ERP, kekalkan data induk pelanggan, pembekal, item dan kewangan yang dipersetujui di sana. Sepolo menghubungkan konteks itu kepada aset, lawatan, laporan, alat ganti dan masa. API carian membaca rekod Sepolo organisasi anda; kesegaran data mengikuti penyegerakan yang dikonfigurasi, bukan pertanyaan ERP langsung pada setiap panggilan.

Fahami data yang dipulangkan oleh API carian

Carian pelanggan dan alat ganti adalah baca sahaja. Alat ganti datang daripada katalog servis fizikal organisasi: item tempatan dan alat ganti ERP dipetakan yang dibenarkan oleh dasar stok/kedudukan, bukannya keseluruhan cache ERP. Item perkhidmatan sahaja dikecualikan. Kuantiti katalog tidak menjamin stok ERP semasa. Endpoint ini tidak mencipta pelanggan/item ERP atau mengepos invois; sahkan mata wang harga katalog semasa persediaan.

Gunakan externalSystem bersama externalCustomerId sebagai identiti sumber. customerNumber kini menyalin externalCustomerId dan bukan nombor akaun ERP yang dikenal pasti secara berasingan. updatedAtUtc boleh bernilai null. Selaraskan menggunakan ID stabil: penomboran halaman data langsung bukan snapshot transaksi atau suapan perubahan.

Buktikan satu aliran servis lengkap

Persetujui pemilikan data, versi ERP, kelayakan dan operasi yang diperlukan. Sahkan kunci dengan /api/v1/me, baca pembekal, pelanggan dan alat ganti yang layak, kemudian uji aliran servis-ke-kewangan terpilih dalam persekitaran anda. Simpan kunci API operasi pada pelayan dipercayai.

Permintaan pertama anda

Gunakan URL asas persekitaran Sepolo anda. Contoh di bawah menyemak kunci, organisasi, identiti klien dan skop yang tersedia.

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

Pengesahan dan akses

Hantar X-Sepolo-Api-Key: YOUR_API_KEY pada setiap permintaan, atau gunakan Authorization: Bearer YOUR_API_KEY. Kunci menentukan organisasi dan tidak memberikan akses kepada organisasi lain. Simpan kunci pada pelayan atau dalam stor rahsia, bukan dalam kod frontend awam.

Setiap operasi menyenaraikan skop yang diperlukan. Impact Mapping juga memerlukan lesen Impact Mapping organisasi. Hubungi pentadbir organisasi untuk akses API.

Permintaan, tarikh dan penomboran halaman

Gunakan cap masa UTC ISO 8601 untuk penapis tarikh. Senarai telemetri dan kitaran PointGuard memerlukan from/to (atau fromUtc/toUtc), dengan maksimum 31 hari setiap permintaan. Julat pergerakan membenarkan sehingga 366 hari. Janji temu dan lawatan servis menggunakan julat lalai 60 hari jika tarikh tidak diberikan, dengan maksimum 366 hari.

Jika pageSize dan cursor disokong, gunakan nextCursor yang dipulangkan untuk halaman seterusnya dan berhenti apabila hasMore ialah false. Saiz halaman dihadkan kepada 500. Sesetengah endpoint senarai memulangkan satu halaman data tanpa parameter cursor; semak setiap operasi. Gunakan nilai cursor tanpa mengubahnya.

Rujukan endpoint

Teroka operasi v1 yang dilaksanakan. Buka operasi untuk melihat parameter, kebenaran dan medan permintaan. Ketersediaan dalam persekitaran anda bergantung pada versi dan konfigurasi yang digunakan.

Identiti

Sahkan organisasi dan skop yang berkaitan dengan kunci.

GET/api/v1/me

Skop yang diperlukan Kunci API organisasi yang sah

Respons berjaya 200 PublicApiMeResponse

Medan respons

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

Pembekal

Baca pembekal tempatan dan pembekal ERP luaran organisasi.

GET/api/v1/vendors

Skop yang diperlukan vendors.read

Respons berjaya 200 PublicApiPage<PublicApiVendorDto>

Medan respons

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

Pelanggan

Baca rekod direktori pelanggan tempatan dan disegerakkan bagi organisasi kunci tersebut. Tapis mengikut externalSystem dan semak keputusan mengikut halaman.

GET/api/v1/customers

Skop yang diperlukan customers.read

Parameter

externalSystem · Pertanyaan · string?
pageSize · Pertanyaan · int · Lalai 100
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiCustomerDto>

Medan respons

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

Item dan alat ganti

Baca item katalog servis fizikal yang layak, termasuk alat ganti tempatan dan ERP yang dipetakan, dengan pengecam item, pembekal, kuantiti katalog, harga dan rujukan ERP. Tapis mengikut vendorId dan status.

GET/api/v1/inventory/parts

Skop yang diperlukan inventory.read

Parameter

vendorId · Pertanyaan · Guid?
status · Pertanyaan · string?
pageSize · Pertanyaan · int · Lalai 100
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiInventoryPartDto>

Medan respons

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

Janji temu

Baca janji temu kalendar, dengan penapis pengguna pilihan.

GET/api/v1/appointments

Skop yang diperlukan appointments.read

Parameter

fromUtc · Pertanyaan · DateTime?
toUtc · Pertanyaan · DateTime?
userId · Pertanyaan · Guid?

Respons berjaya 200 PublicApiPage<PublicApiAppointmentDto>

Medan respons

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

Lawatan servis

Baca kerja dirancang, status, konteks aset dan medan perjanjian yang tersedia.

GET/api/v1/service-visits

Skop yang diperlukan service_visits.read

Parameter

fromUtc · Pertanyaan · DateTime?
toUtc · Pertanyaan · DateTime?

Respons berjaya 200 PublicApiPage<PublicApiServiceVisitDto>

Medan respons

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?

Perjanjian

Baca perjanjian SLA, servis di tapak dan sokongan jauh serta liputannya.

GET/api/v1/agreements

Skop yang diperlukan agreements.read

Parameter

type · Pertanyaan · string?
customerId · Pertanyaan · string?
status · Pertanyaan · string?
pageSize · Pertanyaan · int · Lalai 100
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiAgreementDto>

Medan respons

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}

Skop yang diperlukan agreements.read

Parameter

agreementId · Laluan · Guid

Respons berjaya 200 PublicApiAgreementDetailDto

Medan respons

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

Sokongan jauh

Baca kes sokongan, konteks SLA dan penggunaan masa yang direkodkan.

GET/api/v1/remote-support-cases

Skop yang diperlukan remote_support.read

Parameter

status · Pertanyaan · string?
assetId · Pertanyaan · Guid?
slaOnly · Pertanyaan · bool?
customer · Pertanyaan · string?
pageSize · Pertanyaan · int · Lalai 100
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiRemoteSupportCaseDto>

Medan respons

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}

Skop yang diperlukan remote_support.read

Parameter

serviceReportId · Laluan · Guid

Respons berjaya 200 PublicApiRemoteSupportCaseDetailDto

Medan respons

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>

Peranti dan telemetri

Baca peranti, telemetri, pergerakan, kitaran PointGuard dan sampel.

GET/api/v1/devices

Skop yang diperlukan devices.read

Parameter

updatedSince · Pertanyaan · DateTime?
groupId · Pertanyaan · int?
status · Pertanyaan · string?
pageSize · Pertanyaan · int · Lalai 100
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiDeviceDto>

Medan respons

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}

Skop yang diperlukan devices.read

Parameter

deviceId · Laluan · string

Respons berjaya 200 PublicApiDeviceDto

Medan respons

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

Skop yang diperlukan telemetry.read

Parameter

deviceId · Laluan · string
from · Pertanyaan · DateTime?
to · Pertanyaan · DateTime?
fromUtc · Pertanyaan · DateTime?
toUtc · Pertanyaan · DateTime?
metrics · Pertanyaan · string?
telemetryType · Pertanyaan · int?
cycleId · Pertanyaan · string?
pageSize · Pertanyaan · int · Lalai 500
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiTelemetryDto>

Medan respons

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

Skop yang diperlukan movements.read

Parameter

deviceId · Laluan · string
from · Pertanyaan · DateTime?
to · Pertanyaan · DateTime?
fromUtc · Pertanyaan · DateTime?
toUtc · Pertanyaan · DateTime?
minDurationSeconds · Pertanyaan · int · Lalai 0
pageSize · Pertanyaan · int · Lalai 500
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiMovementDto>

Medan respons

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

Skop yang diperlukan movements.read

Parameter

deviceId · Laluan · string
movementId · Laluan · Guid

Respons berjaya 200 PublicApiMovementSignatureDto

Medan respons

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

Skop yang diperlukan telemetry.read

Parameter

deviceId · Laluan · string
from · Pertanyaan · DateTime?
to · Pertanyaan · DateTime?
fromUtc · Pertanyaan · DateTime?
toUtc · Pertanyaan · DateTime?
pageSize · Pertanyaan · int · Lalai 500
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiPointGuardCycleDto>

Medan respons

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

Skop yang diperlukan telemetry.read

Parameter

deviceId · Laluan · string
cycleId · Laluan · string
pageSize · Pertanyaan · int · Lalai 500
cursor · Pertanyaan · string? · Lalai null

Respons berjaya 200 PublicApiPage<PublicApiTelemetryDto>

Medan respons

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

Baca dan urus kebergantungan, keupayaan perniagaan, analisis impak dan import.

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

Skop yang diperlukan impact_mapping.read · Lesen Impact Mapping diperlukan

Respons berjaya 200 IReadOnlyList<PublicApiImpactRelationshipTypeDto>

Medan respons

id · int
name · string
description · string?
directionLabel · string?
reverseLabel · string?
isSystemDefault · bool

GET/api/v1/impact-mapping/relationships

Skop yang diperlukan impact_mapping.read · Lesen Impact Mapping diperlukan

Parameter

assetId · Pertanyaan · Guid

Respons berjaya 200 PublicApiPage<PublicApiImpactRelationshipDto>

Medan respons

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Badan permintaan JSON PublicApiCreateImpactRelationshipRequest

Respons berjaya 201 CreatedId

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Parameter

relationshipId · Laluan · Guid

Badan permintaan JSON PublicApiCreateImpactRelationshipRequest

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Parameter

relationshipId · Laluan · Guid

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.read · Lesen Impact Mapping diperlukan

Respons berjaya 200 PublicApiPage<PublicApiBusinessCapabilityDto>

Medan respons

id · Guid
name · string
description · string?
criticalityLevel · int
estimatedDowntimeCostPerHour · decimal?
ownerName · string?
ownerEmail · string?

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Badan permintaan JSON PublicApiCreateBusinessCapabilityRequest

Respons berjaya 201 CreatedId

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Parameter

businessCapabilityId · Laluan · Guid

Badan permintaan JSON PublicApiCreateBusinessCapabilityRequest

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Parameter

businessCapabilityId · Laluan · Guid

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Badan permintaan JSON PublicApiLinkAssetCapabilityRequest

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Parameter

linkId · Laluan · Guid

Badan permintaan JSON PublicApiUpdateAssetCapabilityLinkRequest

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Parameter

linkId · Laluan · Guid

Respons berjaya 204

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

Skop yang diperlukan impact_mapping.read · Lesen Impact Mapping diperlukan

Parameter

assetId · Pertanyaan · Guid

Respons berjaya 200 PublicApiPage<PublicApiAssetCapabilityLinkDto>

Medan respons

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}

Skop yang diperlukan impact_mapping.read · Lesen Impact Mapping diperlukan

Parameter

assetId · Laluan · Guid
maxDepth · Pertanyaan · int · Lalai 5

Respons berjaya 200 PublicApiImpactAnalysisDto

Medan respons

rootAssetId · Guid
rootAssetName · string
impactedAssets · IReadOnlyList<PublicApiImpactedAssetDto>
impactedCapabilities · IReadOnlyList<PublicApiImpactedCapabilityDto>
maxImpactLevel · int
estimatedTotalDowntimeCostPerHour · decimal
recommendation · PublicApiImpactRecommendationDto?

GET/api/v1/impact-mapping/analysis/{assetId}/graph

Skop yang diperlukan impact_mapping.read · Lesen Impact Mapping diperlukan

Parameter

assetId · Laluan · Guid
maxDepth · Pertanyaan · int · Lalai 5

Respons berjaya 200 PublicApiImpactGraphDto

Medan respons

rootAsset · PublicApiImpactGraphRootDto
nodes · IReadOnlyList<PublicApiImpactGraphNodeDto>
links · IReadOnlyList<PublicApiImpactGraphLinkDto>
summary · PublicApiImpactGraphSummaryDto
recommendation · PublicApiImpactRecommendationDto?

POST/api/v1/impact-mapping/import/validate

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Badan permintaan JSON PublicApiImpactMappingImportRequest

Respons berjaya 200 PublicApiImpactMappingImportResponse

Medan respons

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

POST/api/v1/impact-mapping/import/commit

Skop yang diperlukan impact_mapping.write · Lesen Impact Mapping diperlukan

Badan permintaan JSON PublicApiImpactMappingImportRequest

Respons berjaya 200 PublicApiImpactMappingImportResponse

Medan respons

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

Respons dan pengendalian ralat

400: Permintaan tidak sah, nilai diperlukan tiada atau julat tarikh tidak sah. Semak parameter operasi.
401: Kunci API tiada atau tidak sah. Semak persekitaran dan kunci organisasi.
403: Skop atau lesen yang diperlukan tiada. Minta akses daripada pentadbir organisasi.
404: Rekod diminta tidak tersedia atau tidak ditemui dalam konteks organisasi.
503: Sumber data pelanggan atau alat ganti tidak tersedia buat sementara waktu. Cuba lagi kemudian; respons ini bukan eksport kosong yang berjaya.