Qodex.ai
Qodex.ai
Introduction
Technical Token Manager API
Issues technical token to access customer IoT data.Issues multiple technical tokens to access customer IoT data.Provides list of user tenants provisioned to an application.
SieSmart B2B API
common-countries
Returns all countriesReturns all regions for the introducers country id.
common
Get the job titles available for the current introducer country.Get the legal forms available for creation of a customer manually.Get the lessors available for the current introducer.Get the loan purposes available.Get the professions available for the current introducer country.Get the person titles available for the current introducer country.Get manageable offices of the current introducer.Get the sales contacts manageable by the current user.Get the iac codes available for the selected office.
introducer/equipment-suppliers
Get the equipment suppliers available for the introducer.Add a equipment supplier to the introducer.
calculation
Performs a finance calculation and returns the result.Returns the configuration to perform a calculation.
proposals-{proposal-id}-assets-{asset-id}
Updates the asset of the proposal.Deletes and removes the asset from the proposal.
proposals-{proposal-id}-assets
Returns all assets of the proposal.Adds a new asset to the proposal.
proposals-{proposal-id}-customer-invoice-address
Set the customer invoice address.Creates a new customer invoice address.
proposals-{proposal-id}-customer-delivery-address
Set the customer delivery address.Creates a new customer delivery address.
proposals-{proposal-id}-customer
Sets the proposal's customer.Updates the proposal's customer.Gets proposal customer's addresses.Gets proposal customer's boardmembers.Updates the proposal's customer invoice contact.
proposals-{proposal-id}-decision-request
Request credit decision.Cancel the credit decision request.
proposals-{proposal-id}-decision
Check the pre-condition whether it's allowed to create a decision request.
proposals-{proposal-id}-documents-uploaded-documents
Get the uploaded documents available for a proposal.Upload document to DMS.
proposals-{proposal-id}-documents-signing
Request a signature for the given document.Download the signed document.Delete pending signing request.Refresh and return the signing request's status.
proposals-{proposal-id}-documents
Get the documents available for a proposal.Get the document types available for the selected proposal.Download selected documents of the proposal.
proposals-{proposal-id}-loans-{loan-id}
Updates the loan of the proposal.Removes the loan from the proposal.
proposals-{proposal-id}-loans
Get the loans available for this proposal.Adds a new loan to the proposal.
proposals-{proposal-id}-upgrades
Get the upgrade agreements available for this proposal.Adds a new upgrade agreement to the proposal.Removes the upgrade agreement from the proposal.
proposals-{proposal-id}-equipment-suppliers
Get all assigned equipment suppliers.Adds a new equipment supplier to the proposal.Remove the equipment supplier.
proposals-{proposal-id}
Returns a single proposal.Expires the proposal.Amend the proposal.Performs a finance calculation, adds it to the proposal and returns the updated proposal.
proposals
Creates a new proposal.Finds proposals matching given query parameters.
notifications-endpoint
Update customer notification endpoint URL.Register customer notification endpoint URL.Remove registration of customer notification endpoint URL.
notifications-{notification-uuid}
Get proposal data belonging to a notification subscriptiondelete notification subscription for a specific proposal
notifications
Subscribe for notification about events for a proposal.
Get customers matching the query parameters.
Physical Identity and Access Management API
identities-{id}
To update an identity dataTo delete an identity
identities
Get identitiesTo create an identity
privileges-assignments/of-holder/{holderId}
To retrieve assigned privileges for an identityAssign priviliges to an Identity
privileges
To retrieve available privileges from Security Manager
PROCUREMENT-DATA-SERVICE
suppliers-identifierTypes-{id}
Update a supplier identifier type for a company in SiGREEN.Delete an unused supplier identifier type for a company in SiGREEN.
suppliers-identifierTypes
API to create supplier identifier type of a company in SiGREEN.Get supplier identifier types for a company in SiGREEN.
suppliers-{id}
Update a supplier by supplier Id in SiGREEN.Get supplier by id for one company in SiGREEN
suppliers
Create a supplier in SiGREENGet all suppliers for one company in SiGREEN.
components-identifierTypes-{id}
Update a component identifier type for a company in SiGREEN.Delete an unused component identifier type for a company in SiGREEN.
components-identifierTypes
Create a component identifier type for a company in SiGREEN.Get component identifier types for a company in SiGREEN.
components-{id}-secondaryData-{secondaryDataId}
Update component secondary data by secondary data id.Get component secondary data by secondary data id
components-{id}-secondaryData
Create secondary data with component.Get all component secondary data for component in SiGREEN
components-{id}-linkSuppliers-{componentSupplierLinkId}
Get linked suppliers by componentSupplierLinkId with componentUpdate location/share/secondary data/supplier product id by component supplier idDelete link between component and supplier
components-{id}-linkSuppliers
Link suppliers and secondary data with componentGet all linked suppliers with component
components-{id}
Update component details by idGet component details by idGet an export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.
components
Create component in SiGREENGet all components for one company in SiGREENGET the PCF data for your components in SiGREEN.Get an aggregated export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.
Charger Control API
Set external rate limit of a charger group from external systems the power sharing across different types of loads can be prioritized dynamically and allocated.Get list of power groups.
MindConnect API
dataPointMappings-{id}
Get a mapping by idDelete a mapping
dataPointMappings
Create single mappingGet mappings.
eventMappings-{id}
Get a mapping by idUpdate a mappingDelete a mapping
eventMappings
Create single mappingGet mappings
diagnosticActivations-{id}
Update status of Diagnostic Activation Gets a diagnostic activation. Deletes a diagnostic activation Get a diagnostic messages of specific activation resource
diagnosticActivations
Creates a new diagnostic activation Gets diagnostic activations
recoverableRecords-{id}
Delete a recoverable recordRe-play a recoverable recordGet download link of record payload.
recoverableRecords
Get all recoverable records
/exchangeGet Diagnostic Information
Lifecycle Twin API
categories-{id}
Categories Get OneCategories Put One
categories-{entityType}-groups-{id}
Category All Groups Get OneCategory All Groups Put One
categories-{entityType}-groups
Category All Groups Get ManyCategory All Groups Post OneCategory All Groups Delete Many
categories-{entityType}-tabs-{id}
Category All Tabs Get OneCategory All Tabs Put One
categories-{entityType}-tabs
Category All Tabs Get ManyCategory All Tabs Post OneCategory All Tabs Delete Many
categories-{categoryId}/{entityType}-groups-{groupId}/fields
Category Field Get ManyCategory Field Get One
categories-{categoryId}/{entityType}-groups-{id}
Category Field Group Get OneCategory Field Group Put One
categories-{categoryId}/{entityType}-groups
Category Field Group Get ManyCategory Field Group Post OneCategory Field Group Delete Many
categories-{categoryId}/{entityType}-tabs-{id}
Category Tab Get OneCategory Tab Put One
categories-{categoryId}/{entityType}-tabs
Category Tab Get ManyCategory Tab Post OneCategory Tab Delete Many
categories
Categories Get ManyCategories Post OneCategories Delete ManyAll Category Status Get Many
assets-massupdate
Asset Mass Update UpdateAsset Mass Update Put One
assets-{assetId}-varslinkup
Asset Rds Vars Get ManyAsset Rds Vars Delete Many
assets-{assetId}-systems-{id}
Asset Systems Put OneAsset Systems Delete One
assets-{assetId}-systems
Asset Systems Get ManyAsset Systems Delete Many
assets-{assetId}-relations-{id}
Asset Relations Put OneAsset Relations Delete One
assets-{assetId}-relations
Asset Relations Get ManyAsset Relations Post ManyAsset Relations Delete Many
assets-{assetId}
Asset Rds Archive Get ManyAsset Rds Vars Not Linked Get Many
assets-{id}
Asset Get OneAsset Put OneAsset Delete One
assets
Asset Get ManyAsset Post OneAsset Delete ManyAsset Get Asset FieldsAsset Rename ManyAsset Get By Object Id
bcf-issues-archive-{id}-download
BCF Archive DownloadBCF Archive Download Head
bcf-issues-archive
BCF Archive Post Stream
bcf-issues-{issueId}/comments-{id}-download
BCF Comment DownloadBCF Comment Download Head
bcf-issues-{issueId}/comments-{id}
BCF Comment Get OneBCF Comment Put OneBCF Comment Delete OneBCF Comment Put Stream
bcf-issues-{issueId}/comments
BCF Comment Get ManyBCF Comment Post OneBCF Comment Delete ManyBCF Comment Post Stream
bcf-issues
BCF Import Post Stream
bcf-comments/{id}
BCF Comment Delete CommentBCF Comment Update Comment
bimconnectors-{id}
BIM Connector Get OneBIM Connector Put One
bimconnectors-{connectorId}/{entityType}/mappings-{mappingId}/rules
BIM Connector Field Mapping Rule Post OneBIM Connector Field Mapping Rule Delete ManyBIM Connector Field Mapping Rule Put One
bimconnectors-{connectorId}/{entityType}/mappings
BIM Connector Field Mappings Get ManyBIM Connector Field Mappings Post OneBIM Connector Field Mappings Delete ManyBIM Connector Field Mappings Put One
bimconnectors
BIM Connector Get ManyBIM Connector Post One
{entitytype}-categories/fields-{id}
Category Custom Fields Get OneCategory Custom Fields Put One
{entitytype}-categories/fields
Category Custom Fields Get ManyCategory Custom Fields Post OneCategory Custom Fields Delete Many
{entitytype}-groups-{id}
Entity Type Custom Field Group Get OneEntity Type Custom Field Group Put One
{entitytype}-groups
Entity Type Custom Field Group Get ManyEntity Type Custom Field Group Post OneEntity Type Custom Field Group Delete Many
{entitytype}-customfields-{id}
Entity Type Custom Fields Get OneEntity Type Custom Fields Put One
{entitytype}-customfields-categories/{categoryId}/free-{id}
Entity Type Custom Fields Free Get OneEntity Type Custom Fields Free Put One
{entitytype}-customfields-categories/{categoryId}/free
Entity Type Custom Fields Free Get ManyEntity Type Custom Fields Free Post OneEntity Type Custom Fields Free Delete Many
{entitytype}-customfields-free-{id}
Entity Type Custom Fields Free At All Get OneEntity Type Custom Fields Free At All Put One
{entitytype}-customfields-free
Entity Type Custom Fields Free At All Get ManyEntity Type Custom Fields Free At All Post OneEntity Type Custom Fields Free At All Delete Many
{entitytype}-customfields
Entity Type Custom Fields Get ManyEntity Type Custom Fields Post OneEntity Type Custom Fields Delete Many
{entitytype}-tabs-{id}
Entity Type Custom Tab Get OneEntity Type Custom Tab Put One
{entitytype}-tabs
Entity Type Custom Tab Get ManyEntity Type Custom Tab Post OneEntity Type Custom Tab Delete Many
clients-{clientName}/organizations-{id}
Client Organization Get OneClient Organization Post One For Organization
clients-{clientName}/organizations
Client Organization Get ManyClient Organization Post OneClient Organization Delete Many
clients-{clientname}/users-{id}
Client User Get OneClient User Post One Model
clients-{clientname}/users
Client User Get ManyClient User Post OneClient User Delete Many
customfields-{id}
Custom Field Definition Get OneCustom Field Definition Put One
customfields-instances-{id}
Custom Field Definition Instance Get OneCustom Field Definition Instance Put One
customfields-instances
Custom Field Definition Instance Get ManyCustom Field Definition Instance Post OneCustom Field Definition Instance Delete ManyCustom Field Definition Instance Post Instances Custom Fields File
customfields-types-{id}
Field Type Get OneField Type Put One
customfields-types-{fieldTypeId}/values-{id}-download
Field Type Values DownloadField Type Values Download Head
customfields-types-{fieldTypeId}/values-{id}
Field Type Values Get OneField Type Values Put OneField Type Values Delete OneField Type Values Put Stream
customfields-types-{fieldTypeId}/values
Field Type Values Get ManyField Type Values Post OneField Type Values Delete ManyField Type Values Post Stream
customfields-types
Field Type Get ManyField Type Post OneField Type Delete Many
customfields
Custom Field Definition Get ManyCustom Field Definition Post OneCustom Field Definition Delete ManyCustom Field Definition Post Definitions File
{entityType}-{baseEntityId}/tabs/{groupId}/values
Custom Tab Value Get ManyCustom Tab Value Post OneCustom Tab Value Delete Many
{entityType}-categories-{id}
Entity Categories Get OneEntity Categories Put One
{entityType}-categories-free-{id}
Entity Categories Free Get OneEntity Categories Free Put One
{entityType}-categories-free
Entity Categories Free Get ManyEntity Categories Free Post OneEntity Categories Free Delete Many
{entityType}-categories
Entity Categories Get ManyEntity Categories Post OneEntity Categories Delete Many
{entityType}-groups/{groupId}/fields
Entity Type Group Fields Get ManyEntity Type Group Fields Get One
{entityType}-tabs/{groupId}/fields
Entity Type Group Fields Get ManyEntity Type Group Fields Get One
disciplines-{id}
Discipline Get OneDiscipline Put One
disciplines
Discipline Get ManyDiscipline Post OneDiscipline Delete Many
folders/{folderId}/documents-autoname
Document Autonaming Get Document AutonameDocument Autonaming Get Document Autoname ValidatedDocument Autonaming Get Document Required FieldsDocument Autonaming Get Is Autoname
documents-{documentId}-files/actual-{id}
Document File Version Get OneDocument File Version Put One
documents-{documentId}-files/actual
Document File Version Get ManyDocument File Version Post OneDocument File Version Delete Many
documents-{documentId}
Document History Get ManyDocument Tags Get ManyFolder Statuses Statistics Get Many
documents-fromsurvey-{id}
Document From Survey Get OneDocument From Survey Put One
documents-fromsurvey
Document From Survey Get ManyDocument From Survey Post OneDocument From Survey Delete ManyDocument From Survey Create From Survey
documents-massupdate
Document Mass Update UpdateDocument Mass Update Put One
documents-{folderId}/alldocuments-{id}
Folder All Documents Get OneFolder All Documents Put One
documents-{folderId}/alldocuments
Folder All Documents Get ManyFolder All Documents Post OneFolder All Documents Delete Many
documents-{id}
Document Get OneDocument Put OneDocument DownloadDocument Put Stream
documents-export-statuses/{taskId}
Document Export Get File Compression StatusDocument Export Cancel Compression
documents-export
Document Export Get Compressed File
documents
Document Get ManyDocument Post OneDocument Delete ManyDocument Autonaming Fields Get ManyDocument File Import Cancel ImportDocument Post Stream
documenttypes-{id}
Document Type Get OneDocument Type Put One
documenttypes
Document Type Get ManyDocument Type Post OneDocument Type Delete Many
document-types-groups-{id}
Document Type All Custom Field Group Get OneDocument Type All Custom Field Group Put One
document-types-groups
Document Type All Custom Field Group Get ManyDocument Type All Custom Field Group Post OneDocument Type All Custom Field Group Delete Many
document-types-fields-{id}
Document Type All Custom Fields Get OneDocument Type All Custom Fields Put One
document-types-fields
Document Type All Custom Fields Get ManyDocument Type All Custom Fields Post OneDocument Type All Custom Fields Delete Many
document-types-tabs-{id}
Document Type All Custom Field Tab Get OneDocument Type All Custom Field Tab Put One
document-types-tabs
Document Type All Custom Field Tab Get ManyDocument Type All Custom Field Tab Post OneDocument Type All Custom Field Tab Delete Many
document-types-{documentTypeId}-groups-{id}
Document Type Custom Field Group Get OneDocument Type Custom Field Group Put One
document-types-{documentTypeId}-groups-{groupId}/fields
Document Type Custom Fields Get ManyDocument Type Custom Fields Get One
document-types-{documentTypeId}-groups
Document Type Custom Field Group Get ManyDocument Type Custom Field Group Post OneDocument Type Custom Field Group Delete Many
document-types-{documentTypeId}-tabs-{id}
Document Type Custom Field Tab Get OneDocument Type Custom Field Tab Put One
document-types-{documentTypeId}-tabs
Document Type Custom Field Tab Get ManyDocument Type Custom Field Tab Post OneDocument Type Custom Field Tab Delete Many
document-types-{id}
Entity Document Types Get OneEntity Document Types Put One
document-types-free-{id}
Entity Document Types Free Get OneEntity Document Types Free Put One
document-types-free
Entity Document Types Free Get ManyEntity Document Types Free Post OneEntity Document Types Free Delete Many
document-types
Entity Document Types Get ManyEntity Document Types Post OneEntity Document Types Delete Many
document-customfields/types/{documentTypeId}/free-{id}
Document Type Custom Fields Free Get OneDocument Type Custom Fields Free Put One
document-customfields/types/{documentTypeId}/free
Document Type Custom Fields Free Get ManyDocument Type Custom Fields Free Post OneDocument Type Custom Fields Free Delete Many
entities-{ownerId}-files-{id}
Owned File Get OneOwned File Put One
entities-{ownerId}-files
Owned File Get ManyOwned File Post OneOwned File Delete ManyOwned File Renew File
entities-{ownerId}-documents-{id}
Entity Document Get OneEntity Document Put OneEntity Document DownloadEntity Document Put Stream
entities-{ownerId}-documents
Entity Document Get ManyEntity Document Post OneEntity Document Delete ManyEntity Document Post Stream
entities
Entity Type Permission Get Many
facilities-{id}
Facility Get OneFacility Put One
facilities-massupdate
Facility Mass Update UpdateFacility Mass Update Put One
facilities
Facility Get ManyFacility Post OneFacility Delete ManyFacility Affects Get ManyFacility Get By Object Id
files-common-{id}
File Get OneFile Put OneFile Get Thumbnails
files-common
File Get ManyFile Post OneFile Delete Many
files-{fileId}-zip-{id}
File Zip Get OneFile Zip Put One
files-{fileId}-zip-{name}/download
File Zip Get File From ZipFile Zip Get File From Zip Head
files-{fileId}-zip
File Zip Get ManyFile Zip Post OneFile Zip Delete Many
files-{fileId}
File Versions Get Many
files
File Compare Compare
floors-{id}
Floor Get OneFloor Put OneFloor Delete One
floors-massupdate
Floor Mass Update UpdateFloor Mass Update Put One
floors-{floorId}/spaces-assessment
Space Assessment Get ManySpace Assessment Get OneSpace Assessment Get Spaces And Last Assessment
floors-{floorId}/spaces-{id}-download
Floor Spaces DownloadFloor Spaces Download Head
floors-{floorId}/spaces-{id}
Floor Spaces Get OneFloor Spaces Put OneFloor Spaces Delete OneFloor Spaces Put Stream
floors-{floorId}/spaces
Floor Spaces Get ManyFloor Spaces Post OneFloor Spaces Delete ManyFloor Unassigned Spaces Get ManyFloor Spaces Post Stream
floors
Floor Get ManyFloor Post OneFloor Delete ManyFloor Category Get ManyFloor Get By Object Id
formprocesses-{formprocessId}/questions
Form Process Answer Get ManyForm Process Answer Post OneForm Process Answer Delete ManyForm Process Answer Put One
formprocesses
Form Process Get ManyForm Process Post OneForm Process Get One
inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files-{id}
Inspection File Get OneInspection File Put One
inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files
Inspection File Get ManyInspection File Post OneInspection File Delete Many
inspections-{inspectionId}-questions-{id}
Common Question Answer Get OneCommon Question Answer Put OneCommon Question Answer Delete One
inspections-{inspectionId}-questions
Common Question Answer Get ManyCommon Question Answer Post OneCommon Question Answer Delete Many
inspections-{inspectionId}-forms/{formId}-questions-{id}
Form Question Answer Get OneForm Question Answer Put OneForm Question Answer Delete One
inspections-{inspectionId}-forms/{formId}-questions
Form Question Answer Get ManyForm Question Answer Post OneForm Question Answer Delete Many
inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions-{id}
Section Question Answer Get OneSection Question Answer Put OneSection Question Answer Delete One
inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions
Section Question Answer Get ManySection Question Answer Post OneSection Question Answer Delete Many
inspections-{inspectionId}
Inspection Get Sections
inspections-types-{id}
Inspection Type Get OneInspection Type Put One
inspections-types
Inspection Type Get ManyInspection Type Post OneInspection Type Delete ManyInspection Workflow Roles Get Many
inspections
Inspection Get ManyInspection Delete ManyInspection Put One
issues-{issueId}
Issue Assign To User Get ManyIssue Log Get Many
issues-types-{id}
Issue Category Get OneIssue Category Put One
issues-types
Issue Category Get ManyIssue Category Post OneIssue Category Delete ManyIssue Category Get Create Permission Categories
issues-organizations
Issues Organizations Get ManyIssues Organizations Delete ManyIssues Organizations Get One
issues-{categoryId}/workflows-{id}
Issue Workflow Get OneIssue Workflow Put One
issues-{categoryId}/workflows
Issue Workflow Get ManyIssue Workflow Post OneIssue Workflow Delete Many
issues-{id}
Work Order Get OneWork Order Put OneWork Order Delete One
issues-printform-{id}-download
Issue Print Form DownloadIssue Print Form Download Head
issues-printform-{id}
Issue Print Form Get OneIssue Print Form Put OneIssue Print Form Delete OneIssue Print Form Put Stream
issues-printform
Issue Print Form DownloadIssue Print Form Post OneIssue Print Form Delete ManyIssue Print Form Post Stream
issues
Work Order Get ManyWork Order Delete ManyIssue Priority Get ManyWork Order New Closed Statistics Get ManyWork Order Attach FileWork Order Detach File
issuecategories-{id}
Issue Categories Get OneIssue Categories Put One
issuecategories-free-{id}
Issue Categories Free Get OneIssue Categories Free Put One
issuecategories-free
Issue Categories Free Get ManyIssue Categories Free Post OneIssue Categories Free Delete Many
issuecategories
Issue Categories Get ManyIssue Categories Post OneIssue Categories Delete Many
issue-categories-groups-{id}
Issue Category All Custom Field Group Get OneIssue Category All Custom Field Group Put One
issue-categories-groups
Issue Category All Custom Field Group Get ManyIssue Category All Custom Field Group Post OneIssue Category All Custom Field Group Delete Many
issue-categories-tabs-{id}
Issue Category All Custom Field Tab Get OneIssue Category All Custom Field Tab Put One
issue-categories-tabs
Issue Category All Custom Field Tab Get ManyIssue Category All Custom Field Tab Post OneIssue Category All Custom Field Tab Delete Many
issue-categories-{issueCategoryId}-groups-{id}
Issue Category Custom Field Group Get OneIssue Category Custom Field Group Put One
issue-categories-{issueCategoryId}-groups-{groupId}/fields
Issue Category Custom Fields Get ManyIssue Category Custom Fields Get One
issue-categories-{issueCategoryId}-groups
Issue Category Custom Field Group Get ManyIssue Category Custom Field Group Post OneIssue Category Custom Field Group Delete Many
issue-categories-{issueCategoryId}-tabs-{id}
Issue Category Custom Field Tab Get OneIssue Category Custom Field Tab Put One
issue-categories-{issueCategoryId}-tabs
Issue Category Custom Field Tab Get ManyIssue Category Custom Field Tab Post OneIssue Category Custom Field Tab Delete Many
issue-types/fields-{id}
Issue Category All Custom Fields Get OneIssue Category All Custom Fields Put One
issue-types/fields
Issue Category All Custom Fields Get ManyIssue Category All Custom Fields Post OneIssue Category All Custom Fields Delete Many
issue-customfields/issuecategories/{issueCategoryId}/free-{id}
Issue Category Custom Fields Free Get OneIssue Category Custom Fields Free Put One
issue-customfields/issuecategories/{issueCategoryId}/free
Issue Category Custom Fields Free Get ManyIssue Category Custom Fields Free Post OneIssue Category Custom Fields Free Delete Many
jobs-{id}
Job Get OneJob Put One
jobs
Job Get ManyJob Post OneJob Delete ManyType Job Resources Get Many
locations-tree
Location Tree Get ManyLocation Tree Post OneLocation Tree Delete ManyLocation Tree Put One
locations-massupdate
Space Mass Update UpdateSpace Mass Update Put One
locations-{id}
Location Get OneLocation Put OneLocation Delete One
locations-barcode
Location Barcode Get Pdf StreamLocation Barcode Generate Codes
locations
Location Get ManyLocation Post OneLocation Delete ManyLocation Impact Get ManyLocation Get Assets LinkupsLocation Get By Object Id
markups-{id}
Markup Get OneMarkup Put One
markups
Markup Get ManyMarkup Post OneMarkup Delete Many
models/animations/raw
Model Animations Raw Get ManyModel Animations Raw Post OneModel Animations Raw Delete ManyModel Animations Raw Get One
viewer-folders
Model View Folder Get ManyModel View Folder Post OneModel View Folder Delete ManyModel View Folder Put One
viewer-models/threedimensional-{id}
Three Dimensional Get OneThree Dimensional Put One
viewer-models/threedimensional
Three Dimensional Get ManyThree Dimensional Post OneThree Dimensional Delete Many
viewer-views/{viewType}-{id}
View Get OneView Put OneView Delete
viewer-views/{viewType}
View Get ManyView Post OneView Delete Many
organizations
Organization Get ManyOrganization Delete ManyOrganization Get One
phases-{id}
Phases Get OnePhases Put One
phases
Phases Get ManyPhases Post OnePhases Delete Many
maintenances-{id}
Preventive Maintenance Get OnePreventive Maintenance Put One
maintenances
Preventive Maintenance Get ManyPreventive Maintenance Post OnePreventive Maintenance Delete ManyPreventive Maintenance Get Calendar
roles-{roleId}-members
Project Role Member Get ManyProject Role Member Post OneProject Role Member Delete Many
roles-{roleId}-users-{id}-download
Role Users DownloadRole Users Download Head
roles-{roleId}-users-{id}
Role Users Get OneRole Users Put OneRole Users Delete OneRole Users Put Stream
roles-{roleId}-users
Role Users Get ManyRole Users Post OneRole Users Delete ManyRole Users Post Stream
roles-{roleId}-permissions-{id}-download
Role Permissions DownloadRole Permissions Download Head
roles-{roleId}-permissions-{id}
Role Permissions Get OneRole Permissions Put OneRole Permissions Delete OneRole Permissions Put Stream
roles-{roleId}-permissions
Role Permissions Get ManyRole Permissions Post OneRole Permissions Delete ManyRole Permissions Post Stream
roles-{id}
Role Get OneRole Put One
roles
Role Get ManyRole Post OneRole Delete Many
remote/rds-archive
Rds Archive Get ManyRds Archive Post One
remote/rds-{rdsId}/variables
Rds Variable Get ManyRds Variable Get One
remote/rds
Rds Sync Get ManyRds Sync Get One
rds-{rdsid}-devices/{deviceId}-retrievetags
Retrieve Remote Tags Get Root TagsRetrieve Remote Tags Get Folder Tags
rds-{rdsid}-devices/{deviceId}-retrievefolders
Retrieve Remote Tags Get Root FoldersRetrieve Remote Tags Get Folder Folders
rds-{rdsid}-devices/{deviceId}
Retrieve Remote Tags Get Many
rds-{rdsid}-remotedevices-{id}
Remote Devices Get OneRemote Devices Put OneRemote Devices Delete One
rds-{rdsid}-remotedevices
Remote Devices Get ManyRemote Devices Post OneRemote Devices Get OneRemote Devices Test
rds-{rdsid}
Remote Connetors Get Many
rds-{id}
Rds Get OneRds Put OneRds Delete One
rds
Rds Get ManyRds Post OneRds Delete ManyRds Variable Mass Update UpdateRds Test
sensors-panels-{id}
Sensor Panel Get OneSensor Panel Put One
sensors-panels-templates-{id}
Sensor Panel Template Get OneSensor Panel Template Put One
sensors-panels-templates
Sensor Panel Template Get ManySensor Panel Template Post OneSensor Panel Template Delete Many
sensors-panels
Sensor Panel Get ManySensor Panel Post OneSensor Panel Delete ManySensor Panel Create Panel
sensors
Sensor Rds Var Get Sensor Panel Value
simulations-{id}
Simulation Get OneSimulation Put One
simulations-import-{id}
Simulation Import Get OneSimulation Import Put One
simulations-import
Simulation Import Get ManySimulation Import Post OneSimulation Import Delete Many
simulations-{simulationId}/rdsvars
Simulation Rds Var Get ManySimulation Rds Var Get One
simulations
Simulation Get ManySimulation Post OneSimulation Delete Many
types-{typeId}-assemblies-{id}
Type Assembly Get OneType Assembly Put OneType Assembly Delete One
types-{typeId}-assemblies-{assemblyId}/items-{id}
Type Assembly Item Get OneType Assembly Item Put OneType Assembly Item Delete One
types-{typeId}-assemblies-{assemblyId}/items
Type Assembly Item Get ManyType Assembly Item Post One
types-{typeId}-assemblies
Type Assembly Get ManyType Assembly Post One
types-{typeId}-jobs-{jobId}/tasks-{id}
Type Job Task Get OneType Job Task Put One
types-{typeId}-jobs-{jobId}/tasks
Type Job Task Get ManyType Job Task Put ModelsType Job Task Post One
types-{typeId}-jobs-{id}
Type Job Get OneType Job Put One
types-{typeId}-jobs
Type Job Get ManyType Job Post One
types-{typeId}-spares-{id}-download
Type Spare DownloadType Spare Download Head
types-{typeId}-spares-{id}
Type Spare Get OneType Spare Put OneType Spare Delete OneType Spare Put Stream
types-{typeId}-spares
Type Spare Get ManyType Spare Post OneType Spare Delete ManyType Spare Post Stream
types-massupdate
Type Mass Update UpdateType Mass Update Put One
types-{id}
Type Get OneType Put OneType Delete One
types
Type Get ManyType Post OneType Delete ManySpare Category Get ManyType Assign DesignerType Assign ContractorType Assign SpecificationType Assign Major AttributeType Unassign StandardType MergeType Get By Object Id
stages-{id}
Stage Get OneStage Put One
stages
Stage Get ManyStage Post OneStage Delete ManyStage Get Create Permission Stages
statuses-{id}
Statuses Get OneStatuses Put One
statuses
Statuses Get ManyStatuses Post OneStatuses Delete Many
systems-{systemId}-subsystems-{id}-download
System Subsystems DownloadSystem Subsystems Download Head
systems-{systemId}-subsystems-{id}
System Subsystems Get OneSystem Subsystems Put OneSystem Subsystems Delete OneSystem Subsystems Put Stream
systems-{systemId}-subsystems
System Subsystems Get ManySystem Subsystems Post OneSystem Subsystems Delete ManySystem Subsystems Post Stream
systems-{systemId}
System Affects Get Many
systems-massupdate
System Mass Update UpdateSystem Mass Update Put One
systems-{id}
System Get OneSystem Put OneSystem Delete One
systems
System Get ManySystem Post OneSystem Delete ManySystem Get By Object Id
tags
Tag Get ManyTag Get One
usergroups-{id}
User Group Get OneUser Group Put One
usergroups-{groupId}/users-{id}-download
User Group Members DownloadUser Group Members Download Head
usergroups-{groupId}/users-{id}
User Group Members Get OneUser Group Members Put OneUser Group Members Delete OneUser Group Members Put Stream
usergroups-{groupId}/users
User Group Members Get ManyUser Group Members Post OneUser Group Members Delete ManyUser Group Members Post Stream
usergroups
User Group Get ManyUser Group Post OneUser Group Delete Many
currentuser
Current User DetailsUser Permission Get Many
workorders/notifications-{id}
Work Order Notification Get OneWork Order Notification Put One
workorders/notifications-by
Work Order Notification Batch Create By UsersWork Order Notification Batch Create By Organizations
workorders/notifications
Work Order Notification Get ManyWork Order Notification Post OneWork Order Notification Delete ManyWork Order Notification Batch Create
regulations-statistics/organizations
Work Order Notification Organization Statistics Get ManyWork Order Notification Organization Statistics Get One
regulations
Regulation Report Download
zones-massupdate
Zone Mass Update UpdateZone Mass Update Put One
zones-{id}
Zone Get OneZone Put One
zones-{zoneId}/locations-{id}-download
Zone Location DownloadZone Location Download Head
zones-{zoneId}/locations-{id}
Zone Location Get OneZone Location Put OneZone Location Delete OneZone Location Put Stream
zones-{zoneId}/locations
Zone Location Get ManyZone Location Post OneZone Location Delete ManyZone Location Post Stream
zones
Zone Get ManyZone Post OneZone Delete ManyZone Get By Object Id
workflows-inspections-{id}-download
Workflow Metadata Inspection DownloadWorkflow Metadata Inspection Download Head
workflows-inspections-{id}
Workflow Metadata Inspection Get OneWorkflow Metadata Inspection Put OneWorkflow Metadata Inspection Delete OneWorkflow Metadata Inspection Get One Status Workflow MetadataWorkflow Metadata Inspection Get Many Status Workflow MetadataWorkflow Metadata Inspection Put Stream
workflows-inspections-move
Workflow Move Inspection Move WorkflowWorkflow Move Inspection Move Workflow Many
workflows-inspections
Workflow Metadata Inspection Get ManyWorkflow Metadata Inspection Post OneWorkflow Metadata Inspection Delete ManyWorkflow Metadata Inspection Post Stream
workflows-issues-{id}-download
Workflow Move Issue DownloadWorkflow Move Issue Download Head
workflows-issues-{id}
Workflow Move Issue Get OneWorkflow Move Issue Put OneWorkflow Move Issue Delete OneWorkflow Metadata Issue Get One Status Workflow MetadataWorkflow Metadata Issue Get Many Status Workflow MetadataWorkflow Move Issue Put Stream
workflows-issues-move
Workflow Move Issue Move WorkflowWorkflow Move Issue Move Workflow Many
workflows-issues
Workflow Move Issue Get ManyWorkflow Move Issue Post OneWorkflow Move Issue Delete ManyWorkflow Move Issue Post Stream
workflows-documents-{id}-download
Workflow Move Document DownloadWorkflow Move Document Download Head
workflows-documents-{id}
Workflow Move Document Get OneWorkflow Move Document Put OneWorkflow Move Document Delete OneWorkflow Metadata Document Get One Status Workflow MetadataWorkflow Metadata Document Get Many Status Workflow MetadataWorkflow Move Document Put Stream
workflows-documents-move
Workflow Move Document Move WorkflowWorkflow Move Document Move Workflow Many
workflows-documents
Workflow Move Document Get ManyWorkflow Move Document Post OneWorkflow Move Document Delete ManyWorkflow Move Document Post Stream
forms-{id}
Form Get OneForm Put OneForm Delete One
forms-{formId}-questions-{id}
Form Question Get OneForm Question Put OneForm Question Delete One
forms-{formId}-questions
Form Question Get ManyForm Question Post OneForm Question Delete Many
forms-{formId}-sections-{id}
Section Get OneSection Put OneSection Delete One
forms-{formId}-sections-{sectionId}/questions-{id}
Section Question Get OneSection Question Put OneSection Question Delete One
forms-{formId}-sections-{sectionId}/questions
Section Question Get ManySection Question Post OneSection Question Delete Many
forms-{formId}-sections
Section Get ManySection Post OneSection Delete Many
forms
Form Get ManyForm Post OneForm Delete Many
variables/{variableId}/displayvalue-{id}-download
Rds Variable Display Values DownloadRds Variable Display Values Download Head
variables/{variableId}/displayvalue-{id}
Rds Variable Display Values Get OneRds Variable Display Values Put OneRds Variable Display Values Delete OneRds Variable Display Values Put Stream
variables/{variableId}/displayvalue
Rds Variable Display Values Get ManyRds Variable Display Values Post OneRds Variable Display Values Delete ManyRds Variable Display Values Post Stream
{metadataType}/filters-{id}
Filter Set Get OneFilter Set Put OneFilter Set Delete One
{metadataType}/filters
Filter Set Get ManyFilter Set Post OneFilter Set Delete Many
users/{userId}/roles-{id}-download
User Roles DownloadUser Roles Download Head
users/{userId}/roles-{id}
User Roles Get OneUser Roles Put OneUser Roles Delete OneUser Roles Put Stream
users/{userId}/roles
User Roles Get ManyUser Roles Post OneUser Roles Delete ManyUser Roles Post Stream
clientprojects-{projectId}
Client Projects Get OneClient Projects Get Client Id
clientprojects-{id}
Client Projects Get OneClient Projects Put OneClient Projects Delete One
clientprojects
Client Projects Get ManyClient Projects Create ProjectClient Projects Delete Many
projects-{projectId}
Projects Get OneProjects Get Client Id
projects-{id}
Projects Get OneProjects Put OneProjects Delete One
projects
Projects Get Many
Role Member Get ManyType Job Task Resource Get ManyAsset Relations Get Asset Relations With Element Id
Walkinside Web Api
jobs-{id}
Gets a single job.Cancels a given job.
jobs
Gets all jobs.
projects-{id}-share
Unshare a project to one or multiple users.Share a project to one or multiple users.
projects-{id}
Deletes a Project.Gets Upload Attempt by Id.Upgrades a Project.Update Project Metadata.
projects-{projectId}-scenarios
Gets all scenarios.Get a scenario by project id and scenario id.
projects-{projectId}-viewpoints-{id}
Deletes a viewpoint.Updates a viewpoint.
projects-{projectId}-viewpoints
Gets all viewpoints.Creates a viewpoint.
projects
Get Project(s).Upload a Project.
users-{id}
Deletes a User.Gets user information using its identifier.Updates user information.
users-me
Gets User Information.Updates user information.
users
Gets all Users Information.Creates a UserGets a Jwt token for current user.
Get import attempt item by id.Gets all the user groups.
Session Report API
Get session reports for an HPC Charger. The array of session reports will be in items object in response.
Time Series API
timeSeries/chargers/{chargerId}
Get time series data of chargerGet time series data of a charger connector
RFID Management API
rfid
RFID Bulk ImportUpdate RFID Status
Aviation Data Hub API - Container Vertical
containertags-events
Query container events based on given search criteria.Post a container containerization event.Post a container movement event.Post a container registration event.Post a container security event.Post a container storage event.
containertags-{id}
Query bag tag by unique bag-tag-id provided by adh.Query container events based on given search criteria.
containertags
Query container tags based on given search criteria.
Aviation Data Hub API - Airport Vertical
airports
Query all airports.Insert (or overwrite) an airport.Query airports by IATA code.
Agent Management API
agents-{id}-boarding
Get boarding configurationOffboard agentGet boarding status
agents-{id}-dataSourceConfiguration
Get Data Source ConfigurationUpdate Data Source Configuration
agents-{id}
Get agentUpdate agentDelete agentGet online status
agents
Create agentGet agents
register
Register client.Update client information.
oauth
Grant an Access TokenReturns the JWT signing key currently employed by Agent IAMReturns the JWT signing keys currently and previously employed by Agent IAM
IoT TS Aggregates API
Get aggregated time series data for one aspect of an asset.
TcPCM Gateway API
api/v1-administration-users/{userName}
Fetch a user User by {userName}. Only allowed for admins.Either activated or deactivate Sam Auth User
api/v1-administration
Create or Update Sam Auth User
api/v1-Calculations
Export Calculations Export Calculations To Response ModelImport calculations from the given data table using an import configuration
api/v1-MasterData
Export Master Data Export Master Data To Response ModelImport Master Data Import Master Data From Request ModelCost Factor Life Time LookupExchange Rate Master Data Life Time Lookup By Unique NamesIncrease Rate Life Time LookupMaterial Price Life Time LookupOverhead Life Time Lookup
api/v1-Account
LogoutDelete RefreshToken
api/v1
Export Tool Calculation Cbd Export Cost Break DownReturns the profitability calculation report. Available since version 2406.0001Master Data Ping
Login to get the bearer token for protected endpoints
Data Flow Engine API
runtime/apps-{deploymentId}
Get the specific app by name.Gets the specific app instances.
runtime/apps
Get the list of runtime apps.
streams-definitions-{streamName}
Query stream by stream name.Delete a stream by stream name.
streams-definitions
List stream definitions.Define and deploy a new stream.
streams-deployments/{streamName}
Deploy a stream by stream name.Undeploy a stream by stream name.
streams
Get error status description of stream.
Default endpoint list.Get the list registered apps.
Data Lake API
objects
Query objects.delete an object.
deleteObjectsJobs-{id}
Fetch status and details of Delete Objects Job.Fetch errors of Delete Objects Job.
deleteObjectsJobs
Delete multiple objects in bulk.Fetch details of all the Delete Objects Jobs.
crossAccounts-{id}-accesses-{accessId}
Get a selected access for a selected cross accountUpdate a cross account accessDelete a cross account access.
crossAccounts-{id}-accesses
Create a cross account accessGet a list of cross account accesses
crossAccounts-{id}
Get details of selected cross accountUpdate a cross accountDelete cross account and corresponding accesses.
crossAccounts
Create a cross accountGet a list of cross accounts
accessTokenPermissions-{id}
Details of the write folder request for the given idDelete write permission on folder for the given id
accessTokenPermissions
Allows to give write premission on folder/pathList all folders having write premission
objectMetadata-{path}
Create/Update Metadata for the object.Get Metadata for the object.
objectMetadata
Get a list of metadata
objectEventSubscriptions-{id}
Update object event subscription by id.Delete object event subscription by id.Read object event subscription by id.
objectEventSubscriptions
Create object event subscription.List event subscriptions for the tenant or subtenant.
timeSeriesImportJobs-{id}
Retrieve status of time series bulk import job.Delete time series bulk import job by id.Retreive details of a time series bulk import job.
timeSeriesImportJobs
Creates a bulk import job of time series data into data lake.Query all time series bulk import jobs.
Generate signed URLs to upload an object.Generate signed URLs to download for single object.Generate AWS STS token
Protection Settings related APIs
api/v1/settings-zip
Get protection settings zip by deviceId in base64 formatGet protection settings zip by serialNumber in base64 format
api/v1/settings
Get protection settings by deviceIdGet protection settings by serialNumber
IoT File API
fileDeleteRules-{id}
get file delete rule (Time To Live - TTL) for the given iddelete file delete rules (Time To Live - TTL)
fileDeleteRules
create file delete rules (Time To Live - TTL)get file delete rules (Time To Live - TTL)
Data Exchange API
files-{id}-properties
Retrieves the file properties (metadata).Allows updating the properties (metadata) of an existing file.
files-{id}
Performs a file downloadAllows users to update a file's contents. If the file does not already exists already, or permissions are not sufficient, an error is returned.Performs a file deletion along with its associated metadata.
files
Performs a new file upload
directories-{id}-properties
Retreives updatable directory options, i.e the name and the parentId.Allows updating directory's properties.
directories-{id}
Performs a listing of all the accessible files and folders from current specified directory; recursive parameter can also be specified for this operationPerforms a directory deletion
directories
Creates a directory
Asset management related APIs
api/v1-assets-{id}
Get assetDelete assetUpdate asset
api/v1-assets
Get all assetsCreate an asset
api/v1-components-{id}
Get componentDelete componentUpdate component
api/v1-components
Create component
api/v1-stations-{id}
Get stationDelete stationUpdate station
api/v1-stations
Get stationsCreate station
Charging App
chargers-{chargerId}-connectors/{connectorId}-reservations
/chargers/:chargerId/connectors/:connectorId/reservations/chargers/:chargerId/connectors/:connectorId/reservations
chargers-{chargerId}-connectors/{connectorId}
/chargers/:chargerId/connectors/:connectorId/chargers/:chargerId/connectors/:connectorId/chargers/:chargerId/connectors/:connectorId/status/chargers/:chargerId/connectors/:connectorId/info/chargers/:chargerId/connectors/:connectorId/transactions
chargers-{chargerId}-transactions
/chargers/:chargerId/transactions/chargers/:chargerId/transactions/totalsuccess
chargers-{chargerId}
/chargers/:chargerId/chargers/:chargerId/chargers/:chargerId
chargers-{chaId}/connectors/{conId}/transactions
/chargers/:chaId/connectors/:conId/transactions/:trId/:op/chargers/:chaId/connectors/:conId/transactions/start
chargers
/chargers/chargers/chargers/onboarding-url/chargers/all/chargers
locations
/locations/locations/locations/:id/image
users
/users/me/users/refresh
variables-chargers-connectors
/variables/chargers/connectors/variables/chargers/connectors/:variableName
variables-chargers-{chargerId}-connectors/{connectorId}/{variableName}
/variables/chargers/:chargerId/connectors/:connectorId/:variableName/variables/chargers/:chargerId/connectors/:connectorId/:variableName/dateRange
variables-chargers-{chargerId}-{variableName}
/variables/chargers/:chargerId/:variableName/variables/chargers/:chargerId/:variableName/dateRange/variables/chargers/:chargerId/:variableName/values
variables-chargers
/variables/chargers
variables-buses
/variables/buses/variables/buses/:busID/:variableName
variables
/variables/notification
controls/chargers-{chargerId}
/controls/chargers/:chargerId/availability/:available/controls/chargers/:chargerId/connectors/:connectorId/availability/:available/controls/chargers/:chargerId/reboot
controls/chargers
/controls/chargers/:chargerID/command/:command
statistics-connectors
/statistics/connectors/status/statistics/connectors/statistics/statistics/connectors/info/statistics/connectors/availability/statistics/connectors/alarms/statistics/connectors/energy-delivered/statistics/connectors/power/statistics/connectors/energy/statistics/connectors/peakpower
statistics-chargers
/statistics/chargers/statistics/statistics/chargers/status/statistics/chargers/connection/statistics/chargers/connectivity/statistics/chargers/alarms
statistics
/statistics/transactions/termination/statistics/distance-driven
power-groups-site
/power-groups/site/power-groups/site
power-groups-{id}-algorithm-simulator
/power-groups/:id/algorithm-simulator/power-groups/:id/algorithm-simulator/:algorithm
power-groups-{id}
/power-groups/:id/power-groups/:id/power-groups/:id/power-groups/:id/power-elements/power-groups/:id/statistics/power
power-groups
/power-groups/power-groups
power-elements
/power-elements/power-elements/:id
notifications-event-triggers-{id}
/notifications/event-triggers/:id/notifications/event-triggers/:id/notifications/event-triggers/:id
notifications-event-triggers
/notifications/event-triggers/notifications/event-triggers
notifications-delivering-groups-{id}
/notifications/delivering-groups/:id/notifications/delivering-groups/:id/notifications/delivering-groups/:id
notifications-delivering-groups
/notifications/delivering-groups/notifications/delivering-groups
notifications-system
/notifications/system/notifications/system/errors/notifications/system/:id
notifications
/notifications/commandsStatus/charger/:chargerID/notifications/allNotificationTopicName/notifications/exportNotifications
buses-{id}
/buses/:id/buses/:id/buses/:id
buses
/buses/buses/buses/vehicleLinks/interimVehicleID/buses/vdv/connectionUrl
bus-operation-management-buses-{id}/timetable
/bus-operation-management/buses/:id/timetable/bus-operation-management/buses/:id/timetable/bus-operation-management/buses/:id/timetable/bus-operation-management/buses/:id/timetable
bus-operation-management-buses
/bus-operation-management/buses/timeTableEntryID/:timeTableEntryID/timetable
bus-operation-management
/bus-operation-management/scheduleCount/bus-operation-management/pre-conditioning/vehicleTimeSeries
optimalcharging
/optimalcharging/optimalchargingscope/optimalcharging/chargergroups/optimalcharging/:chargerGroupID/optimalcharging/energyPrices/optimalcharging/vehicleConnectorMapping/optimalcharging/energySiteParams
/transactions/smartTransactionActivity/reservations/:reservationId/algorithms/password/health-check
Reservations API
reservations
Create ReservationDelete Reservation
Energy API
medium-consumptions-{medium-consumption-id}
Get consumption values of medium consumptionGet costs of medium consumptionGet emissions of medium consumption
medium-consumptions
Get list of medium consumptions
IoT Time Series Bulk API
importJobs
Create bulk import job for importing time series dataRetrieve status of bulk import job
Retrieve time series data
Job Manager API
jobs-{id}
Retrieves the details regarding a job executionStops a job execution
jobs
Retrieves all the jobs executionsCreates a new job execution
schedules-{id}
Retrieves information about a scheduleRemoves a scheduleUpdates the status of the schedule to startedUpdates the status of the schedule to stopped
schedules
Retrieves a list with all schedules stored within the same tenantSchedules a job for execution specified by its model id and a cron string
Aviation Data Hub API - Baggage Vertical
bagtags-{id}
Query bag tag by unique bag-tag-id provided by adh.Query bag tags by flight segment for given bag tag id based on given search criteria.Query bag events for given bag tag id based on given search criteria.
bagtags-events
Query bag events based on given search criteria.Post a bag check in event.Post a bag cancel event.Post a bag change event.Post a bag containerization event.Post a bag tracking event.Post a bag screening event.DEPRECATED! Post a bag load into uld event.
bagtags
Query bag tags based on given search criteria.Query bag tags by flight segment based on given search criteria.
Force Terminate Connection
Disconnects charger
Fire API
devices
List DevicesList Events
List Locations
VDV-261-Interface API
Communicate VDV-261 parameters to the backend system
Carbon Footprint Indicator for Transportation API
calculate
calculate/calculate/jobScheduler/calculate/result
/data/upload
Battery Passport API
passports-{passport_id}-auditLogs
Get the transaction event history of a private passportGet the audit log of a certain event id.Get all attribute changes between two events.
passports-{passport_id}
Get private passport of a batteryUpdate a passport of a batteryDelete a private passport of a batteryRestores a passport of a battery
passports
Get a list of logged-in user's battery passports based on a specified status.Create a new passport in its entirety.Retrieve Battery Passport's public infoRetrieve Battery Passports Analytics Data
attribute-assignments-{assignmentId}
Get the details of a attribute assignment.Delete a attribute assignment
attribute-assignments
Retrieve Attribute Assignments.Create Attribute Assignments for data provider.Edit a assignment requests attribute value.
users
Get user by user nameAdd userUpdate usersends feedback to siemens
Resource Access Management API
policies-{id}
Get a policyUpdate a policy.Delete a policy.
policies
List all policies.Create a policy.
resourceGroups-{id}
Get a resource groupUpdate a resource group.Delete a resource group.
resourceGroups
List all resource groups.Create a resource group.
Data Contextualization - Data Contextualization APIs
dataLakes-{id}
Retrieves DataLake for a given DataLake IdUpdates base path for a given data lake type
dataLakes
Retrieves all DataLakesCreates a data lake record with a given data lake type and base path
iotDataRegistries
Retrieves an IoT Data Registry entriesAdd a new IoT Data Registry entry
dataRegistries-{id}
Retrieves Data Registry for a given registry idUpdates a Data RegistryDelete Data Registry by registry id
dataRegistries
Retrieves Data Registry entriesAdd a new Data Registry entry
dataTypes-{name}
Retrieves datatype for a given datatype nameDeletes custom datatype for a given datatype nameUpdates Datatype
dataTypes
Retrieves the custom datatypes for the current tenant.Custom datatype registration.
ingestJobStatus
Retrieve a list of jobIds.Retreive the job status.
dataIngestJobs
Ingest the provided files from Integrated Data Lake (IDL) to SDI.Retrieve a list of dataIngestJobs.Retrieve a specific dataIngestJob.
queries-{id}-executionJobs
Create execution job for dynamic query. If resultType is passed as FILE then executionJob attributes will overwrite query ["resultType", "resultDetails"] attributes values.There is soft limit of upto 10 number of parameters and aliases.Retrieve latest query results by query id
queries-{id}
Retrieve query by query idUpdate query by query idDelete query by query id
queries
Retrieve all queriesCreate new queries.
executionJobs-{id}
Retrieve job details by job idDelete job by job idRetrieve query results by job id
executionJobs
Retrieve all jobs
ontologies-{id}
Retrieve ontology.Delete ontology
ontologies
Retrieve all ontologies
ontologyJobs
Upload file and submit job for create/update ontologyRetrieve status of ontology creation/updation job
Generates the regular expression patterns for a given set of sample valuesUpload the given file for the current tenant. The input file must be less than 100MB in size.Ingest the provided file and start SDI's schema generation process.Search schema for ingested data.Infer semantic model based on two or more generated schemas. Currently it supports infer of upto 20 schemas.
COMOS - REST API
public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}-actions
Checks out a document.Undoes a document checkout.Checks in a documentPosts a specific revision.
public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}
Downloads a document based on document IdGets the revisons of a documentPosts a new redlining document for a specific revision.
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}-specs
Get the specifications for an objectUpdates the specifications for an objectValidates the specifications update
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}
Gets an objectDeletes the COMOS ObjectUpdates the given objectUpload a document under a device/document as a copy.Get Standard Table Values.
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-actions/bulk
Gets up to 1000 COMOS objects with given fields and specification information.Update object properties in hierarchyUpdates the given object
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects
Create new object under the existing object
public/api-projects/v1/dbs/{dbid}/projects-{projid}-overlays
Gets a collection of working overlaysCreate a working layer
public/api-projects/v1/dbs/{dbid}/projects-{projid}-languages
Gets a collection of supported languagesGets default project language
public/api-projects/v1/dbs/{dbid}/projects-{projid}
Performs revision step on given revision.Gets the object propertiesGets the data for a given query
public/api-projects/v1/dbs/{dbid}/projects
Gets a collection of projects
public/api-sessions/v1/sessions/actions
Creates a new session for the current userRemove the session based on session IdUpdate the specified session (heartbeat) passed
public/api
Provides discovery services for public apisEStamp the given pdf document.Get the details of the current user
Accounts API
customers/{customerId}
List Partitions for CustomerList Roles for Customer
Get the usergroups of caller
IoT TS Stream Registration API
registrations-{id}
Gets specific registration by id. This API should also be used to poll the status of a registration that has been submitted for validation. Dependening upon the validation, the status field in response may be VALIDATING/VALIDATED/BROKENDelete a registration by IdValidates specific regisration identified by Id. If status field in response is UPDATED/BROKEN/CREATED, user is advised to call this API. This is an async API. User is advised to poll for the status of the validation.
registrations
Gets all registrations for the tenantCreate a registration for specific assets and destination.
Identity Management API
Groups-{id}-members
List members of a groupAdd member to a groupDelete member from a group
Groups-{id}
Get groupUpdate group.Delete group
Groups-Mapping
Create external group mappingGet external group mapping
Groups
List all the groups of a tenant.Create groupUnmap external group mapping
Users-{id}
Get userUpdate userDelete user
Users
List of users of a tenant.Create userGet list of groups starting with the prefix "mdsp:" in which the user is a member.
provider/oauth/clients/{id}-secrets
Add new OAuth client's secretUpdate OAuth client's secretDelete old OAuth client's secret
provider/oauth/clients/{id}
Get OAuth client details
Updating the specific IDP with attribute mapping for external group
VFC API
projects-{id}-nodes
Read project's nodesCreate or replace flow nodesStarts a flow
projects-{id}
Read the projectRename a projectDelete a project
projects
Reads all projects of the specified userCreate new project
Rules Management API
rules-{ruleId}
Get rule by IDDelete a single ruleUpdate existing rulePatch existing rule
rules
Get a list of rulesAdd a new rule
IoT Time Series API
timeseries-{entityId}/{propertySetName}
Retrieve time series dataCreate or update time series dataCreate or merge time series dataDelete time series data
timeseries
Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.
Model Management API
models-{modelId}-versions-last
Downloads the last version payload or description of a modelUpdates the last version metadata information of a model, without allowing updates to the model payload itselfDeletes the last version of a model
models-{modelId}-versions-{versionId}
Retrieves the version payload or the version metadataDeletes the specified version of a model and the corresponding metadata
models-{modelId}-versions
Creates a new model versionRetrieves metadata of all versions of a model
models-{modelId}
Retrieves the model's textual description plus its last version details.Updates the model's metadata.Deletes a model, including all its versions
models
Retrieves a list with all models and algorithms.Uploads a model payload and the corresponding metadata.
Asset Management API
assettypes-{id}-fileAssignments/{key}
Add a new file assignment to an asset typeDeletes a file assignment from an asset type
assettypes-{id}
Create or Update an asset typePatch an asset typeRead an asset typeDelete an asset typeUpdate variables from an asset type
assettypes
List all asset types
aspecttypes-{id}
Create or Update an aspect typePatch an aspect typeRead an aspect typeDelete aspect typepatch aspect type variables
aspecttypes
List all aspect types
assets-{id}-fileAssignments/{key}
Save an file assignment to an assetDeletes a file assignment from an asset
assets-{id}-location
Create or Update location assigned to given assetDelete location assigned to given asset.
assets-{id}
Returns an asset.Update an assetPatch an assetDelete an assetMove an assetGet all variables of an assetGet all aspects of an asset
assets
List all available assetsCreate an assetReturns the root asset of the user.
files-{fileId}
Returns a file's metadata by its idUpdate a fileDelete a file.Returns a file by its id
files
Upload files to be used in Asset Management.Get metadata of uploaded files.
model/lock
Returns lock state of an asset model.Enable/disable lock state of an asset model.
List all links for available resources
Transaction Management API
transactions
Get transactionsGet info of a specific transaction
Aviation Data Hub - Asset Vertical
assets-{id}
Query asset by id.Delete a single asset.Patch asset by id.
assets
Search assets by search criteria.Change an asset.Create an asset.Delete all assets.
states-events
Search System State Events by Search Criteria.Post a system state event.
states
Search System States by Search Criteria.
meterings/events
Search System Metering Events by Search Criteria.Post a system metering event.
Tenant Management API
subtenants-{id}
Get a subtenant by idUpdate a subtenant by idDelete a subtenant by id
subtenants
Get subtenantsCreate a subtenant
legalConfigRegions-{regionId}
Update a region configuration of current tenantDelete legal information configuration of a region
legalConfigRegions
Get the complete legal information configuration of current tenantCreates tenant legal informationDelete the complete legal information configuration of current tenant
legalInfo
Get specific legal informationGet the region specific legal information for a given tenant with fallback logic to core tenant
tenantInfo-logo
Get tenant logoUpload tenant logoDelete tenant logo
tenantInfo
Get tenant infoPatch tenant infoGet tenant logo metadata
Get the region specific legal information for a given tenant without fallback logic
Commanding
deliveryJobs-{id}-commands
Get all the commands related with a delivery job.Get the command associated with a delivery job by command Id
deliveryJobs-{id}
Get the delivery job by IdDeletes a delivery job and its related commands.
deliveryJobs
Create a delivery jobGet all delivery jobs
Structure API
addresses-{addressId}
Get AddressUpdate AddressDelete Address
addresses
List AddressesCreate Address
locations-{locationId}-relationships
List/Get isPartOf relationships for the LocationList/Get hasParts relationships for the LocationList/Get hasAssets relationships for the Location
locations-{locationId}
Get LocationUpdate LocationDelete Location
locations
List LocationsCreate Location
assets/{assetId}/relationships/has-location
Update hasLocationList/Get hasLocations relationships for the Asset
equipment-{equipmentId}
Get EquipmentUpdate EquipmentDelete Equipment
equipment
List EquipmentsCreate Equipment
equipment-types
List EquipmentTypesGet EquipmentType
point-groups-{point-groupId}-points
List PointsCreate Point
point-groups-{point-groupId}-relationships/has-points
Add hasPointsDelete hasPoints
point-groups-{point-groupId}
Get PointGroupList PointValues
point-groups
List PointGroups
enums
List CountriesList TimeZonesList BuildingTypes
Building Geometry API
floorplans-{floorplanId}-floorplan-images
List Floorplan ImagesGet Floorplan Image
floorplans-{floorplanId}-geometry
List GeometryGet Geometry Center PointGet Geometry
floorplans-{floorplanId}
Get Floorplan
floorplans
List Floorplans
palettes-{paletteId}/symbols
List SymbolsGet Symbol Palette by ID
palettes
List Palettes
MindConnect MQTT API
caCertificates-{id}
Get CA CertificateDelete CA certificate.Verify CA certificateGet registration code
caCertificates
Upload CA certificateGet CA certificates
agentCertificates-{id}
Get Auto Generated Agent CertificateDelete Auto Generated Agent Certificate.
agentCertificates
Create Auto Generated Agent CertificateGet Auto Generated Agent Certificates
SDI - Semantic Data Interconnect APIs
dataLakes-{id}
Retrieves DataLake for a given DataLake IdUpdates base path for a given data lake type
dataLakes
Retrieves all DataLakesCreates a data lake record with a given data lake type and base path
iotDataRegistries
Retrieves an IoT Data Registry entriesAdd a new IoT Data Registry entry
dataRegistries-{id}
Retrieves Data Registry for a given registry idUpdates a Data Registry
dataRegistries
Retrieves Data Registry entriesAdd a new Data Registry entry
dataTypes-{name}
Retrieves datatype for a given datatype nameDeletes custom datatype for a given datatype nameUpdates Datatype
dataTypes
Retrieves the custom datatypes for the current tenant.Custom datatype registration.
ingestJobStatus
Retrieve a list of jobIds.Retreive the job status.
queries-{id}-executionJobs
Create execution job for dynamic query. There is soft limit of upto 10 number of parameters and aliases.Retrieve latest query results by query id
queries-{id}
Retrieve query by query idUpdate query by query idDelete query by query id
queries
Retrieve all queriesCreate new queries
executionJobs-{id}
Retrieve job details by job idDelete job by job idRetrieve query results by job id
executionJobs
Retrieve all jobs
ontologies-{id}
Retrieve ontology.Delete ontology
ontologies
Retrieve all ontologies
ontologyJobs
Upload file and submit job for create/update ontologyRetrieve status of ontology creation/updation job
Generates the regular expression patterns for a given set of sample valuesUpload the given file for the current tenant. The input file must be less than 100MB in size.Ingest the provided file and start SDI's schema generation process.Search schema for ingested data.Infer semantic model based on two or more generated schemas. Currently it supports infer of upto 20 schemas.
Message Broker API
subscribers/{id}/versions/{versionId}/topics/{topicId}
Create or update a subscription to the given topic.Get the subscription.Delete the given subscription.
Publishes new message to the given topic.
TASK-DATA-SERVICE
tasks
GET the outbound pcf requests of my company. it is recommended to make use of the "status" query parameter as follows /tasks/outboundPcfRequests?status=NEW,PCF_RECEIVED,COMPLETED.GET the incoming pcf requests of my company. it is recommended to make use of the "status" query parameter as follows /tasks/inboundPcfRequests?status=NEW,PCF_SHARED,COMPLETED.
Product Information Webservice
api-products/{productNumber}
get-obsolescenceget-delivery
api
get-api-key-details
Siemens Battery Passport API - Preliminary version from 06.02.2024
passports-public-{batterypassid}
Get battery passport public attributes by providing the batterypassid
passports-{batterypassid}
Get battery passport private attributes by providing the batterypassidUpdate public and private battery passport attributes by providing the batterypassidDelete battery passport by providing the batterypassidRestore
passports
Get list of a user's private passes given a certain stateCreate a new passport in its entirety
users
Get user by user nameAdd userUpdate user
Work Order Management API
workorders-{woHandle}
Retrieves work order for given work order handleUpdate work order for given work order handleDelete work order for given work order handlePartial update attachments work order for given work order handlePartial update associations work order for given work order handlePartial update externalSystems work order for given work order handle
workorders
Get list of work ordersCreate work orderGet list of work orders activitiesGet aggregate summary of workorder
Usage Transparency API
usagesJobs-{id}
Retrieve the status of processing of usages that were added by the job.Retrieve the processing errors related the usages added by the job.
usagesJobs
Add usages for one or more tenants, users and applications to UTS for storage and processing.Query status of processing for the jobs that added the usages.
Send application specific usages to UTS backend.Get monthly aggregated usages of rule enabled for consumer tenant.Get monthly aggregated usages for rule enabled to consumer tenants.
Ingestion API
Add Point Values
SiGREEN REST API
To create a credential for a specific product in a company in SiGREEN.It is to know whether a credential has been created or not.
PRODUCT-DATA-SERVICE
products-{productId}-bom
Create a Bill of Material for a product in SiGREENGet a list Bill of Material entries for a product in SiGREEN
products-{productId}
Offset your emissions.
products-{id}
Get an individual product details by product id.Update a product in SiGREEN.Get product PCF details by product id
products-identifierTypes-{id}
Delete an unused product identifier type for a company in SiGREEN.Update a product identifier type for a company in SiGREEN.
products-identifierTypes
Get product identifier types for a company in SiGREEN.Create a product identifier type for a company in SiGREEN.
products
Get all products of a company in SiGREEN.Upload a product to SiGREEN.Upload factory emissions for a product in SiGREEN. A bulk upload is also possible with this endpoint. The current limitation of bulk uploads is set to 10.
factories-{id}
Delete an unused factory for a company in SiGREEN.Update a factory for a company in SiGREEN.
factories
Get factories for a company in SiGREEN.Create a factory for a company in SiGREEN.
Event Management API
events-{eventId}
Get an eventUpdate an event
events
Create new eventQuery events
eventTypes-{eventTypeId}
Update an event typeGet an event typeDelete an event type
eventTypes
Create new event typeQuery event types
deleteEventsJobs
Create a delete events jobGet a delete events job
createEventsJobs
Create a create events jobGet a create events job
Info about the API
Activities API
Get activities
VPP Integration API
vppController/{siteId}-energyPrices
Write VPP energy pricesGet VPP energy prices
vppController/{siteId}
Get calculated power consumption
Case Management API
cases-{handle}-comments-{id}
Partial update comment for given case handleDelete case comment for given case handle
cases-{handle}-comments
Create comment for given case handleGet list of case comments for given case handle
cases-{handle}
Retrieves case for given case handleUpdate case for given case handleDelete case for given case handlePartial update attachments case for given case handlePartial update associations case for given case handlePartial update externalSystems case for given case handlePartial update tags of case for given case handle
cases
Get list of casesCreate caseGet list of cases activitiesGet list of cases commentsGet aggregate summary of case
Charger Status API
chargerStatus/chargers/{chargerId}
Get status of charger in ascending order, date range is restricted for only one day. If date range in request is not provided the latest data is returnedGet status of connector in ascending order, date range is restricted for only one day. If date range in request is not provided the latest data is returnedGet connectivity status of charger
Aviation Data Hub API - Flight Vertical
flightlegs-events
Query flight events based on given search criteria.Post a flight scheduled event.Post a flight aircraft allocation event.Post a flight time event.Post a flight cancelled event.Post a gate resource event.Post an aircraft parking position resource event.Post a terminal resource event.Post a check-in desks resource event.
flightlegs-{id}
Get flight leg by id.Get events for a specific flight leg.
flightlegs
Query flight legs based on given search criteria.
Operations API
devices-{deviceId}-events-{eventId}
Get EventLists event transition history
devices-{deviceId}-events
List Events
devices-{deviceId}
Get DevicePatch device attributesList Devices behind a GatewayList Points
devices
List DevicesCreate device
points/{pointId}-values
Get Point ValuesAdd Point Values
points/{pointId}-alarm-configurations-{alarmConfigurationId}
Get Alarm Configuration by IDUpdate Alarm Configuration by IDDelete Alarm Configuration by ID
points/{pointId}-alarm-configurations
List AlarmConfigurationsCreate new Alarm Configuration
points/{pointId}
Get PointUpdate Point - Set Value
locations
List LocationsGet Location
Remote Command API
Send the OCPP command remotely to charger.
Analyze MyMachine /Condition API Documentation
measurements-{id}-results-{resultId}-graphData
Get the graphical data of friction for the given measurement id and the result id.Get the graphical data of stiffness for the given measurement id and the result id.Get the graphical data of backlash for the given measurement id and the result id.Get the graphical data for the given measurement id and the result id.Get the graphical data of equability for the given measurement id and the result id.Get the graphical data of frequency response for the given measurement id and the result id.
measurements-{id}-results-{resultId}
Get the result for the given measurement id and the result id.Get raw data of the the result for the given measurement id and the result id.
measurements-{id}-results
Get all results of the measurement
measurements-{id}
Get measurementGet the threshold for the given measurement id.
measurements
Get measurements
measurementGroups
Get measurement groupsGet measurement group
Railigent X - Asset Feature API
v1/fleets-{fleetId}-assets
Retrieve information for all assets of a specific fleet.Retrieve information for a specific asset of a specific fleet.
v1/fleets-{fleetId}
Retrieve information about a specific eligible fleet of assets.
v1/fleets
Retrieve information about all eligible fleets of assets.
OAuth Authorization Server
Client Credentials GrantToken keys endpoint
Remote Services API
tenants-{id}
Retrieve a tenantDelete a tenant
tenants
Create a new tenantList all tenants
organizations-{id}
Retrieve an organizationDelete an organizationList owners of an organizationList an organization's ownership historyList appointed owners for an organizationAdd a user as an owner to an organizationRemove a user's organization owner status from an organizationUpdate an organization's name
organizations
Create a new organizationList all organizations
users-{id}
Retrieve a userDelete a userGet organizations a user has access toGet a user's roles in an organizationGet a user's all grants in an organizationUpdate a user's first and last nameUpdate a user's companyUpdate a user's countryActivate a user's accountSuspend a user's account
users
Create a new userList all users
external-users-{id}
Retrieve an external user referralRescind the referral of an external userAdmit a pending external userRevoke an admitted external userReject a referred external user
external-users
Refer an external user to an organizationList all external usersList all external user referrals audit recordsRevoke all admitted external usersReject all external users by their status
user-groups-{id}
Retrieve a usergroupDelete a usergroupList all users in a usergroupUpdate a usergroup's nameAdd a user to a usergroupRemove a user from a usergroup
user-groups
Create a new usergroupList all usergroups
products-{id}
Retrieve a product nodeDelete a product nodeUpdate a product's nameMove product from a parent to anotherCopy product from a parent to another
products
Create a new product nodeList all product nodes
nodes-{id}
Retrieve a nodeDelete a nodeUpdate a node's nameMove a node to another parent
nodes
Create a new nodeList all nodes
sites-{id}
Retrieve a siteDelete a siteUpdate a site's nameUpdate a site's contact emailUpdate a site's timezoneUpdate a site's countryMove a site to another parent
sites
Create a new siteList all sites
connectors-{id}
Retrieve a connectorDelete a connectorUpdate connector's nameUpdate connector's descriptionEnforce permission for connectorDo not require a permission for connectorSet idle timeout configuration to be infiniteUpdate connector's idle timeout configurationUpdate connector's parameters
connectors
Create a new connectorList all connectors
user-grants-{id}
Retrieve a user grantDelete a user grant
user-grants
Create a new user grantList all user grants
user-group-grants-{id}
Retrieve a usergroup grantDelete a usergroup grant
user-group-grants
Create a new usergroup grantList all usergroup grants
Retrieve a user session infoList all countries
Notification API
multicastSMSNotificationJobs-{id}
Shows status of an sms job.Shows detailed delivery information of an sms job.
multicastSMSNotificationJobs
Sends an SMS notification to specified recipients.Shows a list of all sms notification jobs.
emailNotificationJobs-{id}
Shows the status of an email job.Shows email delivery status per recipient.
emailNotificationJobs
Create an email job to send emails with attachments.Shows a list of email notification jobs.
multicastEmailNotificationJobs-{id}
Shows status of an email job.Shows email delivery status per recipient.
multicastEmailNotificationJobs
Sends an email notification to specified recipients with an option to attach files.
emailEncryptionCertificates-{email}
Upload a new email encryption certificate for the specified recipient email.Fetch the email encryption certificate corresponding to the specified recipient email.Update the specified recipient's email encryption certificate.Delete the email encryption certificate for the specified recipient email.
emailEncryptionCertificates
Get a list of email encryption certificates.
bouncedRecipients
Get all the recipients to whom the email delivery failed/bounced.Delete recipient email from bounced recipient list.
multicastPushNotificationJobs
Sends a push notification to selected mobile app instances.Shows a list of push notification jobsShows the status of a push notification job.
mobileApps-{id}-instances-{instanceId}
Edit a specific mobile app instance registration. Push notification token detail is masked and not displayed in response owing to security reasons.Delete a specific mobile app instance registration.
mobileApps-{id}-instances
Registers a new mobile installation instance with a registered mobile app.Show all registered mobile app instances for a given mobile app. Push notification token detail is masked and not displayed in response owing to security reasons.
mobileApps-{id}
Edit a registered mobile app. App Configuration details are masked and not displayed in response owing to security reasons.Deregister an existing registered mobile app.
mobileApps
Register a new mobile app.Show all registered apps for a tenant. App Configuration details are masked and not displayed in response owing to security reasons.
templates-{id}
Shows the details of the specified template.Update the specified template definition.Delete the specific template definition.Download the template file for review
templates
Create a template for notification.Shows a list of templates.
DepotFinity Token Management API
access Token
Introduction
Technical Token Manager API
Issues technical token to access customer IoT data.Issues multiple technical tokens to access customer IoT data.Provides list of user tenants provisioned to an application.
SieSmart B2B API
common-countries
Returns all countriesReturns all regions for the introducers country id.
common
Get the job titles available for the current introducer country.Get the legal forms available for creation of a customer manually.Get the lessors available for the current introducer.Get the loan purposes available.Get the professions available for the current introducer country.Get the person titles available for the current introducer country.Get manageable offices of the current introducer.Get the sales contacts manageable by the current user.Get the iac codes available for the selected office.
introducer/equipment-suppliers
Get the equipment suppliers available for the introducer.Add a equipment supplier to the introducer.
calculation
Performs a finance calculation and returns the result.Returns the configuration to perform a calculation.
proposals-{proposal-id}-assets-{asset-id}
Updates the asset of the proposal.Deletes and removes the asset from the proposal.
proposals-{proposal-id}-assets
Returns all assets of the proposal.Adds a new asset to the proposal.
proposals-{proposal-id}-customer-invoice-address
Set the customer invoice address.Creates a new customer invoice address.
proposals-{proposal-id}-customer-delivery-address
Set the customer delivery address.Creates a new customer delivery address.
proposals-{proposal-id}-customer
Sets the proposal's customer.Updates the proposal's customer.Gets proposal customer's addresses.Gets proposal customer's boardmembers.Updates the proposal's customer invoice contact.
proposals-{proposal-id}-decision-request
Request credit decision.Cancel the credit decision request.
proposals-{proposal-id}-decision
Check the pre-condition whether it's allowed to create a decision request.
proposals-{proposal-id}-documents-uploaded-documents
Get the uploaded documents available for a proposal.Upload document to DMS.
proposals-{proposal-id}-documents-signing
Request a signature for the given document.Download the signed document.Delete pending signing request.Refresh and return the signing request's status.
proposals-{proposal-id}-documents
Get the documents available for a proposal.Get the document types available for the selected proposal.Download selected documents of the proposal.
proposals-{proposal-id}-loans-{loan-id}
Updates the loan of the proposal.Removes the loan from the proposal.
proposals-{proposal-id}-loans
Get the loans available for this proposal.Adds a new loan to the proposal.
proposals-{proposal-id}-upgrades
Get the upgrade agreements available for this proposal.Adds a new upgrade agreement to the proposal.Removes the upgrade agreement from the proposal.
proposals-{proposal-id}-equipment-suppliers
Get all assigned equipment suppliers.Adds a new equipment supplier to the proposal.Remove the equipment supplier.
proposals-{proposal-id}
Returns a single proposal.Expires the proposal.Amend the proposal.Performs a finance calculation, adds it to the proposal and returns the updated proposal.
proposals
Creates a new proposal.Finds proposals matching given query parameters.
notifications-endpoint
Update customer notification endpoint URL.Register customer notification endpoint URL.Remove registration of customer notification endpoint URL.
notifications-{notification-uuid}
Get proposal data belonging to a notification subscriptiondelete notification subscription for a specific proposal
notifications
Subscribe for notification about events for a proposal.
Get customers matching the query parameters.
Physical Identity and Access Management API
identities-{id}
To update an identity dataTo delete an identity
identities
Get identitiesTo create an identity
privileges-assignments/of-holder/{holderId}
To retrieve assigned privileges for an identityAssign priviliges to an Identity
privileges
To retrieve available privileges from Security Manager
PROCUREMENT-DATA-SERVICE
suppliers-identifierTypes-{id}
Update a supplier identifier type for a company in SiGREEN.Delete an unused supplier identifier type for a company in SiGREEN.
suppliers-identifierTypes
API to create supplier identifier type of a company in SiGREEN.Get supplier identifier types for a company in SiGREEN.
suppliers-{id}
Update a supplier by supplier Id in SiGREEN.Get supplier by id for one company in SiGREEN
suppliers
Create a supplier in SiGREENGet all suppliers for one company in SiGREEN.
components-identifierTypes-{id}
Update a component identifier type for a company in SiGREEN.Delete an unused component identifier type for a company in SiGREEN.
components-identifierTypes
Create a component identifier type for a company in SiGREEN.Get component identifier types for a company in SiGREEN.
components-{id}-secondaryData-{secondaryDataId}
Update component secondary data by secondary data id.Get component secondary data by secondary data id
components-{id}-secondaryData
Create secondary data with component.Get all component secondary data for component in SiGREEN
components-{id}-linkSuppliers-{componentSupplierLinkId}
Get linked suppliers by componentSupplierLinkId with componentUpdate location/share/secondary data/supplier product id by component supplier idDelete link between component and supplier
components-{id}-linkSuppliers
Link suppliers and secondary data with componentGet all linked suppliers with component
components-{id}
Update component details by idGet component details by idGet an export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.
components
Create component in SiGREENGet all components for one company in SiGREENGET the PCF data for your components in SiGREEN.Get an aggregated export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.
Charger Control API
Set external rate limit of a charger group from external systems the power sharing across different types of loads can be prioritized dynamically and allocated.Get list of power groups.
MindConnect API
dataPointMappings-{id}
Get a mapping by idDelete a mapping
dataPointMappings
Create single mappingGet mappings.
eventMappings-{id}
Get a mapping by idUpdate a mappingDelete a mapping
eventMappings
Create single mappingGet mappings
diagnosticActivations-{id}
Update status of Diagnostic Activation Gets a diagnostic activation. Deletes a diagnostic activation Get a diagnostic messages of specific activation resource
diagnosticActivations
Creates a new diagnostic activation Gets diagnostic activations
recoverableRecords-{id}
Delete a recoverable recordRe-play a recoverable recordGet download link of record payload.
recoverableRecords
Get all recoverable records
/exchangeGet Diagnostic Information
Lifecycle Twin API
categories-{id}
Categories Get OneCategories Put One
categories-{entityType}-groups-{id}
Category All Groups Get OneCategory All Groups Put One
categories-{entityType}-groups
Category All Groups Get ManyCategory All Groups Post OneCategory All Groups Delete Many
categories-{entityType}-tabs-{id}
Category All Tabs Get OneCategory All Tabs Put One
categories-{entityType}-tabs
Category All Tabs Get ManyCategory All Tabs Post OneCategory All Tabs Delete Many
categories-{categoryId}/{entityType}-groups-{groupId}/fields
Category Field Get ManyCategory Field Get One
categories-{categoryId}/{entityType}-groups-{id}
Category Field Group Get OneCategory Field Group Put One
categories-{categoryId}/{entityType}-groups
Category Field Group Get ManyCategory Field Group Post OneCategory Field Group Delete Many
categories-{categoryId}/{entityType}-tabs-{id}
Category Tab Get OneCategory Tab Put One
categories-{categoryId}/{entityType}-tabs
Category Tab Get ManyCategory Tab Post OneCategory Tab Delete Many
categories
Categories Get ManyCategories Post OneCategories Delete ManyAll Category Status Get Many
assets-massupdate
Asset Mass Update UpdateAsset Mass Update Put One
assets-{assetId}-varslinkup
Asset Rds Vars Get ManyAsset Rds Vars Delete Many
assets-{assetId}-systems-{id}
Asset Systems Put OneAsset Systems Delete One
assets-{assetId}-systems
Asset Systems Get ManyAsset Systems Delete Many
assets-{assetId}-relations-{id}
Asset Relations Put OneAsset Relations Delete One
assets-{assetId}-relations
Asset Relations Get ManyAsset Relations Post ManyAsset Relations Delete Many
assets-{assetId}
Asset Rds Archive Get ManyAsset Rds Vars Not Linked Get Many
assets-{id}
Asset Get OneAsset Put OneAsset Delete One
assets
Asset Get ManyAsset Post OneAsset Delete ManyAsset Get Asset FieldsAsset Rename ManyAsset Get By Object Id
bcf-issues-archive-{id}-download
BCF Archive DownloadBCF Archive Download Head
bcf-issues-archive
BCF Archive Post Stream
bcf-issues-{issueId}/comments-{id}-download
BCF Comment DownloadBCF Comment Download Head
bcf-issues-{issueId}/comments-{id}
BCF Comment Get OneBCF Comment Put OneBCF Comment Delete OneBCF Comment Put Stream
bcf-issues-{issueId}/comments
BCF Comment Get ManyBCF Comment Post OneBCF Comment Delete ManyBCF Comment Post Stream
bcf-issues
BCF Import Post Stream
bcf-comments/{id}
BCF Comment Delete CommentBCF Comment Update Comment
bimconnectors-{id}
BIM Connector Get OneBIM Connector Put One
bimconnectors-{connectorId}/{entityType}/mappings-{mappingId}/rules
BIM Connector Field Mapping Rule Post OneBIM Connector Field Mapping Rule Delete ManyBIM Connector Field Mapping Rule Put One
bimconnectors-{connectorId}/{entityType}/mappings
BIM Connector Field Mappings Get ManyBIM Connector Field Mappings Post OneBIM Connector Field Mappings Delete ManyBIM Connector Field Mappings Put One
bimconnectors
BIM Connector Get ManyBIM Connector Post One
{entitytype}-categories/fields-{id}
Category Custom Fields Get OneCategory Custom Fields Put One
{entitytype}-categories/fields
Category Custom Fields Get ManyCategory Custom Fields Post OneCategory Custom Fields Delete Many
{entitytype}-groups-{id}
Entity Type Custom Field Group Get OneEntity Type Custom Field Group Put One
{entitytype}-groups
Entity Type Custom Field Group Get ManyEntity Type Custom Field Group Post OneEntity Type Custom Field Group Delete Many
{entitytype}-customfields-{id}
Entity Type Custom Fields Get OneEntity Type Custom Fields Put One
{entitytype}-customfields-categories/{categoryId}/free-{id}
Entity Type Custom Fields Free Get OneEntity Type Custom Fields Free Put One
{entitytype}-customfields-categories/{categoryId}/free
Entity Type Custom Fields Free Get ManyEntity Type Custom Fields Free Post OneEntity Type Custom Fields Free Delete Many
{entitytype}-customfields-free-{id}
Entity Type Custom Fields Free At All Get OneEntity Type Custom Fields Free At All Put One
{entitytype}-customfields-free
Entity Type Custom Fields Free At All Get ManyEntity Type Custom Fields Free At All Post OneEntity Type Custom Fields Free At All Delete Many
{entitytype}-customfields
Entity Type Custom Fields Get ManyEntity Type Custom Fields Post OneEntity Type Custom Fields Delete Many
{entitytype}-tabs-{id}
Entity Type Custom Tab Get OneEntity Type Custom Tab Put One
{entitytype}-tabs
Entity Type Custom Tab Get ManyEntity Type Custom Tab Post OneEntity Type Custom Tab Delete Many
clients-{clientName}/organizations-{id}
Client Organization Get OneClient Organization Post One For Organization
clients-{clientName}/organizations
Client Organization Get ManyClient Organization Post OneClient Organization Delete Many
clients-{clientname}/users-{id}
Client User Get OneClient User Post One Model
clients-{clientname}/users
Client User Get ManyClient User Post OneClient User Delete Many
customfields-{id}
Custom Field Definition Get OneCustom Field Definition Put One
customfields-instances-{id}
Custom Field Definition Instance Get OneCustom Field Definition Instance Put One
customfields-instances
Custom Field Definition Instance Get ManyCustom Field Definition Instance Post OneCustom Field Definition Instance Delete ManyCustom Field Definition Instance Post Instances Custom Fields File
customfields-types-{id}
Field Type Get OneField Type Put One
customfields-types-{fieldTypeId}/values-{id}-download
Field Type Values DownloadField Type Values Download Head
customfields-types-{fieldTypeId}/values-{id}
Field Type Values Get OneField Type Values Put OneField Type Values Delete OneField Type Values Put Stream
customfields-types-{fieldTypeId}/values
Field Type Values Get ManyField Type Values Post OneField Type Values Delete ManyField Type Values Post Stream
customfields-types
Field Type Get ManyField Type Post OneField Type Delete Many
customfields
Custom Field Definition Get ManyCustom Field Definition Post OneCustom Field Definition Delete ManyCustom Field Definition Post Definitions File
{entityType}-{baseEntityId}/tabs/{groupId}/values
Custom Tab Value Get ManyCustom Tab Value Post OneCustom Tab Value Delete Many
{entityType}-categories-{id}
Entity Categories Get OneEntity Categories Put One
{entityType}-categories-free-{id}
Entity Categories Free Get OneEntity Categories Free Put One
{entityType}-categories-free
Entity Categories Free Get ManyEntity Categories Free Post OneEntity Categories Free Delete Many
{entityType}-categories
Entity Categories Get ManyEntity Categories Post OneEntity Categories Delete Many
{entityType}-groups/{groupId}/fields
Entity Type Group Fields Get ManyEntity Type Group Fields Get One
{entityType}-tabs/{groupId}/fields
Entity Type Group Fields Get ManyEntity Type Group Fields Get One
disciplines-{id}
Discipline Get OneDiscipline Put One
disciplines
Discipline Get ManyDiscipline Post OneDiscipline Delete Many
folders/{folderId}/documents-autoname
Document Autonaming Get Document AutonameDocument Autonaming Get Document Autoname ValidatedDocument Autonaming Get Document Required FieldsDocument Autonaming Get Is Autoname
documents-{documentId}-files/actual-{id}
Document File Version Get OneDocument File Version Put One
documents-{documentId}-files/actual
Document File Version Get ManyDocument File Version Post OneDocument File Version Delete Many
documents-{documentId}
Document History Get ManyDocument Tags Get ManyFolder Statuses Statistics Get Many
documents-fromsurvey-{id}
Document From Survey Get OneDocument From Survey Put One
documents-fromsurvey
Document From Survey Get ManyDocument From Survey Post OneDocument From Survey Delete ManyDocument From Survey Create From Survey
documents-massupdate
Document Mass Update UpdateDocument Mass Update Put One
documents-{folderId}/alldocuments-{id}
Folder All Documents Get OneFolder All Documents Put One
documents-{folderId}/alldocuments
Folder All Documents Get ManyFolder All Documents Post OneFolder All Documents Delete Many
documents-{id}
Document Get OneDocument Put OneDocument DownloadDocument Put Stream
documents-export-statuses/{taskId}
Document Export Get File Compression StatusDocument Export Cancel Compression
documents-export
Document Export Get Compressed File
documents
Document Get ManyDocument Post OneDocument Delete ManyDocument Autonaming Fields Get ManyDocument File Import Cancel ImportDocument Post Stream
documenttypes-{id}
Document Type Get OneDocument Type Put One
documenttypes
Document Type Get ManyDocument Type Post OneDocument Type Delete Many
document-types-groups-{id}
Document Type All Custom Field Group Get OneDocument Type All Custom Field Group Put One
document-types-groups
Document Type All Custom Field Group Get ManyDocument Type All Custom Field Group Post OneDocument Type All Custom Field Group Delete Many
document-types-fields-{id}
Document Type All Custom Fields Get OneDocument Type All Custom Fields Put One
document-types-fields
Document Type All Custom Fields Get ManyDocument Type All Custom Fields Post OneDocument Type All Custom Fields Delete Many
document-types-tabs-{id}
Document Type All Custom Field Tab Get OneDocument Type All Custom Field Tab Put One
document-types-tabs
Document Type All Custom Field Tab Get ManyDocument Type All Custom Field Tab Post OneDocument Type All Custom Field Tab Delete Many
document-types-{documentTypeId}-groups-{id}
Document Type Custom Field Group Get OneDocument Type Custom Field Group Put One
document-types-{documentTypeId}-groups-{groupId}/fields
Document Type Custom Fields Get ManyDocument Type Custom Fields Get One
document-types-{documentTypeId}-groups
Document Type Custom Field Group Get ManyDocument Type Custom Field Group Post OneDocument Type Custom Field Group Delete Many
document-types-{documentTypeId}-tabs-{id}
Document Type Custom Field Tab Get OneDocument Type Custom Field Tab Put One
document-types-{documentTypeId}-tabs
Document Type Custom Field Tab Get ManyDocument Type Custom Field Tab Post OneDocument Type Custom Field Tab Delete Many
document-types-{id}
Entity Document Types Get OneEntity Document Types Put One
document-types-free-{id}
Entity Document Types Free Get OneEntity Document Types Free Put One
document-types-free
Entity Document Types Free Get ManyEntity Document Types Free Post OneEntity Document Types Free Delete Many
document-types
Entity Document Types Get ManyEntity Document Types Post OneEntity Document Types Delete Many
document-customfields/types/{documentTypeId}/free-{id}
Document Type Custom Fields Free Get OneDocument Type Custom Fields Free Put One
document-customfields/types/{documentTypeId}/free
Document Type Custom Fields Free Get ManyDocument Type Custom Fields Free Post OneDocument Type Custom Fields Free Delete Many
entities-{ownerId}-files-{id}
Owned File Get OneOwned File Put One
entities-{ownerId}-files
Owned File Get ManyOwned File Post OneOwned File Delete ManyOwned File Renew File
entities-{ownerId}-documents-{id}
Entity Document Get OneEntity Document Put OneEntity Document DownloadEntity Document Put Stream
entities-{ownerId}-documents
Entity Document Get ManyEntity Document Post OneEntity Document Delete ManyEntity Document Post Stream
entities
Entity Type Permission Get Many
facilities-{id}
Facility Get OneFacility Put One
facilities-massupdate
Facility Mass Update UpdateFacility Mass Update Put One
facilities
Facility Get ManyFacility Post OneFacility Delete ManyFacility Affects Get ManyFacility Get By Object Id
files-common-{id}
File Get OneFile Put OneFile Get Thumbnails
files-common
File Get ManyFile Post OneFile Delete Many
files-{fileId}-zip-{id}
File Zip Get OneFile Zip Put One
files-{fileId}-zip-{name}/download
File Zip Get File From ZipFile Zip Get File From Zip Head
files-{fileId}-zip
File Zip Get ManyFile Zip Post OneFile Zip Delete Many
files-{fileId}
File Versions Get Many
files
File Compare Compare
floors-{id}
Floor Get OneFloor Put OneFloor Delete One
floors-massupdate
Floor Mass Update UpdateFloor Mass Update Put One
floors-{floorId}/spaces-assessment
Space Assessment Get ManySpace Assessment Get OneSpace Assessment Get Spaces And Last Assessment
floors-{floorId}/spaces-{id}-download
Floor Spaces DownloadFloor Spaces Download Head
floors-{floorId}/spaces-{id}
Floor Spaces Get OneFloor Spaces Put OneFloor Spaces Delete OneFloor Spaces Put Stream
floors-{floorId}/spaces
Floor Spaces Get ManyFloor Spaces Post OneFloor Spaces Delete ManyFloor Unassigned Spaces Get ManyFloor Spaces Post Stream
floors
Floor Get ManyFloor Post OneFloor Delete ManyFloor Category Get ManyFloor Get By Object Id
formprocesses-{formprocessId}/questions
Form Process Answer Get ManyForm Process Answer Post OneForm Process Answer Delete ManyForm Process Answer Put One
formprocesses
Form Process Get ManyForm Process Post OneForm Process Get One
inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files-{id}
Inspection File Get OneInspection File Put One
inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files
Inspection File Get ManyInspection File Post OneInspection File Delete Many
inspections-{inspectionId}-questions-{id}
Common Question Answer Get OneCommon Question Answer Put OneCommon Question Answer Delete One
inspections-{inspectionId}-questions
Common Question Answer Get ManyCommon Question Answer Post OneCommon Question Answer Delete Many
inspections-{inspectionId}-forms/{formId}-questions-{id}
Form Question Answer Get OneForm Question Answer Put OneForm Question Answer Delete One
inspections-{inspectionId}-forms/{formId}-questions
Form Question Answer Get ManyForm Question Answer Post OneForm Question Answer Delete Many
inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions-{id}
Section Question Answer Get OneSection Question Answer Put OneSection Question Answer Delete One
inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions
Section Question Answer Get ManySection Question Answer Post OneSection Question Answer Delete Many
inspections-{inspectionId}
Inspection Get Sections
inspections-types-{id}
Inspection Type Get OneInspection Type Put One
inspections-types
Inspection Type Get ManyInspection Type Post OneInspection Type Delete ManyInspection Workflow Roles Get Many
inspections
Inspection Get ManyInspection Delete ManyInspection Put One
issues-{issueId}
Issue Assign To User Get ManyIssue Log Get Many
issues-types-{id}
Issue Category Get OneIssue Category Put One
issues-types
Issue Category Get ManyIssue Category Post OneIssue Category Delete ManyIssue Category Get Create Permission Categories
issues-organizations
Issues Organizations Get ManyIssues Organizations Delete ManyIssues Organizations Get One
issues-{categoryId}/workflows-{id}
Issue Workflow Get OneIssue Workflow Put One
issues-{categoryId}/workflows
Issue Workflow Get ManyIssue Workflow Post OneIssue Workflow Delete Many
issues-{id}
Work Order Get OneWork Order Put OneWork Order Delete One
issues-printform-{id}-download
Issue Print Form DownloadIssue Print Form Download Head
issues-printform-{id}
Issue Print Form Get OneIssue Print Form Put OneIssue Print Form Delete OneIssue Print Form Put Stream
issues-printform
Issue Print Form DownloadIssue Print Form Post OneIssue Print Form Delete ManyIssue Print Form Post Stream
issues
Work Order Get ManyWork Order Delete ManyIssue Priority Get ManyWork Order New Closed Statistics Get ManyWork Order Attach FileWork Order Detach File
issuecategories-{id}
Issue Categories Get OneIssue Categories Put One
issuecategories-free-{id}
Issue Categories Free Get OneIssue Categories Free Put One
issuecategories-free
Issue Categories Free Get ManyIssue Categories Free Post OneIssue Categories Free Delete Many
issuecategories
Issue Categories Get ManyIssue Categories Post OneIssue Categories Delete Many
issue-categories-groups-{id}
Issue Category All Custom Field Group Get OneIssue Category All Custom Field Group Put One
issue-categories-groups
Issue Category All Custom Field Group Get ManyIssue Category All Custom Field Group Post OneIssue Category All Custom Field Group Delete Many
issue-categories-tabs-{id}
Issue Category All Custom Field Tab Get OneIssue Category All Custom Field Tab Put One
issue-categories-tabs
Issue Category All Custom Field Tab Get ManyIssue Category All Custom Field Tab Post OneIssue Category All Custom Field Tab Delete Many
issue-categories-{issueCategoryId}-groups-{id}
Issue Category Custom Field Group Get OneIssue Category Custom Field Group Put One
issue-categories-{issueCategoryId}-groups-{groupId}/fields
Issue Category Custom Fields Get ManyIssue Category Custom Fields Get One
issue-categories-{issueCategoryId}-groups
Issue Category Custom Field Group Get ManyIssue Category Custom Field Group Post OneIssue Category Custom Field Group Delete Many
issue-categories-{issueCategoryId}-tabs-{id}
Issue Category Custom Field Tab Get OneIssue Category Custom Field Tab Put One
issue-categories-{issueCategoryId}-tabs
Issue Category Custom Field Tab Get ManyIssue Category Custom Field Tab Post OneIssue Category Custom Field Tab Delete Many
issue-types/fields-{id}
Issue Category All Custom Fields Get OneIssue Category All Custom Fields Put One
issue-types/fields
Issue Category All Custom Fields Get ManyIssue Category All Custom Fields Post OneIssue Category All Custom Fields Delete Many
issue-customfields/issuecategories/{issueCategoryId}/free-{id}
Issue Category Custom Fields Free Get OneIssue Category Custom Fields Free Put One
issue-customfields/issuecategories/{issueCategoryId}/free
Issue Category Custom Fields Free Get ManyIssue Category Custom Fields Free Post OneIssue Category Custom Fields Free Delete Many
jobs-{id}
Job Get OneJob Put One
jobs
Job Get ManyJob Post OneJob Delete ManyType Job Resources Get Many
locations-tree
Location Tree Get ManyLocation Tree Post OneLocation Tree Delete ManyLocation Tree Put One
locations-massupdate
Space Mass Update UpdateSpace Mass Update Put One
locations-{id}
Location Get OneLocation Put OneLocation Delete One
locations-barcode
Location Barcode Get Pdf StreamLocation Barcode Generate Codes
locations
Location Get ManyLocation Post OneLocation Delete ManyLocation Impact Get ManyLocation Get Assets LinkupsLocation Get By Object Id
markups-{id}
Markup Get OneMarkup Put One
markups
Markup Get ManyMarkup Post OneMarkup Delete Many
models/animations/raw
Model Animations Raw Get ManyModel Animations Raw Post OneModel Animations Raw Delete ManyModel Animations Raw Get One
viewer-folders
Model View Folder Get ManyModel View Folder Post OneModel View Folder Delete ManyModel View Folder Put One
viewer-models/threedimensional-{id}
Three Dimensional Get OneThree Dimensional Put One
viewer-models/threedimensional
Three Dimensional Get ManyThree Dimensional Post OneThree Dimensional Delete Many
viewer-views/{viewType}-{id}
View Get OneView Put OneView Delete
viewer-views/{viewType}
View Get ManyView Post OneView Delete Many
organizations
Organization Get ManyOrganization Delete ManyOrganization Get One
phases-{id}
Phases Get OnePhases Put One
phases
Phases Get ManyPhases Post OnePhases Delete Many
maintenances-{id}
Preventive Maintenance Get OnePreventive Maintenance Put One
maintenances
Preventive Maintenance Get ManyPreventive Maintenance Post OnePreventive Maintenance Delete ManyPreventive Maintenance Get Calendar
roles-{roleId}-members
Project Role Member Get ManyProject Role Member Post OneProject Role Member Delete Many
roles-{roleId}-users-{id}-download
Role Users DownloadRole Users Download Head
roles-{roleId}-users-{id}
Role Users Get OneRole Users Put OneRole Users Delete OneRole Users Put Stream
roles-{roleId}-users
Role Users Get ManyRole Users Post OneRole Users Delete ManyRole Users Post Stream
roles-{roleId}-permissions-{id}-download
Role Permissions DownloadRole Permissions Download Head
roles-{roleId}-permissions-{id}
Role Permissions Get OneRole Permissions Put OneRole Permissions Delete OneRole Permissions Put Stream
roles-{roleId}-permissions
Role Permissions Get ManyRole Permissions Post OneRole Permissions Delete ManyRole Permissions Post Stream
roles-{id}
Role Get OneRole Put One
roles
Role Get ManyRole Post OneRole Delete Many
remote/rds-archive
Rds Archive Get ManyRds Archive Post One
remote/rds-{rdsId}/variables
Rds Variable Get ManyRds Variable Get One
remote/rds
Rds Sync Get ManyRds Sync Get One
rds-{rdsid}-devices/{deviceId}-retrievetags
Retrieve Remote Tags Get Root TagsRetrieve Remote Tags Get Folder Tags
rds-{rdsid}-devices/{deviceId}-retrievefolders
Retrieve Remote Tags Get Root FoldersRetrieve Remote Tags Get Folder Folders
rds-{rdsid}-devices/{deviceId}
Retrieve Remote Tags Get Many
rds-{rdsid}-remotedevices-{id}
Remote Devices Get OneRemote Devices Put OneRemote Devices Delete One
rds-{rdsid}-remotedevices
Remote Devices Get ManyRemote Devices Post OneRemote Devices Get OneRemote Devices Test
rds-{rdsid}
Remote Connetors Get Many
rds-{id}
Rds Get OneRds Put OneRds Delete One
rds
Rds Get ManyRds Post OneRds Delete ManyRds Variable Mass Update UpdateRds Test
sensors-panels-{id}
Sensor Panel Get OneSensor Panel Put One
sensors-panels-templates-{id}
Sensor Panel Template Get OneSensor Panel Template Put One
sensors-panels-templates
Sensor Panel Template Get ManySensor Panel Template Post OneSensor Panel Template Delete Many
sensors-panels
Sensor Panel Get ManySensor Panel Post OneSensor Panel Delete ManySensor Panel Create Panel
sensors
Sensor Rds Var Get Sensor Panel Value
simulations-{id}
Simulation Get OneSimulation Put One
simulations-import-{id}
Simulation Import Get OneSimulation Import Put One
simulations-import
Simulation Import Get ManySimulation Import Post OneSimulation Import Delete Many
simulations-{simulationId}/rdsvars
Simulation Rds Var Get ManySimulation Rds Var Get One
simulations
Simulation Get ManySimulation Post OneSimulation Delete Many
types-{typeId}-assemblies-{id}
Type Assembly Get OneType Assembly Put OneType Assembly Delete One
types-{typeId}-assemblies-{assemblyId}/items-{id}
Type Assembly Item Get OneType Assembly Item Put OneType Assembly Item Delete One
types-{typeId}-assemblies-{assemblyId}/items
Type Assembly Item Get ManyType Assembly Item Post One
types-{typeId}-assemblies
Type Assembly Get ManyType Assembly Post One
types-{typeId}-jobs-{jobId}/tasks-{id}
Type Job Task Get OneType Job Task Put One
types-{typeId}-jobs-{jobId}/tasks
Type Job Task Get ManyType Job Task Put ModelsType Job Task Post One
types-{typeId}-jobs-{id}
Type Job Get OneType Job Put One
types-{typeId}-jobs
Type Job Get ManyType Job Post One
types-{typeId}-spares-{id}-download
Type Spare DownloadType Spare Download Head
types-{typeId}-spares-{id}
Type Spare Get OneType Spare Put OneType Spare Delete OneType Spare Put Stream
types-{typeId}-spares
Type Spare Get ManyType Spare Post OneType Spare Delete ManyType Spare Post Stream
types-massupdate
Type Mass Update UpdateType Mass Update Put One
types-{id}
Type Get OneType Put OneType Delete One
types
Type Get ManyType Post OneType Delete ManySpare Category Get ManyType Assign DesignerType Assign ContractorType Assign SpecificationType Assign Major AttributeType Unassign StandardType MergeType Get By Object Id
stages-{id}
Stage Get OneStage Put One
stages
Stage Get ManyStage Post OneStage Delete ManyStage Get Create Permission Stages
statuses-{id}
Statuses Get OneStatuses Put One
statuses
Statuses Get ManyStatuses Post OneStatuses Delete Many
systems-{systemId}-subsystems-{id}-download
System Subsystems DownloadSystem Subsystems Download Head
systems-{systemId}-subsystems-{id}
System Subsystems Get OneSystem Subsystems Put OneSystem Subsystems Delete OneSystem Subsystems Put Stream
systems-{systemId}-subsystems
System Subsystems Get ManySystem Subsystems Post OneSystem Subsystems Delete ManySystem Subsystems Post Stream
systems-{systemId}
System Affects Get Many
systems-massupdate
System Mass Update UpdateSystem Mass Update Put One
systems-{id}
System Get OneSystem Put OneSystem Delete One
systems
System Get ManySystem Post OneSystem Delete ManySystem Get By Object Id
tags
Tag Get ManyTag Get One
usergroups-{id}
User Group Get OneUser Group Put One
usergroups-{groupId}/users-{id}-download
User Group Members DownloadUser Group Members Download Head
usergroups-{groupId}/users-{id}
User Group Members Get OneUser Group Members Put OneUser Group Members Delete OneUser Group Members Put Stream
usergroups-{groupId}/users
User Group Members Get ManyUser Group Members Post OneUser Group Members Delete ManyUser Group Members Post Stream
usergroups
User Group Get ManyUser Group Post OneUser Group Delete Many
currentuser
Current User DetailsUser Permission Get Many
workorders/notifications-{id}
Work Order Notification Get OneWork Order Notification Put One
workorders/notifications-by
Work Order Notification Batch Create By UsersWork Order Notification Batch Create By Organizations
workorders/notifications
Work Order Notification Get ManyWork Order Notification Post OneWork Order Notification Delete ManyWork Order Notification Batch Create
regulations-statistics/organizations
Work Order Notification Organization Statistics Get ManyWork Order Notification Organization Statistics Get One
regulations
Regulation Report Download
zones-massupdate
Zone Mass Update UpdateZone Mass Update Put One
zones-{id}
Zone Get OneZone Put One
zones-{zoneId}/locations-{id}-download
Zone Location DownloadZone Location Download Head
zones-{zoneId}/locations-{id}
Zone Location Get OneZone Location Put OneZone Location Delete OneZone Location Put Stream
zones-{zoneId}/locations
Zone Location Get ManyZone Location Post OneZone Location Delete ManyZone Location Post Stream
zones
Zone Get ManyZone Post OneZone Delete ManyZone Get By Object Id
workflows-inspections-{id}-download
Workflow Metadata Inspection DownloadWorkflow Metadata Inspection Download Head
workflows-inspections-{id}
Workflow Metadata Inspection Get OneWorkflow Metadata Inspection Put OneWorkflow Metadata Inspection Delete OneWorkflow Metadata Inspection Get One Status Workflow MetadataWorkflow Metadata Inspection Get Many Status Workflow MetadataWorkflow Metadata Inspection Put Stream
workflows-inspections-move
Workflow Move Inspection Move WorkflowWorkflow Move Inspection Move Workflow Many
workflows-inspections
Workflow Metadata Inspection Get ManyWorkflow Metadata Inspection Post OneWorkflow Metadata Inspection Delete ManyWorkflow Metadata Inspection Post Stream
workflows-issues-{id}-download
Workflow Move Issue DownloadWorkflow Move Issue Download Head
workflows-issues-{id}
Workflow Move Issue Get OneWorkflow Move Issue Put OneWorkflow Move Issue Delete OneWorkflow Metadata Issue Get One Status Workflow MetadataWorkflow Metadata Issue Get Many Status Workflow MetadataWorkflow Move Issue Put Stream
workflows-issues-move
Workflow Move Issue Move WorkflowWorkflow Move Issue Move Workflow Many
workflows-issues
Workflow Move Issue Get ManyWorkflow Move Issue Post OneWorkflow Move Issue Delete ManyWorkflow Move Issue Post Stream
workflows-documents-{id}-download
Workflow Move Document DownloadWorkflow Move Document Download Head
workflows-documents-{id}
Workflow Move Document Get OneWorkflow Move Document Put OneWorkflow Move Document Delete OneWorkflow Metadata Document Get One Status Workflow MetadataWorkflow Metadata Document Get Many Status Workflow MetadataWorkflow Move Document Put Stream
workflows-documents-move
Workflow Move Document Move WorkflowWorkflow Move Document Move Workflow Many
workflows-documents
Workflow Move Document Get ManyWorkflow Move Document Post OneWorkflow Move Document Delete ManyWorkflow Move Document Post Stream
forms-{id}
Form Get OneForm Put OneForm Delete One
forms-{formId}-questions-{id}
Form Question Get OneForm Question Put OneForm Question Delete One
forms-{formId}-questions
Form Question Get ManyForm Question Post OneForm Question Delete Many
forms-{formId}-sections-{id}
Section Get OneSection Put OneSection Delete One
forms-{formId}-sections-{sectionId}/questions-{id}
Section Question Get OneSection Question Put OneSection Question Delete One
forms-{formId}-sections-{sectionId}/questions
Section Question Get ManySection Question Post OneSection Question Delete Many
forms-{formId}-sections
Section Get ManySection Post OneSection Delete Many
forms
Form Get ManyForm Post OneForm Delete Many
variables/{variableId}/displayvalue-{id}-download
Rds Variable Display Values DownloadRds Variable Display Values Download Head
variables/{variableId}/displayvalue-{id}
Rds Variable Display Values Get OneRds Variable Display Values Put OneRds Variable Display Values Delete OneRds Variable Display Values Put Stream
variables/{variableId}/displayvalue
Rds Variable Display Values Get ManyRds Variable Display Values Post OneRds Variable Display Values Delete ManyRds Variable Display Values Post Stream
{metadataType}/filters-{id}
Filter Set Get OneFilter Set Put OneFilter Set Delete One
{metadataType}/filters
Filter Set Get ManyFilter Set Post OneFilter Set Delete Many
users/{userId}/roles-{id}-download
User Roles DownloadUser Roles Download Head
users/{userId}/roles-{id}
User Roles Get OneUser Roles Put OneUser Roles Delete OneUser Roles Put Stream
users/{userId}/roles
User Roles Get ManyUser Roles Post OneUser Roles Delete ManyUser Roles Post Stream
clientprojects-{projectId}
Client Projects Get OneClient Projects Get Client Id
clientprojects-{id}
Client Projects Get OneClient Projects Put OneClient Projects Delete One
clientprojects
Client Projects Get ManyClient Projects Create ProjectClient Projects Delete Many
projects-{projectId}
Projects Get OneProjects Get Client Id
projects-{id}
Projects Get OneProjects Put OneProjects Delete One
projects
Projects Get Many
Role Member Get ManyType Job Task Resource Get ManyAsset Relations Get Asset Relations With Element Id
Walkinside Web Api
jobs-{id}
Gets a single job.Cancels a given job.
jobs
Gets all jobs.
projects-{id}-share
Unshare a project to one or multiple users.Share a project to one or multiple users.
projects-{id}
Deletes a Project.Gets Upload Attempt by Id.Upgrades a Project.Update Project Metadata.
projects-{projectId}-scenarios
Gets all scenarios.Get a scenario by project id and scenario id.
projects-{projectId}-viewpoints-{id}
Deletes a viewpoint.Updates a viewpoint.
projects-{projectId}-viewpoints
Gets all viewpoints.Creates a viewpoint.
projects
Get Project(s).Upload a Project.
users-{id}
Deletes a User.Gets user information using its identifier.Updates user information.
users-me
Gets User Information.Updates user information.
users
Gets all Users Information.Creates a UserGets a Jwt token for current user.
Get import attempt item by id.Gets all the user groups.
Session Report API
Get session reports for an HPC Charger. The array of session reports will be in items object in response.
Time Series API
timeSeries/chargers/{chargerId}
Get time series data of chargerGet time series data of a charger connector
RFID Management API
rfid
RFID Bulk ImportUpdate RFID Status
Aviation Data Hub API - Container Vertical
containertags-events
Query container events based on given search criteria.Post a container containerization event.Post a container movement event.Post a container registration event.Post a container security event.Post a container storage event.
containertags-{id}
Query bag tag by unique bag-tag-id provided by adh.Query container events based on given search criteria.
containertags
Query container tags based on given search criteria.
Aviation Data Hub API - Airport Vertical
airports
Query all airports.Insert (or overwrite) an airport.Query airports by IATA code.
Agent Management API
agents-{id}-boarding
Get boarding configurationOffboard agentGet boarding status
agents-{id}-dataSourceConfiguration
Get Data Source ConfigurationUpdate Data Source Configuration
agents-{id}
Get agentUpdate agentDelete agentGet online status
agents
Create agentGet agents
register
Register client.Update client information.
oauth
Grant an Access TokenReturns the JWT signing key currently employed by Agent IAMReturns the JWT signing keys currently and previously employed by Agent IAM
IoT TS Aggregates API
Get aggregated time series data for one aspect of an asset.
TcPCM Gateway API
api/v1-administration-users/{userName}
Fetch a user User by {userName}. Only allowed for admins.Either activated or deactivate Sam Auth User
api/v1-administration
Create or Update Sam Auth User
api/v1-Calculations
Export Calculations Export Calculations To Response ModelImport calculations from the given data table using an import configuration
api/v1-MasterData
Export Master Data Export Master Data To Response ModelImport Master Data Import Master Data From Request ModelCost Factor Life Time LookupExchange Rate Master Data Life Time Lookup By Unique NamesIncrease Rate Life Time LookupMaterial Price Life Time LookupOverhead Life Time Lookup
api/v1-Account
LogoutDelete RefreshToken
api/v1
Export Tool Calculation Cbd Export Cost Break DownReturns the profitability calculation report. Available since version 2406.0001Master Data Ping
Login to get the bearer token for protected endpoints
Data Flow Engine API
runtime/apps-{deploymentId}
Get the specific app by name.Gets the specific app instances.
runtime/apps
Get the list of runtime apps.
streams-definitions-{streamName}
Query stream by stream name.Delete a stream by stream name.
streams-definitions
List stream definitions.Define and deploy a new stream.
streams-deployments/{streamName}
Deploy a stream by stream name.Undeploy a stream by stream name.
streams
Get error status description of stream.
Default endpoint list.Get the list registered apps.
Data Lake API
objects
Query objects.delete an object.
deleteObjectsJobs-{id}
Fetch status and details of Delete Objects Job.Fetch errors of Delete Objects Job.
deleteObjectsJobs
Delete multiple objects in bulk.Fetch details of all the Delete Objects Jobs.
crossAccounts-{id}-accesses-{accessId}
Get a selected access for a selected cross accountUpdate a cross account accessDelete a cross account access.
crossAccounts-{id}-accesses
Create a cross account accessGet a list of cross account accesses
crossAccounts-{id}
Get details of selected cross accountUpdate a cross accountDelete cross account and corresponding accesses.
crossAccounts
Create a cross accountGet a list of cross accounts
accessTokenPermissions-{id}
Details of the write folder request for the given idDelete write permission on folder for the given id
accessTokenPermissions
Allows to give write premission on folder/pathList all folders having write premission
objectMetadata-{path}
Create/Update Metadata for the object.Get Metadata for the object.
objectMetadata
Get a list of metadata
objectEventSubscriptions-{id}
Update object event subscription by id.Delete object event subscription by id.Read object event subscription by id.
objectEventSubscriptions
Create object event subscription.List event subscriptions for the tenant or subtenant.
timeSeriesImportJobs-{id}
Retrieve status of time series bulk import job.Delete time series bulk import job by id.Retreive details of a time series bulk import job.
timeSeriesImportJobs
Creates a bulk import job of time series data into data lake.Query all time series bulk import jobs.
Generate signed URLs to upload an object.Generate signed URLs to download for single object.Generate AWS STS token
Protection Settings related APIs
api/v1/settings-zip
Get protection settings zip by deviceId in base64 formatGet protection settings zip by serialNumber in base64 format
api/v1/settings
Get protection settings by deviceIdGet protection settings by serialNumber
IoT File API
fileDeleteRules-{id}
get file delete rule (Time To Live - TTL) for the given iddelete file delete rules (Time To Live - TTL)
fileDeleteRules
create file delete rules (Time To Live - TTL)get file delete rules (Time To Live - TTL)
Data Exchange API
files-{id}-properties
Retrieves the file properties (metadata).Allows updating the properties (metadata) of an existing file.
files-{id}
Performs a file downloadAllows users to update a file's contents. If the file does not already exists already, or permissions are not sufficient, an error is returned.Performs a file deletion along with its associated metadata.
files
Performs a new file upload
directories-{id}-properties
Retreives updatable directory options, i.e the name and the parentId.Allows updating directory's properties.
directories-{id}
Performs a listing of all the accessible files and folders from current specified directory; recursive parameter can also be specified for this operationPerforms a directory deletion
directories
Creates a directory
Asset management related APIs
api/v1-assets-{id}
Get assetDelete assetUpdate asset
api/v1-assets
Get all assetsCreate an asset
api/v1-components-{id}
Get componentDelete componentUpdate component
api/v1-components
Create component
api/v1-stations-{id}
Get stationDelete stationUpdate station
api/v1-stations
Get stationsCreate station
Charging App
chargers-{chargerId}-connectors/{connectorId}-reservations
/chargers/:chargerId/connectors/:connectorId/reservations/chargers/:chargerId/connectors/:connectorId/reservations
chargers-{chargerId}-connectors/{connectorId}
/chargers/:chargerId/connectors/:connectorId/chargers/:chargerId/connectors/:connectorId/chargers/:chargerId/connectors/:connectorId/status/chargers/:chargerId/connectors/:connectorId/info/chargers/:chargerId/connectors/:connectorId/transactions
chargers-{chargerId}-transactions
/chargers/:chargerId/transactions/chargers/:chargerId/transactions/totalsuccess
chargers-{chargerId}
/chargers/:chargerId/chargers/:chargerId/chargers/:chargerId
chargers-{chaId}/connectors/{conId}/transactions
/chargers/:chaId/connectors/:conId/transactions/:trId/:op/chargers/:chaId/connectors/:conId/transactions/start
chargers
/chargers/chargers/chargers/onboarding-url/chargers/all/chargers
locations
/locations/locations/locations/:id/image
users
/users/me/users/refresh
variables-chargers-connectors
/variables/chargers/connectors/variables/chargers/connectors/:variableName
variables-chargers-{chargerId}-connectors/{connectorId}/{variableName}
/variables/chargers/:chargerId/connectors/:connectorId/:variableName/variables/chargers/:chargerId/connectors/:connectorId/:variableName/dateRange
variables-chargers-{chargerId}-{variableName}
/variables/chargers/:chargerId/:variableName/variables/chargers/:chargerId/:variableName/dateRange/variables/chargers/:chargerId/:variableName/values
variables-chargers
/variables/chargers
variables-buses
/variables/buses/variables/buses/:busID/:variableName
variables
/variables/notification
controls/chargers-{chargerId}
/controls/chargers/:chargerId/availability/:available/controls/chargers/:chargerId/connectors/:connectorId/availability/:available/controls/chargers/:chargerId/reboot
controls/chargers
/controls/chargers/:chargerID/command/:command
statistics-connectors
/statistics/connectors/status/statistics/connectors/statistics/statistics/connectors/info/statistics/connectors/availability/statistics/connectors/alarms/statistics/connectors/energy-delivered/statistics/connectors/power/statistics/connectors/energy/statistics/connectors/peakpower
statistics-chargers
/statistics/chargers/statistics/statistics/chargers/status/statistics/chargers/connection/statistics/chargers/connectivity/statistics/chargers/alarms
statistics
/statistics/transactions/termination/statistics/distance-driven
power-groups-site
/power-groups/site/power-groups/site
power-groups-{id}-algorithm-simulator
/power-groups/:id/algorithm-simulator/power-groups/:id/algorithm-simulator/:algorithm
power-groups-{id}
/power-groups/:id/power-groups/:id/power-groups/:id/power-groups/:id/power-elements/power-groups/:id/statistics/power
power-groups
/power-groups/power-groups
power-elements
/power-elements/power-elements/:id
notifications-event-triggers-{id}
/notifications/event-triggers/:id/notifications/event-triggers/:id/notifications/event-triggers/:id
notifications-event-triggers
/notifications/event-triggers/notifications/event-triggers
notifications-delivering-groups-{id}
/notifications/delivering-groups/:id/notifications/delivering-groups/:id/notifications/delivering-groups/:id
notifications-delivering-groups
/notifications/delivering-groups/notifications/delivering-groups
notifications-system
/notifications/system/notifications/system/errors/notifications/system/:id
notifications
/notifications/commandsStatus/charger/:chargerID/notifications/allNotificationTopicName/notifications/exportNotifications
buses-{id}
/buses/:id/buses/:id/buses/:id
buses
/buses/buses/buses/vehicleLinks/interimVehicleID/buses/vdv/connectionUrl
bus-operation-management-buses-{id}/timetable
/bus-operation-management/buses/:id/timetable/bus-operation-management/buses/:id/timetable/bus-operation-management/buses/:id/timetable/bus-operation-management/buses/:id/timetable
bus-operation-management-buses
/bus-operation-management/buses/timeTableEntryID/:timeTableEntryID/timetable
bus-operation-management
/bus-operation-management/scheduleCount/bus-operation-management/pre-conditioning/vehicleTimeSeries
optimalcharging
/optimalcharging/optimalchargingscope/optimalcharging/chargergroups/optimalcharging/:chargerGroupID/optimalcharging/energyPrices/optimalcharging/vehicleConnectorMapping/optimalcharging/energySiteParams
/transactions/smartTransactionActivity/reservations/:reservationId/algorithms/password/health-check
Reservations API
reservations
Create ReservationDelete Reservation
Energy API
medium-consumptions-{medium-consumption-id}
Get consumption values of medium consumptionGet costs of medium consumptionGet emissions of medium consumption
medium-consumptions
Get list of medium consumptions
IoT Time Series Bulk API
importJobs
Create bulk import job for importing time series dataRetrieve status of bulk import job
Retrieve time series data
Job Manager API
jobs-{id}
Retrieves the details regarding a job executionStops a job execution
jobs
Retrieves all the jobs executionsCreates a new job execution
schedules-{id}
Retrieves information about a scheduleRemoves a scheduleUpdates the status of the schedule to startedUpdates the status of the schedule to stopped
schedules
Retrieves a list with all schedules stored within the same tenantSchedules a job for execution specified by its model id and a cron string
Aviation Data Hub API - Baggage Vertical
bagtags-{id}
Query bag tag by unique bag-tag-id provided by adh.Query bag tags by flight segment for given bag tag id based on given search criteria.Query bag events for given bag tag id based on given search criteria.
bagtags-events
Query bag events based on given search criteria.Post a bag check in event.Post a bag cancel event.Post a bag change event.Post a bag containerization event.Post a bag tracking event.Post a bag screening event.DEPRECATED! Post a bag load into uld event.
bagtags
Query bag tags based on given search criteria.Query bag tags by flight segment based on given search criteria.
Force Terminate Connection
Disconnects charger
Fire API
devices
List DevicesList Events
List Locations
VDV-261-Interface API
Communicate VDV-261 parameters to the backend system
Carbon Footprint Indicator for Transportation API
calculate
calculate/calculate/jobScheduler/calculate/result
/data/upload
Battery Passport API
passports-{passport_id}-auditLogs
Get the transaction event history of a private passportGet the audit log of a certain event id.Get all attribute changes between two events.
passports-{passport_id}
Get private passport of a batteryUpdate a passport of a batteryDelete a private passport of a batteryRestores a passport of a battery
passports
Get a list of logged-in user's battery passports based on a specified status.Create a new passport in its entirety.Retrieve Battery Passport's public infoRetrieve Battery Passports Analytics Data
attribute-assignments-{assignmentId}
Get the details of a attribute assignment.Delete a attribute assignment
attribute-assignments
Retrieve Attribute Assignments.Create Attribute Assignments for data provider.Edit a assignment requests attribute value.
users
Get user by user nameAdd userUpdate usersends feedback to siemens
Resource Access Management API
policies-{id}
Get a policyUpdate a policy.Delete a policy.
policies
List all policies.Create a policy.
resourceGroups-{id}
Get a resource groupUpdate a resource group.Delete a resource group.
resourceGroups
List all resource groups.Create a resource group.
Data Contextualization - Data Contextualization APIs
dataLakes-{id}
Retrieves DataLake for a given DataLake IdUpdates base path for a given data lake type
dataLakes
Retrieves all DataLakesCreates a data lake record with a given data lake type and base path
iotDataRegistries
Retrieves an IoT Data Registry entriesAdd a new IoT Data Registry entry
dataRegistries-{id}
Retrieves Data Registry for a given registry idUpdates a Data RegistryDelete Data Registry by registry id
dataRegistries
Retrieves Data Registry entriesAdd a new Data Registry entry
dataTypes-{name}
Retrieves datatype for a given datatype nameDeletes custom datatype for a given datatype nameUpdates Datatype
dataTypes
Retrieves the custom datatypes for the current tenant.Custom datatype registration.
ingestJobStatus
Retrieve a list of jobIds.Retreive the job status.
dataIngestJobs
Ingest the provided files from Integrated Data Lake (IDL) to SDI.Retrieve a list of dataIngestJobs.Retrieve a specific dataIngestJob.
queries-{id}-executionJobs
Create execution job for dynamic query. If resultType is passed as FILE then executionJob attributes will overwrite query ["resultType", "resultDetails"] attributes values.There is soft limit of upto 10 number of parameters and aliases.Retrieve latest query results by query id
queries-{id}
Retrieve query by query idUpdate query by query idDelete query by query id
queries
Retrieve all queriesCreate new queries.
executionJobs-{id}
Retrieve job details by job idDelete job by job idRetrieve query results by job id
executionJobs
Retrieve all jobs
ontologies-{id}
Retrieve ontology.Delete ontology
ontologies
Retrieve all ontologies
ontologyJobs
Upload file and submit job for create/update ontologyRetrieve status of ontology creation/updation job
Generates the regular expression patterns for a given set of sample valuesUpload the given file for the current tenant. The input file must be less than 100MB in size.Ingest the provided file and start SDI's schema generation process.Search schema for ingested data.Infer semantic model based on two or more generated schemas. Currently it supports infer of upto 20 schemas.
COMOS - REST API
public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}-actions
Checks out a document.Undoes a document checkout.Checks in a documentPosts a specific revision.
public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}
Downloads a document based on document IdGets the revisons of a documentPosts a new redlining document for a specific revision.
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}-specs
Get the specifications for an objectUpdates the specifications for an objectValidates the specifications update
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}
Gets an objectDeletes the COMOS ObjectUpdates the given objectUpload a document under a device/document as a copy.Get Standard Table Values.
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-actions/bulk
Gets up to 1000 COMOS objects with given fields and specification information.Update object properties in hierarchyUpdates the given object
public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects
Create new object under the existing object
public/api-projects/v1/dbs/{dbid}/projects-{projid}-overlays
Gets a collection of working overlaysCreate a working layer
public/api-projects/v1/dbs/{dbid}/projects-{projid}-languages
Gets a collection of supported languagesGets default project language
public/api-projects/v1/dbs/{dbid}/projects-{projid}
Performs revision step on given revision.Gets the object propertiesGets the data for a given query
public/api-projects/v1/dbs/{dbid}/projects
Gets a collection of projects
public/api-sessions/v1/sessions/actions
Creates a new session for the current userRemove the session based on session IdUpdate the specified session (heartbeat) passed
public/api
Provides discovery services for public apisEStamp the given pdf document.Get the details of the current user
Accounts API
customers/{customerId}
List Partitions for CustomerList Roles for Customer
Get the usergroups of caller
IoT TS Stream Registration API
registrations-{id}
Gets specific registration by id. This API should also be used to poll the status of a registration that has been submitted for validation. Dependening upon the validation, the status field in response may be VALIDATING/VALIDATED/BROKENDelete a registration by IdValidates specific regisration identified by Id. If status field in response is UPDATED/BROKEN/CREATED, user is advised to call this API. This is an async API. User is advised to poll for the status of the validation.
registrations
Gets all registrations for the tenantCreate a registration for specific assets and destination.
Identity Management API
Groups-{id}-members
List members of a groupAdd member to a groupDelete member from a group
Groups-{id}
Get groupUpdate group.Delete group
Groups-Mapping
Create external group mappingGet external group mapping
Groups
List all the groups of a tenant.Create groupUnmap external group mapping
Users-{id}
Get userUpdate userDelete user
Users
List of users of a tenant.Create userGet list of groups starting with the prefix "mdsp:" in which the user is a member.
provider/oauth/clients/{id}-secrets
Add new OAuth client's secretUpdate OAuth client's secretDelete old OAuth client's secret
provider/oauth/clients/{id}
Get OAuth client details
Updating the specific IDP with attribute mapping for external group
VFC API
projects-{id}-nodes
Read project's nodesCreate or replace flow nodesStarts a flow
projects-{id}
Read the projectRename a projectDelete a project
projects
Reads all projects of the specified userCreate new project
Rules Management API
rules-{ruleId}
Get rule by IDDelete a single ruleUpdate existing rulePatch existing rule
rules
Get a list of rulesAdd a new rule
IoT Time Series API
timeseries-{entityId}/{propertySetName}
Retrieve time series dataCreate or update time series dataCreate or merge time series dataDelete time series data
timeseries
Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.
Model Management API
models-{modelId}-versions-last
Downloads the last version payload or description of a modelUpdates the last version metadata information of a model, without allowing updates to the model payload itselfDeletes the last version of a model
models-{modelId}-versions-{versionId}
Retrieves the version payload or the version metadataDeletes the specified version of a model and the corresponding metadata
models-{modelId}-versions
Creates a new model versionRetrieves metadata of all versions of a model
models-{modelId}
Retrieves the model's textual description plus its last version details.Updates the model's metadata.Deletes a model, including all its versions
models
Retrieves a list with all models and algorithms.Uploads a model payload and the corresponding metadata.
Asset Management API
assettypes-{id}-fileAssignments/{key}
Add a new file assignment to an asset typeDeletes a file assignment from an asset type
assettypes-{id}
Create or Update an asset typePatch an asset typeRead an asset typeDelete an asset typeUpdate variables from an asset type
assettypes
List all asset types
aspecttypes-{id}
Create or Update an aspect typePatch an aspect typeRead an aspect typeDelete aspect typepatch aspect type variables
aspecttypes
List all aspect types
assets-{id}-fileAssignments/{key}
Save an file assignment to an assetDeletes a file assignment from an asset
assets-{id}-location
Create or Update location assigned to given assetDelete location assigned to given asset.
assets-{id}
Returns an asset.Update an assetPatch an assetDelete an assetMove an assetGet all variables of an assetGet all aspects of an asset
assets
List all available assetsCreate an assetReturns the root asset of the user.
files-{fileId}
Returns a file's metadata by its idUpdate a fileDelete a file.Returns a file by its id
files
Upload files to be used in Asset Management.Get metadata of uploaded files.
model/lock
Returns lock state of an asset model.Enable/disable lock state of an asset model.
List all links for available resources
Transaction Management API
transactions
Get transactionsGet info of a specific transaction
Aviation Data Hub - Asset Vertical
assets-{id}
Query asset by id.Delete a single asset.Patch asset by id.
assets
Search assets by search criteria.Change an asset.Create an asset.Delete all assets.
states-events
Search System State Events by Search Criteria.Post a system state event.
states
Search System States by Search Criteria.
meterings/events
Search System Metering Events by Search Criteria.Post a system metering event.
Tenant Management API
subtenants-{id}
Get a subtenant by idUpdate a subtenant by idDelete a subtenant by id
subtenants
Get subtenantsCreate a subtenant
legalConfigRegions-{regionId}
Update a region configuration of current tenantDelete legal information configuration of a region
legalConfigRegions
Get the complete legal information configuration of current tenantCreates tenant legal informationDelete the complete legal information configuration of current tenant
legalInfo
Get specific legal informationGet the region specific legal information for a given tenant with fallback logic to core tenant
tenantInfo-logo
Get tenant logoUpload tenant logoDelete tenant logo
tenantInfo
Get tenant infoPatch tenant infoGet tenant logo metadata
Get the region specific legal information for a given tenant without fallback logic
Commanding
deliveryJobs-{id}-commands
Get all the commands related with a delivery job.Get the command associated with a delivery job by command Id
deliveryJobs-{id}
Get the delivery job by IdDeletes a delivery job and its related commands.
deliveryJobs
Create a delivery jobGet all delivery jobs
Structure API
addresses-{addressId}
Get AddressUpdate AddressDelete Address
addresses
List AddressesCreate Address
locations-{locationId}-relationships
List/Get isPartOf relationships for the LocationList/Get hasParts relationships for the LocationList/Get hasAssets relationships for the Location
locations-{locationId}
Get LocationUpdate LocationDelete Location
locations
List LocationsCreate Location
assets/{assetId}/relationships/has-location
Update hasLocationList/Get hasLocations relationships for the Asset
equipment-{equipmentId}
Get EquipmentUpdate EquipmentDelete Equipment
equipment
List EquipmentsCreate Equipment
equipment-types
List EquipmentTypesGet EquipmentType
point-groups-{point-groupId}-points
List PointsCreate Point
point-groups-{point-groupId}-relationships/has-points
Add hasPointsDelete hasPoints
point-groups-{point-groupId}
Get PointGroupList PointValues
point-groups
List PointGroups
enums
List CountriesList TimeZonesList BuildingTypes
Building Geometry API
floorplans-{floorplanId}-floorplan-images
List Floorplan ImagesGet Floorplan Image
floorplans-{floorplanId}-geometry
List GeometryGet Geometry Center PointGet Geometry
floorplans-{floorplanId}
Get Floorplan
floorplans
List Floorplans
palettes-{paletteId}/symbols
List SymbolsGet Symbol Palette by ID
palettes
List Palettes
MindConnect MQTT API
caCertificates-{id}
Get CA CertificateDelete CA certificate.Verify CA certificateGet registration code
caCertificates
Upload CA certificateGet CA certificates
agentCertificates-{id}
Get Auto Generated Agent CertificateDelete Auto Generated Agent Certificate.
agentCertificates
Create Auto Generated Agent CertificateGet Auto Generated Agent Certificates
SDI - Semantic Data Interconnect APIs
dataLakes-{id}
Retrieves DataLake for a given DataLake IdUpdates base path for a given data lake type
dataLakes
Retrieves all DataLakesCreates a data lake record with a given data lake type and base path
iotDataRegistries
Retrieves an IoT Data Registry entriesAdd a new IoT Data Registry entry
dataRegistries-{id}
Retrieves Data Registry for a given registry idUpdates a Data Registry
dataRegistries
Retrieves Data Registry entriesAdd a new Data Registry entry
dataTypes-{name}
Retrieves datatype for a given datatype nameDeletes custom datatype for a given datatype nameUpdates Datatype
dataTypes
Retrieves the custom datatypes for the current tenant.Custom datatype registration.
ingestJobStatus
Retrieve a list of jobIds.Retreive the job status.
queries-{id}-executionJobs
Create execution job for dynamic query. There is soft limit of upto 10 number of parameters and aliases.Retrieve latest query results by query id
queries-{id}
Retrieve query by query idUpdate query by query idDelete query by query id
queries
Retrieve all queriesCreate new queries
executionJobs-{id}
Retrieve job details by job idDelete job by job idRetrieve query results by job id
executionJobs
Retrieve all jobs
ontologies-{id}
Retrieve ontology.Delete ontology
ontologies
Retrieve all ontologies
ontologyJobs
Upload file and submit job for create/update ontologyRetrieve status of ontology creation/updation job
Generates the regular expression patterns for a given set of sample valuesUpload the given file for the current tenant. The input file must be less than 100MB in size.Ingest the provided file and start SDI's schema generation process.Search schema for ingested data.Infer semantic model based on two or more generated schemas. Currently it supports infer of upto 20 schemas.
Message Broker API
subscribers/{id}/versions/{versionId}/topics/{topicId}
Create or update a subscription to the given topic.Get the subscription.Delete the given subscription.
Publishes new message to the given topic.
TASK-DATA-SERVICE
tasks
GET the outbound pcf requests of my company. it is recommended to make use of the "status" query parameter as follows /tasks/outboundPcfRequests?status=NEW,PCF_RECEIVED,COMPLETED.GET the incoming pcf requests of my company. it is recommended to make use of the "status" query parameter as follows /tasks/inboundPcfRequests?status=NEW,PCF_SHARED,COMPLETED.
Product Information Webservice
api-products/{productNumber}
get-obsolescenceget-delivery
api
get-api-key-details
Siemens Battery Passport API - Preliminary version from 06.02.2024
passports-public-{batterypassid}
Get battery passport public attributes by providing the batterypassid
passports-{batterypassid}
Get battery passport private attributes by providing the batterypassidUpdate public and private battery passport attributes by providing the batterypassidDelete battery passport by providing the batterypassidRestore
passports
Get list of a user's private passes given a certain stateCreate a new passport in its entirety
users
Get user by user nameAdd userUpdate user
Work Order Management API
workorders-{woHandle}
Retrieves work order for given work order handleUpdate work order for given work order handleDelete work order for given work order handlePartial update attachments work order for given work order handlePartial update associations work order for given work order handlePartial update externalSystems work order for given work order handle
workorders
Get list of work ordersCreate work orderGet list of work orders activitiesGet aggregate summary of workorder
Usage Transparency API
usagesJobs-{id}
Retrieve the status of processing of usages that were added by the job.Retrieve the processing errors related the usages added by the job.
usagesJobs
Add usages for one or more tenants, users and applications to UTS for storage and processing.Query status of processing for the jobs that added the usages.
Send application specific usages to UTS backend.Get monthly aggregated usages of rule enabled for consumer tenant.Get monthly aggregated usages for rule enabled to consumer tenants.
Ingestion API
Add Point Values
SiGREEN REST API
To create a credential for a specific product in a company in SiGREEN.It is to know whether a credential has been created or not.
PRODUCT-DATA-SERVICE
products-{productId}-bom
Create a Bill of Material for a product in SiGREENGet a list Bill of Material entries for a product in SiGREEN
products-{productId}
Offset your emissions.
products-{id}
Get an individual product details by product id.Update a product in SiGREEN.Get product PCF details by product id
products-identifierTypes-{id}
Delete an unused product identifier type for a company in SiGREEN.Update a product identifier type for a company in SiGREEN.
products-identifierTypes
Get product identifier types for a company in SiGREEN.Create a product identifier type for a company in SiGREEN.
products
Get all products of a company in SiGREEN.Upload a product to SiGREEN.Upload factory emissions for a product in SiGREEN. A bulk upload is also possible with this endpoint. The current limitation of bulk uploads is set to 10.
factories-{id}
Delete an unused factory for a company in SiGREEN.Update a factory for a company in SiGREEN.
factories
Get factories for a company in SiGREEN.Create a factory for a company in SiGREEN.
Event Management API
events-{eventId}
Get an eventUpdate an event
events
Create new eventQuery events
eventTypes-{eventTypeId}
Update an event typeGet an event typeDelete an event type
eventTypes
Create new event typeQuery event types
deleteEventsJobs
Create a delete events jobGet a delete events job
createEventsJobs
Create a create events jobGet a create events job
Info about the API
Activities API
Get activities
VPP Integration API
vppController/{siteId}-energyPrices
Write VPP energy pricesGet VPP energy prices
vppController/{siteId}
Get calculated power consumption
Case Management API
cases-{handle}-comments-{id}
Partial update comment for given case handleDelete case comment for given case handle
cases-{handle}-comments
Create comment for given case handleGet list of case comments for given case handle
cases-{handle}
Retrieves case for given case handleUpdate case for given case handleDelete case for given case handlePartial update attachments case for given case handlePartial update associations case for given case handlePartial update externalSystems case for given case handlePartial update tags of case for given case handle
cases
Get list of casesCreate caseGet list of cases activitiesGet list of cases commentsGet aggregate summary of case
Charger Status API
chargerStatus/chargers/{chargerId}
Get status of charger in ascending order, date range is restricted for only one day. If date range in request is not provided the latest data is returnedGet status of connector in ascending order, date range is restricted for only one day. If date range in request is not provided the latest data is returnedGet connectivity status of charger
Aviation Data Hub API - Flight Vertical
flightlegs-events
Query flight events based on given search criteria.Post a flight scheduled event.Post a flight aircraft allocation event.Post a flight time event.Post a flight cancelled event.Post a gate resource event.Post an aircraft parking position resource event.Post a terminal resource event.Post a check-in desks resource event.
flightlegs-{id}
Get flight leg by id.Get events for a specific flight leg.
flightlegs
Query flight legs based on given search criteria.
Operations API
devices-{deviceId}-events-{eventId}
Get EventLists event transition history
devices-{deviceId}-events
List Events
devices-{deviceId}
Get DevicePatch device attributesList Devices behind a GatewayList Points
devices
List DevicesCreate device
points/{pointId}-values
Get Point ValuesAdd Point Values
points/{pointId}-alarm-configurations-{alarmConfigurationId}
Get Alarm Configuration by IDUpdate Alarm Configuration by IDDelete Alarm Configuration by ID
points/{pointId}-alarm-configurations
List AlarmConfigurationsCreate new Alarm Configuration
points/{pointId}
Get PointUpdate Point - Set Value
locations
List LocationsGet Location
Remote Command API
Send the OCPP command remotely to charger.
Analyze MyMachine /Condition API Documentation
measurements-{id}-results-{resultId}-graphData
Get the graphical data of friction for the given measurement id and the result id.Get the graphical data of stiffness for the given measurement id and the result id.Get the graphical data of backlash for the given measurement id and the result id.Get the graphical data for the given measurement id and the result id.Get the graphical data of equability for the given measurement id and the result id.Get the graphical data of frequency response for the given measurement id and the result id.
measurements-{id}-results-{resultId}
Get the result for the given measurement id and the result id.Get raw data of the the result for the given measurement id and the result id.
measurements-{id}-results
Get all results of the measurement
measurements-{id}
Get measurementGet the threshold for the given measurement id.
measurements
Get measurements
measurementGroups
Get measurement groupsGet measurement group
Railigent X - Asset Feature API
v1/fleets-{fleetId}-assets
Retrieve information for all assets of a specific fleet.Retrieve information for a specific asset of a specific fleet.
v1/fleets-{fleetId}
Retrieve information about a specific eligible fleet of assets.
v1/fleets
Retrieve information about all eligible fleets of assets.
OAuth Authorization Server
Client Credentials GrantToken keys endpoint
Remote Services API
tenants-{id}
Retrieve a tenantDelete a tenant
tenants
Create a new tenantList all tenants
organizations-{id}
Retrieve an organizationDelete an organizationList owners of an organizationList an organization's ownership historyList appointed owners for an organizationAdd a user as an owner to an organizationRemove a user's organization owner status from an organizationUpdate an organization's name
organizations
Create a new organizationList all organizations
users-{id}
Retrieve a userDelete a userGet organizations a user has access toGet a user's roles in an organizationGet a user's all grants in an organizationUpdate a user's first and last nameUpdate a user's companyUpdate a user's countryActivate a user's accountSuspend a user's account
users
Create a new userList all users
external-users-{id}
Retrieve an external user referralRescind the referral of an external userAdmit a pending external userRevoke an admitted external userReject a referred external user
external-users
Refer an external user to an organizationList all external usersList all external user referrals audit recordsRevoke all admitted external usersReject all external users by their status
user-groups-{id}
Retrieve a usergroupDelete a usergroupList all users in a usergroupUpdate a usergroup's nameAdd a user to a usergroupRemove a user from a usergroup
user-groups
Create a new usergroupList all usergroups
products-{id}
Retrieve a product nodeDelete a product nodeUpdate a product's nameMove product from a parent to anotherCopy product from a parent to another
products
Create a new product nodeList all product nodes
nodes-{id}
Retrieve a nodeDelete a nodeUpdate a node's nameMove a node to another parent
nodes
Create a new nodeList all nodes
sites-{id}
Retrieve a siteDelete a siteUpdate a site's nameUpdate a site's contact emailUpdate a site's timezoneUpdate a site's countryMove a site to another parent
sites
Create a new siteList all sites
connectors-{id}
Retrieve a connectorDelete a connectorUpdate connector's nameUpdate connector's descriptionEnforce permission for connectorDo not require a permission for connectorSet idle timeout configuration to be infiniteUpdate connector's idle timeout configurationUpdate connector's parameters
connectors
Create a new connectorList all connectors
user-grants-{id}
Retrieve a user grantDelete a user grant
user-grants
Create a new user grantList all user grants
user-group-grants-{id}
Retrieve a usergroup grantDelete a usergroup grant
user-group-grants
Create a new usergroup grantList all usergroup grants
Retrieve a user session infoList all countries
Notification API
multicastSMSNotificationJobs-{id}
Shows status of an sms job.Shows detailed delivery information of an sms job.
multicastSMSNotificationJobs
Sends an SMS notification to specified recipients.Shows a list of all sms notification jobs.
emailNotificationJobs-{id}
Shows the status of an email job.Shows email delivery status per recipient.
emailNotificationJobs
Create an email job to send emails with attachments.Shows a list of email notification jobs.
multicastEmailNotificationJobs-{id}
Shows status of an email job.Shows email delivery status per recipient.
multicastEmailNotificationJobs
Sends an email notification to specified recipients with an option to attach files.
emailEncryptionCertificates-{email}
Upload a new email encryption certificate for the specified recipient email.Fetch the email encryption certificate corresponding to the specified recipient email.Update the specified recipient's email encryption certificate.Delete the email encryption certificate for the specified recipient email.
emailEncryptionCertificates
Get a list of email encryption certificates.
bouncedRecipients
Get all the recipients to whom the email delivery failed/bounced.Delete recipient email from bounced recipient list.
multicastPushNotificationJobs
Sends a push notification to selected mobile app instances.Shows a list of push notification jobsShows the status of a push notification job.
mobileApps-{id}-instances-{instanceId}
Edit a specific mobile app instance registration. Push notification token detail is masked and not displayed in response owing to security reasons.Delete a specific mobile app instance registration.
mobileApps-{id}-instances
Registers a new mobile installation instance with a registered mobile app.Show all registered mobile app instances for a given mobile app. Push notification token detail is masked and not displayed in response owing to security reasons.
mobileApps-{id}
Edit a registered mobile app. App Configuration details are masked and not displayed in response owing to security reasons.Deregister an existing registered mobile app.
mobileApps
Register a new mobile app.Show all registered apps for a tenant. App Configuration details are masked and not displayed in response owing to security reasons.
templates-{id}
Shows the details of the specified template.Update the specified template definition.Delete the specific template definition.Download the template file for review
templates
Create a template for notification.Shows a list of templates.
DepotFinity Token Management API
access Token
HomeLifecycle Twin APIdocument-types-groups

document-types-groups

Number of APIs: 3

  1. Document Type All Custom Field Group Get Many GET {{baseUrl}}/document/types/groups

  2. Document Type All Custom Field Group Post One POST {{baseUrl}}/document/types/groups

  3. Document Type All Custom Field Group Delete Many DELETE {{baseUrl}}/document/types/groups

Previous
Document Type All Custom Field Group Put One
Next
Document Type All Custom Field Group Get Many