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 countries Returns all regions for the introducers country id.

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.

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.

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 subscription delete notification subscription for a specific proposal

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 data To delete an identity

Get identities To create an identity

privileges-assignments/of-holder/{holderId}

To retrieve assigned privileges for an identity Assign priviliges to an Identity

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.

Update a supplier by supplier Id in SiGREEN.Get supplier by id for one company in SiGREEN

Create a supplier in SiGREEN Get 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 component Update location/share/secondary data/supplier product id by component supplier id Delete link between component and supplier

components-{id}-linkSuppliers

Link suppliers and secondary data with component Get all linked suppliers with component

components-{id}

Update component details by id Get component details by id Get an export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.

Create component in SiGREEN Get all components for one company in SiGREEN GET 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 id Delete a mapping

dataPointMappings

Create single mapping Get mappings.

eventMappings-{id}

Get a mapping by id Update a mapping Delete a mapping

Create single mapping Get 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 record Re-play a recoverable record Get download link of record payload.

recoverableRecords

Get all recoverable records

/exchange Get Diagnostic Information

Lifecycle Twin API

categories-{id}

Categories Get One Categories Put One

categories-{entityType}-groups-{id}

Category All Groups Get One Category All Groups Put One

categories-{entityType}-groups

Category All Groups Get Many Category All Groups Post One Category All Groups Delete Many

categories-{entityType}-tabs-{id}

Category All Tabs Get One Category All Tabs Put One

categories-{entityType}-tabs

Category All Tabs Get Many Category All Tabs Post One Category All Tabs Delete Many

categories-{categoryId}/{entityType}-groups-{groupId}/fields

Category Field Get Many Category Field Get One

categories-{categoryId}/{entityType}-groups-{id}

Category Field Group Get One Category Field Group Put One

categories-{categoryId}/{entityType}-groups

Category Field Group Get Many Category Field Group Post One Category Field Group Delete Many

categories-{categoryId}/{entityType}-tabs-{id}

Category Tab Get One Category Tab Put One

categories-{categoryId}/{entityType}-tabs

Category Tab Get Many Category Tab Post One Category Tab Delete Many

Categories Get Many Categories Post One Categories Delete Many All Category Status Get Many

assets-massupdate

Asset Mass Update Update Asset Mass Update Put One

assets-{assetId}-varslinkup

Asset Rds Vars Get Many Asset Rds Vars Delete Many

assets-{assetId}-systems-{id}

Asset Systems Put One Asset Systems Delete One

assets-{assetId}-systems

Asset Systems Get Many Asset Systems Delete Many

assets-{assetId}-relations-{id}

Asset Relations Put One Asset Relations Delete One

assets-{assetId}-relations

Asset Relations Get Many Asset Relations Post Many Asset Relations Delete Many

assets-{assetId}

Asset Rds Archive Get Many Asset Rds Vars Not Linked Get Many

Asset Get One Asset Put One Asset Delete One

Asset Get Many Asset Post One Asset Delete Many Asset Get Asset Fields Asset Rename Many Asset Get By Object Id

bcf-issues-archive-{id}-download

BCF Archive Download BCF Archive Download Head

bcf-issues-archive

BCF Archive Post Stream

bcf-issues-{issueId}/comments-{id}-download

BCF Comment Download BCF Comment Download Head

bcf-issues-{issueId}/comments-{id}

BCF Comment Get One BCF Comment Put One BCF Comment Delete One BCF Comment Put Stream

bcf-issues-{issueId}/comments

BCF Comment Get Many BCF Comment Post One BCF Comment Delete Many BCF Comment Post Stream

BCF Import Post Stream

bcf-comments/{id}

BCF Comment Delete Comment BCF Comment Update Comment

bimconnectors-{id}

BIM Connector Get One BIM Connector Put One

bimconnectors-{connectorId}/{entityType}/mappings-{mappingId}/rules

BIM Connector Field Mapping Rule Post One BIM Connector Field Mapping Rule Delete Many BIM Connector Field Mapping Rule Put One

bimconnectors-{connectorId}/{entityType}/mappings

BIM Connector Field Mappings Get Many BIM Connector Field Mappings Post One BIM Connector Field Mappings Delete Many BIM Connector Field Mappings Put One

BIM Connector Get Many BIM Connector Post One

{entitytype}-categories/fields-{id}

Category Custom Fields Get One Category Custom Fields Put One

{entitytype}-categories/fields

Category Custom Fields Get Many Category Custom Fields Post One Category Custom Fields Delete Many

{entitytype}-groups-{id}

Entity Type Custom Field Group Get One Entity Type Custom Field Group Put One

{entitytype}-groups

Entity Type Custom Field Group Get Many Entity Type Custom Field Group Post One Entity Type Custom Field Group Delete Many

{entitytype}-customfields-{id}

Entity Type Custom Fields Get One Entity Type Custom Fields Put One

{entitytype}-customfields-categories/{categoryId}/free-{id}

Entity Type Custom Fields Free Get One Entity Type Custom Fields Free Put One

{entitytype}-customfields-categories/{categoryId}/free

Entity Type Custom Fields Free Get Many Entity Type Custom Fields Free Post One Entity Type Custom Fields Free Delete Many

{entitytype}-customfields-free-{id}

Entity Type Custom Fields Free At All Get One Entity Type Custom Fields Free At All Put One

{entitytype}-customfields-free

Entity Type Custom Fields Free At All Get Many Entity Type Custom Fields Free At All Post One Entity Type Custom Fields Free At All Delete Many

{entitytype}-customfields

Entity Type Custom Fields Get Many Entity Type Custom Fields Post One Entity Type Custom Fields Delete Many

{entitytype}-tabs-{id}

Entity Type Custom Tab Get One Entity Type Custom Tab Put One

{entitytype}-tabs

Entity Type Custom Tab Get Many Entity Type Custom Tab Post One Entity Type Custom Tab Delete Many

clients-{clientName}/organizations-{id}

Client Organization Get One Client Organization Post One For Organization

clients-{clientName}/organizations

Client Organization Get Many Client Organization Post One Client Organization Delete Many

clients-{clientname}/users-{id}

Client User Get One Client User Post One Model

clients-{clientname}/users

Client User Get Many Client User Post One Client User Delete Many

customfields-{id}

Custom Field Definition Get One Custom Field Definition Put One

customfields-instances-{id}

Custom Field Definition Instance Get One Custom Field Definition Instance Put One

customfields-instances

Custom Field Definition Instance Get Many Custom Field Definition Instance Post One Custom Field Definition Instance Delete Many Custom Field Definition Instance Post Instances Custom Fields File

customfields-types-{id}

Field Type Get One Field Type Put One

customfields-types-{fieldTypeId}/values-{id}-download

Field Type Values Download Field Type Values Download Head

customfields-types-{fieldTypeId}/values-{id}

Field Type Values Get One Field Type Values Put One Field Type Values Delete One Field Type Values Put Stream

customfields-types-{fieldTypeId}/values

Field Type Values Get Many Field Type Values Post One Field Type Values Delete Many Field Type Values Post Stream

customfields-types

Field Type Get Many Field Type Post One Field Type Delete Many

Custom Field Definition Get Many Custom Field Definition Post One Custom Field Definition Delete Many Custom Field Definition Post Definitions File

{entityType}-{baseEntityId}/tabs/{groupId}/values

Custom Tab Value Get Many Custom Tab Value Post One Custom Tab Value Delete Many

{entityType}-categories-{id}

Entity Categories Get One Entity Categories Put One

{entityType}-categories-free-{id}

Entity Categories Free Get One Entity Categories Free Put One

{entityType}-categories-free

Entity Categories Free Get Many Entity Categories Free Post One Entity Categories Free Delete Many

{entityType}-categories

Entity Categories Get Many Entity Categories Post One Entity Categories Delete Many

{entityType}-groups/{groupId}/fields

Entity Type Group Fields Get Many Entity Type Group Fields Get One

{entityType}-tabs/{groupId}/fields

Entity Type Group Fields Get Many Entity Type Group Fields Get One

disciplines-{id}

Discipline Get One Discipline Put One

Discipline Get Many Discipline Post One Discipline Delete Many

folders/{folderId}/documents-autoname

Document Autonaming Get Document Autoname Document Autonaming Get Document Autoname Validated Document Autonaming Get Document Required Fields Document Autonaming Get Is Autoname

documents-{documentId}-files/actual-{id}

Document File Version Get One Document File Version Put One

documents-{documentId}-files/actual

Document File Version Get Many Document File Version Post One Document File Version Delete Many

documents-{documentId}

Document History Get Many Document Tags Get Many Folder Statuses Statistics Get Many

documents-fromsurvey-{id}

Document From Survey Get One Document From Survey Put One

documents-fromsurvey

Document From Survey Get Many Document From Survey Post One Document From Survey Delete Many Document From Survey Create From Survey

documents-massupdate

Document Mass Update Update Document Mass Update Put One

documents-{folderId}/alldocuments-{id}

Folder All Documents Get One Folder All Documents Put One

documents-{folderId}/alldocuments

Folder All Documents Get Many Folder All Documents Post One Folder All Documents Delete Many

Document Get One Document Put One Document Download Document Put Stream

documents-export-statuses/{taskId}

Document Export Get File Compression Status Document Export Cancel Compression

documents-export

Document Export Get Compressed File

Document Get Many Document Post One Document Delete Many Document Autonaming Fields Get Many Document File Import Cancel Import Document Post Stream

documenttypes-{id}

Document Type Get One Document Type Put One

Document Type Get Many Document Type Post One Document Type Delete Many

document-types-groups-{id}

Document Type All Custom Field Group Get One Document Type All Custom Field Group Put One

document-types-groups

Document Type All Custom Field Group Get Many Document Type All Custom Field Group Post One Document Type All Custom Field Group Delete Many

document-types-fields-{id}

Document Type All Custom Fields Get One Document Type All Custom Fields Put One

document-types-fields

Document Type All Custom Fields Get Many Document Type All Custom Fields Post One Document Type All Custom Fields Delete Many

document-types-tabs-{id}

Document Type All Custom Field Tab Get One Document Type All Custom Field Tab Put One

document-types-tabs

Document Type All Custom Field Tab Get Many Document Type All Custom Field Tab Post One Document Type All Custom Field Tab Delete Many

document-types-{documentTypeId}-groups-{id}

Document Type Custom Field Group Get One Document Type Custom Field Group Put One

document-types-{documentTypeId}-groups-{groupId}/fields

Document Type Custom Fields Get Many Document Type Custom Fields Get One

document-types-{documentTypeId}-groups

Document Type Custom Field Group Get Many Document Type Custom Field Group Post One Document Type Custom Field Group Delete Many

document-types-{documentTypeId}-tabs-{id}

Document Type Custom Field Tab Get One Document Type Custom Field Tab Put One

document-types-{documentTypeId}-tabs

Document Type Custom Field Tab Get Many Document Type Custom Field Tab Post One Document Type Custom Field Tab Delete Many

document-types-{id}

Entity Document Types Get One Entity Document Types Put One

document-types-free-{id}

Entity Document Types Free Get One Entity Document Types Free Put One

document-types-free

Entity Document Types Free Get Many Entity Document Types Free Post One Entity Document Types Free Delete Many

Entity Document Types Get Many Entity Document Types Post One Entity Document Types Delete Many

document-customfields/types/{documentTypeId}/free-{id}

Document Type Custom Fields Free Get One Document Type Custom Fields Free Put One

document-customfields/types/{documentTypeId}/free

Document Type Custom Fields Free Get Many Document Type Custom Fields Free Post One Document Type Custom Fields Free Delete Many

entities-{ownerId}-files-{id}

Owned File Get One Owned File Put One

entities-{ownerId}-files

Owned File Get Many Owned File Post One Owned File Delete Many Owned File Renew File

entities-{ownerId}-documents-{id}

Entity Document Get One Entity Document Put One Entity Document Download Entity Document Put Stream

entities-{ownerId}-documents

Entity Document Get Many Entity Document Post One Entity Document Delete Many Entity Document Post Stream

Entity Type Permission Get Many

facilities-{id}

Facility Get One Facility Put One

facilities-massupdate

Facility Mass Update Update Facility Mass Update Put One

Facility Get Many Facility Post One Facility Delete Many Facility Affects Get Many Facility Get By Object Id

files-common-{id}

File Get One File Put One File Get Thumbnails

File Get Many File Post One File Delete Many

files-{fileId}-zip-{id}

File Zip Get One File Zip Put One

files-{fileId}-zip-{name}/download

File Zip Get File From Zip File Zip Get File From Zip Head

files-{fileId}-zip

File Zip Get Many File Zip Post One File Zip Delete Many

File Versions Get Many

File Compare Compare

Floor Get One Floor Put One Floor Delete One

floors-massupdate

Floor Mass Update Update Floor Mass Update Put One

floors-{floorId}/spaces-assessment

Space Assessment Get Many Space Assessment Get One Space Assessment Get Spaces And Last Assessment

floors-{floorId}/spaces-{id}-download

Floor Spaces Download Floor Spaces Download Head

floors-{floorId}/spaces-{id}

Floor Spaces Get One Floor Spaces Put One Floor Spaces Delete One Floor Spaces Put Stream

floors-{floorId}/spaces

Floor Spaces Get Many Floor Spaces Post One Floor Spaces Delete Many Floor Unassigned Spaces Get Many Floor Spaces Post Stream

Floor Get Many Floor Post One Floor Delete Many Floor Category Get Many Floor Get By Object Id

formprocesses-{formprocessId}/questions

Form Process Answer Get Many Form Process Answer Post One Form Process Answer Delete Many Form Process Answer Put One

Form Process Get Many Form Process Post One Form Process Get One

inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files-{id}

Inspection File Get One Inspection File Put One

inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files

Inspection File Get Many Inspection File Post One Inspection File Delete Many

inspections-{inspectionId}-questions-{id}

Common Question Answer Get One Common Question Answer Put One Common Question Answer Delete One

inspections-{inspectionId}-questions

Common Question Answer Get Many Common Question Answer Post One Common Question Answer Delete Many

inspections-{inspectionId}-forms/{formId}-questions-{id}

Form Question Answer Get One Form Question Answer Put One Form Question Answer Delete One

inspections-{inspectionId}-forms/{formId}-questions

Form Question Answer Get Many Form Question Answer Post One Form Question Answer Delete Many

inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions-{id}

Section Question Answer Get One Section Question Answer Put One Section Question Answer Delete One

inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions

Section Question Answer Get Many Section Question Answer Post One Section Question Answer Delete Many

inspections-{inspectionId}

Inspection Get Sections

inspections-types-{id}

Inspection Type Get One Inspection Type Put One

inspections-types

Inspection Type Get Many Inspection Type Post One Inspection Type Delete Many Inspection Workflow Roles Get Many

Inspection Get Many Inspection Delete Many Inspection Put One

issues-{issueId}

Issue Assign To User Get Many Issue Log Get Many

issues-types-{id}

Issue Category Get One Issue Category Put One

Issue Category Get Many Issue Category Post One Issue Category Delete Many Issue Category Get Create Permission Categories

issues-organizations

Issues Organizations Get Many Issues Organizations Delete Many Issues Organizations Get One

issues-{categoryId}/workflows-{id}

Issue Workflow Get One Issue Workflow Put One

issues-{categoryId}/workflows

Issue Workflow Get Many Issue Workflow Post One Issue Workflow Delete Many

Work Order Get One Work Order Put One Work Order Delete One

issues-printform-{id}-download

Issue Print Form Download Issue Print Form Download Head

issues-printform-{id}

Issue Print Form Get One Issue Print Form Put One Issue Print Form Delete One Issue Print Form Put Stream

issues-printform

Issue Print Form Download Issue Print Form Post One Issue Print Form Delete Many Issue Print Form Post Stream

Work Order Get Many Work Order Delete Many Issue Priority Get Many Work Order New Closed Statistics Get Many Work Order Attach File Work Order Detach File

issuecategories-{id}

Issue Categories Get One Issue Categories Put One

issuecategories-free-{id}

Issue Categories Free Get One Issue Categories Free Put One

issuecategories-free

Issue Categories Free Get Many Issue Categories Free Post One Issue Categories Free Delete Many

issuecategories

Issue Categories Get Many Issue Categories Post One Issue Categories Delete Many

issue-categories-groups-{id}

Issue Category All Custom Field Group Get One Issue Category All Custom Field Group Put One

issue-categories-groups

Issue Category All Custom Field Group Get Many Issue Category All Custom Field Group Post One Issue Category All Custom Field Group Delete Many

issue-categories-tabs-{id}

Issue Category All Custom Field Tab Get One Issue Category All Custom Field Tab Put One

issue-categories-tabs

Issue Category All Custom Field Tab Get Many Issue Category All Custom Field Tab Post One Issue Category All Custom Field Tab Delete Many

issue-categories-{issueCategoryId}-groups-{id}

Issue Category Custom Field Group Get One Issue Category Custom Field Group Put One

issue-categories-{issueCategoryId}-groups-{groupId}/fields

Issue Category Custom Fields Get Many Issue Category Custom Fields Get One

issue-categories-{issueCategoryId}-groups

Issue Category Custom Field Group Get Many Issue Category Custom Field Group Post One Issue Category Custom Field Group Delete Many

issue-categories-{issueCategoryId}-tabs-{id}

Issue Category Custom Field Tab Get One Issue Category Custom Field Tab Put One

issue-categories-{issueCategoryId}-tabs

Issue Category Custom Field Tab Get Many Issue Category Custom Field Tab Post One Issue Category Custom Field Tab Delete Many

issue-types/fields-{id}

Issue Category All Custom Fields Get One Issue Category All Custom Fields Put One

issue-types/fields

Issue Category All Custom Fields Get Many Issue Category All Custom Fields Post One Issue Category All Custom Fields Delete Many

issue-customfields/issuecategories/{issueCategoryId}/free-{id}

Issue Category Custom Fields Free Get One Issue Category Custom Fields Free Put One

issue-customfields/issuecategories/{issueCategoryId}/free

Issue Category Custom Fields Free Get Many Issue Category Custom Fields Free Post One Issue Category Custom Fields Free Delete Many

Job Get One Job Put One

Job Get Many Job Post One Job Delete Many Type Job Resources Get Many

Location Tree Get Many Location Tree Post One Location Tree Delete Many Location Tree Put One

locations-massupdate

Space Mass Update Update Space Mass Update Put One

Location Get One Location Put One Location Delete One

locations-barcode

Location Barcode Get Pdf Stream Location Barcode Generate Codes

Location Get Many Location Post One Location Delete Many Location Impact Get Many Location Get Assets Linkups Location Get By Object Id

Markup Get One Markup Put One

Markup Get Many Markup Post One Markup Delete Many

models/animations/raw

Model Animations Raw Get Many Model Animations Raw Post One Model Animations Raw Delete Many Model Animations Raw Get One

Model View Folder Get Many Model View Folder Post One Model View Folder Delete Many Model View Folder Put One

viewer-models/threedimensional-{id}

Three Dimensional Get One Three Dimensional Put One

viewer-models/threedimensional

Three Dimensional Get Many Three Dimensional Post One Three Dimensional Delete Many

viewer-views/{viewType}-{id}

View Get One View Put One View Delete

viewer-views/{viewType}

View Get Many View Post One View Delete Many

Organization Get Many Organization Delete Many Organization Get One

Phases Get One Phases Put One

Phases Get Many Phases Post One Phases Delete Many

maintenances-{id}

Preventive Maintenance Get One Preventive Maintenance Put One

Preventive Maintenance Get Many Preventive Maintenance Post One Preventive Maintenance Delete Many Preventive Maintenance Get Calendar

roles-{roleId}-members

Project Role Member Get Many Project Role Member Post One Project Role Member Delete Many

roles-{roleId}-users-{id}-download

Role Users Download Role Users Download Head

roles-{roleId}-users-{id}

Role Users Get One Role Users Put One Role Users Delete One Role Users Put Stream

roles-{roleId}-users

Role Users Get Many Role Users Post One Role Users Delete Many Role Users Post Stream

roles-{roleId}-permissions-{id}-download

Role Permissions Download Role Permissions Download Head

roles-{roleId}-permissions-{id}

Role Permissions Get One Role Permissions Put One Role Permissions Delete One Role Permissions Put Stream

roles-{roleId}-permissions

Role Permissions Get Many Role Permissions Post One Role Permissions Delete Many Role Permissions Post Stream

Role Get One Role Put One

Role Get Many Role Post One Role Delete Many

remote/rds-archive

Rds Archive Get Many Rds Archive Post One

remote/rds-{rdsId}/variables

Rds Variable Get Many Rds Variable Get One

Rds Sync Get Many Rds Sync Get One

rds-{rdsid}-devices/{deviceId}-retrievetags

Retrieve Remote Tags Get Root Tags Retrieve Remote Tags Get Folder Tags

rds-{rdsid}-devices/{deviceId}-retrievefolders

Retrieve Remote Tags Get Root Folders Retrieve Remote Tags Get Folder Folders

rds-{rdsid}-devices/{deviceId}

Retrieve Remote Tags Get Many

rds-{rdsid}-remotedevices-{id}

Remote Devices Get One Remote Devices Put One Remote Devices Delete One

rds-{rdsid}-remotedevices

Remote Devices Get Many Remote Devices Post One Remote Devices Get One Remote Devices Test

Remote Connetors Get Many

Rds Get One Rds Put One Rds Delete One

Rds Get Many Rds Post One Rds Delete Many Rds Variable Mass Update Update Rds Test

sensors-panels-{id}

Sensor Panel Get One Sensor Panel Put One

sensors-panels-templates-{id}

Sensor Panel Template Get One Sensor Panel Template Put One

sensors-panels-templates

Sensor Panel Template Get Many Sensor Panel Template Post One Sensor Panel Template Delete Many

Sensor Panel Get Many Sensor Panel Post One Sensor Panel Delete Many Sensor Panel Create Panel

Sensor Rds Var Get Sensor Panel Value

simulations-{id}

Simulation Get One Simulation Put One

simulations-import-{id}

Simulation Import Get One Simulation Import Put One

simulations-import

Simulation Import Get Many Simulation Import Post One Simulation Import Delete Many

simulations-{simulationId}/rdsvars

Simulation Rds Var Get Many Simulation Rds Var Get One

Simulation Get Many Simulation Post One Simulation Delete Many

types-{typeId}-assemblies-{id}

Type Assembly Get One Type Assembly Put One Type Assembly Delete One

types-{typeId}-assemblies-{assemblyId}/items-{id}

Type Assembly Item Get One Type Assembly Item Put One Type Assembly Item Delete One

types-{typeId}-assemblies-{assemblyId}/items

Type Assembly Item Get Many Type Assembly Item Post One

types-{typeId}-assemblies

Type Assembly Get Many Type Assembly Post One

types-{typeId}-jobs-{jobId}/tasks-{id}

Type Job Task Get One Type Job Task Put One

types-{typeId}-jobs-{jobId}/tasks

Type Job Task Get Many Type Job Task Put Models Type Job Task Post One

types-{typeId}-jobs-{id}

Type Job Get One Type Job Put One

types-{typeId}-jobs

Type Job Get Many Type Job Post One

types-{typeId}-spares-{id}-download

Type Spare Download Type Spare Download Head

types-{typeId}-spares-{id}

Type Spare Get One Type Spare Put One Type Spare Delete One Type Spare Put Stream

types-{typeId}-spares

Type Spare Get Many Type Spare Post One Type Spare Delete Many Type Spare Post Stream

types-massupdate

Type Mass Update Update Type Mass Update Put One

Type Get One Type Put One Type Delete One

Type Get Many Type Post One Type Delete Many Spare Category Get Many Type Assign Designer Type Assign Contractor Type Assign Specification Type Assign Major Attribute Type Unassign Standard Type Merge Type Get By Object Id

Stage Get One Stage Put One

Stage Get Many Stage Post One Stage Delete Many Stage Get Create Permission Stages

Statuses Get One Statuses Put One

Statuses Get Many Statuses Post One Statuses Delete Many

systems-{systemId}-subsystems-{id}-download

System Subsystems Download System Subsystems Download Head

systems-{systemId}-subsystems-{id}

System Subsystems Get One System Subsystems Put One System Subsystems Delete One System Subsystems Put Stream

systems-{systemId}-subsystems

System Subsystems Get Many System Subsystems Post One System Subsystems Delete Many System Subsystems Post Stream

systems-{systemId}

System Affects Get Many

systems-massupdate

System Mass Update Update System Mass Update Put One

System Get One System Put One System Delete One

System Get Many System Post One System Delete Many System Get By Object Id

Tag Get Many Tag Get One

usergroups-{id}

User Group Get One User Group Put One

usergroups-{groupId}/users-{id}-download

User Group Members Download User Group Members Download Head

usergroups-{groupId}/users-{id}

User Group Members Get One User Group Members Put One User Group Members Delete One User Group Members Put Stream

usergroups-{groupId}/users

User Group Members Get Many User Group Members Post One User Group Members Delete Many User Group Members Post Stream

User Group Get Many User Group Post One User Group Delete Many

Current User Details User Permission Get Many

workorders/notifications-{id}

Work Order Notification Get One Work Order Notification Put One

workorders/notifications-by

Work Order Notification Batch Create By Users Work Order Notification Batch Create By Organizations

workorders/notifications

Work Order Notification Get Many Work Order Notification Post One Work Order Notification Delete Many Work Order Notification Batch Create

regulations-statistics/organizations

Work Order Notification Organization Statistics Get Many Work Order Notification Organization Statistics Get One

Regulation Report Download

zones-massupdate

Zone Mass Update Update Zone Mass Update Put One

Zone Get One Zone Put One

zones-{zoneId}/locations-{id}-download

Zone Location Download Zone Location Download Head

zones-{zoneId}/locations-{id}

Zone Location Get One Zone Location Put One Zone Location Delete One Zone Location Put Stream

zones-{zoneId}/locations

Zone Location Get Many Zone Location Post One Zone Location Delete Many Zone Location Post Stream

Zone Get Many Zone Post One Zone Delete Many Zone Get By Object Id

workflows-inspections-{id}-download

Workflow Metadata Inspection Download Workflow Metadata Inspection Download Head

workflows-inspections-{id}

Workflow Metadata Inspection Get One Workflow Metadata Inspection Put One Workflow Metadata Inspection Delete One Workflow Metadata Inspection Get One Status Workflow Metadata Workflow Metadata Inspection Get Many Status Workflow Metadata Workflow Metadata Inspection Put Stream

workflows-inspections-move

Workflow Move Inspection Move Workflow Workflow Move Inspection Move Workflow Many

workflows-inspections

Workflow Metadata Inspection Get Many Workflow Metadata Inspection Post One Workflow Metadata Inspection Delete Many Workflow Metadata Inspection Post Stream

workflows-issues-{id}-download

Workflow Move Issue Download Workflow Move Issue Download Head

workflows-issues-{id}

Workflow Move Issue Get One Workflow Move Issue Put One Workflow Move Issue Delete One Workflow Metadata Issue Get One Status Workflow Metadata Workflow Metadata Issue Get Many Status Workflow Metadata Workflow Move Issue Put Stream

workflows-issues-move

Workflow Move Issue Move Workflow Workflow Move Issue Move Workflow Many

workflows-issues

Workflow Move Issue Get Many Workflow Move Issue Post One Workflow Move Issue Delete Many Workflow Move Issue Post Stream

workflows-documents-{id}-download

Workflow Move Document Download Workflow Move Document Download Head

workflows-documents-{id}

Workflow Move Document Get One Workflow Move Document Put One Workflow Move Document Delete One Workflow Metadata Document Get One Status Workflow Metadata Workflow Metadata Document Get Many Status Workflow Metadata Workflow Move Document Put Stream

workflows-documents-move

Workflow Move Document Move Workflow Workflow Move Document Move Workflow Many

workflows-documents

Workflow Move Document Get Many Workflow Move Document Post One Workflow Move Document Delete Many Workflow Move Document Post Stream

Form Get One Form Put One Form Delete One

forms-{formId}-questions-{id}

Form Question Get One Form Question Put One Form Question Delete One

forms-{formId}-questions

Form Question Get Many Form Question Post One Form Question Delete Many

forms-{formId}-sections-{id}

Section Get One Section Put One Section Delete One

forms-{formId}-sections-{sectionId}/questions-{id}

Section Question Get One Section Question Put One Section Question Delete One

forms-{formId}-sections-{sectionId}/questions

Section Question Get Many Section Question Post One Section Question Delete Many

forms-{formId}-sections

Section Get Many Section Post One Section Delete Many

Form Get Many Form Post One Form Delete Many

variables/{variableId}/displayvalue-{id}-download

Rds Variable Display Values Download Rds Variable Display Values Download Head

variables/{variableId}/displayvalue-{id}

Rds Variable Display Values Get One Rds Variable Display Values Put One Rds Variable Display Values Delete One Rds Variable Display Values Put Stream

variables/{variableId}/displayvalue

Rds Variable Display Values Get Many Rds Variable Display Values Post One Rds Variable Display Values Delete Many Rds Variable Display Values Post Stream

{metadataType}/filters-{id}

Filter Set Get One Filter Set Put One Filter Set Delete One

{metadataType}/filters

Filter Set Get Many Filter Set Post One Filter Set Delete Many

users/{userId}/roles-{id}-download

User Roles Download User Roles Download Head

users/{userId}/roles-{id}

User Roles Get One User Roles Put One User Roles Delete One User Roles Put Stream

users/{userId}/roles

User Roles Get Many User Roles Post One User Roles Delete Many User Roles Post Stream

clientprojects-{projectId}

Client Projects Get One Client Projects Get Client Id

clientprojects-{id}

Client Projects Get One Client Projects Put One Client Projects Delete One

Client Projects Get Many Client Projects Create Project Client Projects Delete Many

projects-{projectId}

Projects Get One Projects Get Client Id

Projects Get One Projects Put One Projects Delete One

Projects Get Many

Role Member Get Many Type Job Task Resource Get Many Asset Relations Get Asset Relations With Element Id

Walkinside Web Api

Gets a single job.Cancels a given job.

projects-{id}-share

Unshare a project to one or multiple users.Share a project to one or multiple users.

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.

Get Project(s).Upload a Project.

Deletes a User.Gets user information using its identifier.Updates user information.

Gets User Information.Updates user information.

Gets all Users Information.Creates a User Gets 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 charger Get time series data of a charger connector

RFID Management API

RFID Bulk Import Update 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.

Query container tags based on given search criteria.

Aviation Data Hub API - Airport Vertical

Query all airports.Insert (or overwrite) an airport.Query airports by IATA code.

Agent Management API

agents-{id}-boarding

Get boarding configuration Offboard agent Get boarding status

agents-{id}-dataSourceConfiguration

Get Data Source Configuration Update Data Source Configuration

Get agent Update agent Delete agent Get online status

Create agent Get agents

Register client.Update client information.

Grant an Access Token Returns the JWT signing key currently employed by Agent IAM Returns 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 Model Import calculations from the given data table using an import configuration

api/v1-MasterData

Export Master Data Export Master Data To Response Model Import Master Data Import Master Data From Request Model Cost Factor Life Time Lookup Exchange Rate Master Data Life Time Lookup By Unique Names Increase Rate Life Time Lookup Material Price Life Time Lookup Overhead Life Time Lookup

Logout Delete RefreshToken

Export Tool Calculation Cbd Export Cost Break Down Returns the profitability calculation report. Available since version 2406.0001 Master 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.

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.

Get error status description of stream.

Default endpoint list.Get the list registered apps.

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 account Update a cross account access Delete a cross account access.

crossAccounts-{id}-accesses

Create a cross account access Get a list of cross account accesses

crossAccounts-{id}

Get details of selected cross account Update a cross account Delete cross account and corresponding accesses.

Create a cross account Get a list of cross accounts

accessTokenPermissions-{id}

Details of the write folder request for the given id Delete write permission on folder for the given id

accessTokenPermissions

Allows to give write premission on folder/path List all folders having write premission

objectMetadata-{path}

Create/Update Metadata for the object.Get Metadata for the object.

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 format Get protection settings zip by serialNumber in base64 format

api/v1/settings

Get protection settings by deviceId Get protection settings by serialNumber

fileDeleteRules-{id}

get file delete rule (Time To Live - TTL) for the given id delete 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.

Performs a file download Allows 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.

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 operation Performs a directory deletion

Creates a directory

Asset management related APIs

api/v1-assets-{id}

Get asset Delete asset Update asset

Get all assets Create an asset

api/v1-components-{id}

Get component Delete component Update component

api/v1-components

Create component

api/v1-stations-{id}

Get station Delete station Update station

api/v1-stations

Get stations Create station

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/onboarding-url /chargers/all/chargers

/locations /locations /locations/:id/image

/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/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/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-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/commandsStatus/charger/:chargerID /notifications/allNotificationTopicName /notifications/exportNotifications

/buses/:id /buses/:id /buses/:id

/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

Create Reservation Delete Reservation

medium-consumptions-{medium-consumption-id}

Get consumption values of medium consumption Get costs of medium consumption Get emissions of medium consumption

medium-consumptions

Get list of medium consumptions

IoT Time Series Bulk API

Create bulk import job for importing time series data Retrieve status of bulk import job

Retrieve time series data

Job Manager API

Retrieves the details regarding a job execution Stops a job execution

Retrieves all the jobs executions Creates a new job execution

Retrieves information about a schedule Removes a schedule Updates the status of the schedule to started Updates the status of the schedule to stopped

Retrieves a list with all schedules stored within the same tenant Schedules a job for execution specified by its model id and a cron string

Aviation Data Hub API - Baggage Vertical

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.

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.

Query bag tags based on given search criteria.Query bag tags by flight segment based on given search criteria.

Force Terminate Connection

Disconnects charger

List Devices List Events

VDV-261-Interface API

Communicate VDV-261 parameters to the backend system

Carbon Footprint Indicator for Transportation API

calculate /calculate/jobScheduler /calculate/result

Battery Passport API

passports-{passport_id}-auditLogs

Get the transaction event history of a private passport Get the audit log of a certain event id.Get all attribute changes between two events.

passports-{passport_id}

Get private passport of a battery Update a passport of a battery Delete a private passport of a battery Restores a passport of a battery

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 info Retrieve 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.

Get user by user name Add user Update user sends feedback to siemens

Resource Access Management API

Get a policy Update a policy.Delete a policy.

List all policies.Create a policy.

resourceGroups-{id}

Get a resource group Update a resource group.Delete a resource group.

List all resource groups.Create a resource group.

Data Contextualization - Data Contextualization APIs

Retrieves DataLake for a given DataLake Id Updates base path for a given data lake type

Retrieves all DataLakes Creates a data lake record with a given data lake type and base path

iotDataRegistries

Retrieves an IoT Data Registry entries Add a new IoT Data Registry entry

dataRegistries-{id}

Retrieves Data Registry for a given registry id Updates a Data Registry Delete Data Registry by registry id

Retrieves Data Registry entries Add a new Data Registry entry

dataTypes-{name}

Retrieves datatype for a given datatype name Deletes custom datatype for a given datatype name Updates Datatype

Retrieves the custom datatypes for the current tenant.Custom datatype registration.

ingestJobStatus

Retrieve a list of jobIds.Retreive the job status.

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

Retrieve query by query id Update query by query id Delete query by query id

Retrieve all queries Create new queries.

executionJobs-{id}

Retrieve job details by job id Delete job by job id Retrieve query results by job id

Retrieve all jobs

ontologies-{id}

Retrieve ontology.Delete ontology

Retrieve all ontologies

Upload file and submit job for create/update ontology Retrieve status of ontology creation/updation job

Generates the regular expression patterns for a given set of sample values Upload 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 document Posts a specific revision.

public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}

Downloads a document based on document Id Gets the revisons of a document Posts a new redlining document for a specific revision.

public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}-specs

Get the specifications for an object Updates the specifications for an object Validates the specifications update

public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}

Gets an object Deletes the COMOS Object Updates the given object Upload 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 hierarchy Updates 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 overlays Create a working layer

public/api-projects/v1/dbs/{dbid}/projects-{projid}-languages

Gets a collection of supported languages Gets default project language

public/api-projects/v1/dbs/{dbid}/projects-{projid}

Performs revision step on given revision.Gets the object properties Gets 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 user Remove the session based on session Id Update the specified session (heartbeat) passed

Provides discovery services for public apis EStamp the given pdf document.Get the details of the current user

customers/{customerId}

List Partitions for Customer List 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/BROKEN Delete a registration by Id Validates 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.

Gets all registrations for the tenant Create a registration for specific assets and destination.

Identity Management API

Groups-{id}-members

List members of a group Add member to a group Delete member from a group

Get group Update group.Delete group

Create external group mapping Get external group mapping

List all the groups of a tenant.Create group Unmap external group mapping

Get user Update user Delete user

List of users of a tenant.Create user Get 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 secret Update OAuth client's secret Delete old OAuth client's secret

provider/oauth/clients/{id}

Get OAuth client details

Updating the specific IDP with attribute mapping for external group

projects-{id}-nodes

Read project's nodes Create or replace flow nodes Starts a flow

Read the project Rename a project Delete a project

Reads all projects of the specified user Create new project

Rules Management API

Get rule by ID Delete a single rule Update existing rule Patch existing rule

Get a list of rules Add a new rule

IoT Time Series API

timeseries-{entityId}/{propertySetName}

Retrieve time series data Create or update time series data Create or merge time series data Delete time series data

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 model Updates the last version metadata information of a model, without allowing updates to the model payload itself Deletes the last version of a model

models-{modelId}-versions-{versionId}

Retrieves the version payload or the version metadata Deletes the specified version of a model and the corresponding metadata

models-{modelId}-versions

Creates a new model version Retrieves 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

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 type Deletes a file assignment from an asset type

assettypes-{id}

Create or Update an asset type Patch an asset type Read an asset type Delete an asset type Update variables from an asset type

List all asset types

aspecttypes-{id}

Create or Update an aspect type Patch an aspect type Read an aspect type Delete aspect type patch aspect type variables

List all aspect types

assets-{id}-fileAssignments/{key}

Save an file assignment to an asset Deletes a file assignment from an asset

assets-{id}-location

Create or Update location assigned to given asset Delete location assigned to given asset.

Returns an asset.Update an asset Patch an asset Delete an asset Move an asset Get all variables of an asset Get all aspects of an asset

List all available assets Create an asset Returns the root asset of the user.

Returns a file's metadata by its id Update a file Delete a file.Returns a file by its id

Upload files to be used in Asset Management.Get metadata of uploaded files.

Returns lock state of an asset model.Enable/disable lock state of an asset model.

List all links for available resources

Transaction Management API

Get transactions Get info of a specific transaction

Aviation Data Hub - Asset Vertical

Query asset by id.Delete a single asset.Patch asset by id.

Search assets by search criteria.Change an asset.Create an asset.Delete all assets.

Search System State Events by Search Criteria.Post a system state event.

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 id Update a subtenant by id Delete a subtenant by id

Get subtenants Create a subtenant

legalConfigRegions-{regionId}

Update a region configuration of current tenant Delete legal information configuration of a region

legalConfigRegions

Get the complete legal information configuration of current tenant Creates tenant legal information Delete the complete legal information configuration of current tenant

Get specific legal information Get the region specific legal information for a given tenant with fallback logic to core tenant

tenantInfo-logo

Get tenant logo Upload tenant logo Delete tenant logo

Get tenant info Patch tenant info Get tenant logo metadata

Get the region specific legal information for a given tenant without fallback logic

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 Id Deletes a delivery job and its related commands.

Create a delivery job Get all delivery jobs

addresses-{addressId}

Get Address Update Address Delete Address

List Addresses Create Address

locations-{locationId}-relationships

List/Get isPartOf relationships for the Location List/Get hasParts relationships for the Location List/Get hasAssets relationships for the Location

locations-{locationId}

Get Location Update Location Delete Location

List Locations Create Location

assets/{assetId}/relationships/has-location

Update hasLocation List/Get hasLocations relationships for the Asset

equipment-{equipmentId}

Get Equipment Update Equipment Delete Equipment

List Equipments Create Equipment

equipment-types

List EquipmentTypes Get EquipmentType

point-groups-{point-groupId}-points

List Points Create Point

point-groups-{point-groupId}-relationships/has-points

Add hasPoints Delete hasPoints

point-groups-{point-groupId}

Get PointGroup List PointValues

List PointGroups

List Countries List TimeZones List BuildingTypes

Building Geometry API

floorplans-{floorplanId}-floorplan-images

List Floorplan Images Get Floorplan Image

floorplans-{floorplanId}-geometry

List Geometry Get Geometry Center Point Get Geometry

floorplans-{floorplanId}

List Floorplans

palettes-{paletteId}/symbols

List Symbols Get Symbol Palette by ID

MindConnect MQTT API

caCertificates-{id}

Get CA Certificate Delete CA certificate.Verify CA certificate Get registration code

Upload CA certificate Get CA certificates

agentCertificates-{id}

Get Auto Generated Agent Certificate Delete Auto Generated Agent Certificate.

agentCertificates

Create Auto Generated Agent Certificate Get Auto Generated Agent Certificates

SDI - Semantic Data Interconnect APIs

Retrieves DataLake for a given DataLake Id Updates base path for a given data lake type

Retrieves all DataLakes Creates a data lake record with a given data lake type and base path

iotDataRegistries

Retrieves an IoT Data Registry entries Add a new IoT Data Registry entry

dataRegistries-{id}

Retrieves Data Registry for a given registry id Updates a Data Registry

Retrieves Data Registry entries Add a new Data Registry entry

dataTypes-{name}

Retrieves datatype for a given datatype name Deletes custom datatype for a given datatype name Updates Datatype

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

Retrieve query by query id Update query by query id Delete query by query id

Retrieve all queries Create new queries

executionJobs-{id}

Retrieve job details by job id Delete job by job id Retrieve query results by job id

Retrieve all jobs

ontologies-{id}

Retrieve ontology.Delete ontology

Retrieve all ontologies

Upload file and submit job for create/update ontology Retrieve status of ontology creation/updation job

Generates the regular expression patterns for a given set of sample values Upload 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

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-obsolescence get-delivery

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 batterypassid Update public and private battery passport attributes by providing the batterypassid Delete battery passport by providing the batterypassid Restore

Get list of a user's private passes given a certain state Create a new passport in its entirety

Get user by user name Add user Update user

Work Order Management API

workorders-{woHandle}

Retrieves work order for given work order handle Update work order for given work order handle Delete work order for given work order handle Partial update attachments work order for given work order handle Partial update associations work order for given work order handle Partial update externalSystems work order for given work order handle

Get list of work orders Create work order Get list of work orders activities Get 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.

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.

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 SiGREEN Get a list Bill of Material entries for a product in SiGREEN

products-{productId}

Offset your emissions.

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.

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.

Delete an unused factory for a company in SiGREEN.Update a factory for a company in SiGREEN.

Get factories for a company in SiGREEN.Create a factory for a company in SiGREEN.

Event Management API

events-{eventId}

Get an event Update an event

Create new event Query events

eventTypes-{eventTypeId}

Update an event type Get an event type Delete an event type

Create new event type Query event types

deleteEventsJobs

Create a delete events job Get a delete events job

createEventsJobs

Create a create events job Get a create events job

Info about the API

VPP Integration API

vppController/{siteId}-energyPrices

Write VPP energy prices Get VPP energy prices

vppController/{siteId}

Get calculated power consumption

Case Management API

cases-{handle}-comments-{id}

Partial update comment for given case handle Delete case comment for given case handle

cases-{handle}-comments

Create comment for given case handle Get list of case comments for given case handle

Retrieves case for given case handle Update case for given case handle Delete case for given case handle Partial update attachments case for given case handle Partial update associations case for given case handle Partial update externalSystems case for given case handle Partial update tags of case for given case handle

Get list of cases Create case Get list of cases activities Get list of cases comments Get 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 returned Get 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 returned Get 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.

Query flight legs based on given search criteria.

devices-{deviceId}-events-{eventId}

Get Event Lists event transition history

devices-{deviceId}-events

devices-{deviceId}

Get Device Patch device attributes List Devices behind a Gateway List Points

List Devices Create device

points/{pointId}-values

Get Point Values Add Point Values

points/{pointId}-alarm-configurations-{alarmConfigurationId}

Get Alarm Configuration by ID Update Alarm Configuration by ID Delete Alarm Configuration by ID

points/{pointId}-alarm-configurations

List AlarmConfigurations Create new Alarm Configuration

points/{pointId}

Get Point Update Point - Set Value

List Locations Get 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 measurement Get the threshold for the given measurement id.

Get measurements

measurementGroups

Get measurement groups Get 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.

Retrieve information about all eligible fleets of assets.

OAuth Authorization Server

Client Credentials Grant Token keys endpoint

Remote Services API

Retrieve a tenant Delete a tenant

Create a new tenant List all tenants

organizations-{id}

Retrieve an organization Delete an organization List owners of an organization List an organization's ownership history List appointed owners for an organization Add a user as an owner to an organization Remove a user's organization owner status from an organization Update an organization's name

Create a new organization List all organizations

Retrieve a user Delete a user Get organizations a user has access to Get a user's roles in an organization Get a user's all grants in an organization Update a user's first and last name Update a user's company Update a user's country Activate a user's account Suspend a user's account

Create a new user List all users

external-users-{id}

Retrieve an external user referral Rescind the referral of an external user Admit a pending external user Revoke an admitted external user Reject a referred external user

Refer an external user to an organization List all external users List all external user referrals audit records Revoke all admitted external users Reject all external users by their status

user-groups-{id}

Retrieve a usergroup Delete a usergroup List all users in a usergroup Update a usergroup's name Add a user to a usergroup Remove a user from a usergroup

Create a new usergroup List all usergroups

Retrieve a product node Delete a product node Update a product's name Move product from a parent to another Copy product from a parent to another

Create a new product node List all product nodes

Retrieve a node Delete a node Update a node's name Move a node to another parent

Create a new node List all nodes

Retrieve a site Delete a site Update a site's name Update a site's contact email Update a site's timezone Update a site's country Move a site to another parent

Create a new site List all sites

connectors-{id}

Retrieve a connector Delete a connector Update connector's name Update connector's description Enforce permission for connector Do not require a permission for connector Set idle timeout configuration to be infinite Update connector's idle timeout configuration Update connector's parameters

Create a new connector List all connectors

user-grants-{id}

Retrieve a user grant Delete a user grant

Create a new user grant List all user grants

user-group-grants-{id}

Retrieve a usergroup grant Delete a usergroup grant

user-group-grants

Create a new usergroup grant List all usergroup grants

Retrieve a user session info List 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 jobs Shows 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.

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.

Shows the details of the specified template.Update the specified template definition.Delete the specific template definition.Download the template file for review

Create a template for notification.Shows a list of templates.

DepotFinity Token Management API

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 countries Returns all regions for the introducers country id.

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.

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.

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 subscription delete notification subscription for a specific proposal

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 data To delete an identity

Get identities To create an identity

privileges-assignments/of-holder/{holderId}

To retrieve assigned privileges for an identity Assign priviliges to an Identity

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.

Update a supplier by supplier Id in SiGREEN.Get supplier by id for one company in SiGREEN

Create a supplier in SiGREEN Get 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 component Update location/share/secondary data/supplier product id by component supplier id Delete link between component and supplier

components-{id}-linkSuppliers

Link suppliers and secondary data with component Get all linked suppliers with component

components-{id}

Update component details by id Get component details by id Get an export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.

Create component in SiGREEN Get all components for one company in SiGREEN GET 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 id Delete a mapping

dataPointMappings

Create single mapping Get mappings.

eventMappings-{id}

Get a mapping by id Update a mapping Delete a mapping

Create single mapping Get 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 record Re-play a recoverable record Get download link of record payload.

recoverableRecords

Get all recoverable records

/exchange Get Diagnostic Information

Lifecycle Twin API

categories-{id}

Categories Get One Categories Put One

categories-{entityType}-groups-{id}

Category All Groups Get One Category All Groups Put One

categories-{entityType}-groups

Category All Groups Get Many Category All Groups Post One Category All Groups Delete Many

categories-{entityType}-tabs-{id}

Category All Tabs Get One Category All Tabs Put One

categories-{entityType}-tabs

Category All Tabs Get Many Category All Tabs Post One Category All Tabs Delete Many

categories-{categoryId}/{entityType}-groups-{groupId}/fields

Category Field Get Many Category Field Get One

categories-{categoryId}/{entityType}-groups-{id}

Category Field Group Get One Category Field Group Put One

categories-{categoryId}/{entityType}-groups

Category Field Group Get Many Category Field Group Post One Category Field Group Delete Many

categories-{categoryId}/{entityType}-tabs-{id}

Category Tab Get One Category Tab Put One

categories-{categoryId}/{entityType}-tabs

Category Tab Get Many Category Tab Post One Category Tab Delete Many

Categories Get Many Categories Post One Categories Delete Many All Category Status Get Many

assets-massupdate

Asset Mass Update Update Asset Mass Update Put One

assets-{assetId}-varslinkup

Asset Rds Vars Get Many Asset Rds Vars Delete Many

assets-{assetId}-systems-{id}

Asset Systems Put One Asset Systems Delete One

assets-{assetId}-systems

Asset Systems Get Many Asset Systems Delete Many

assets-{assetId}-relations-{id}

Asset Relations Put One Asset Relations Delete One

assets-{assetId}-relations

Asset Relations Get Many Asset Relations Post Many Asset Relations Delete Many

assets-{assetId}

Asset Rds Archive Get Many Asset Rds Vars Not Linked Get Many

Asset Get One Asset Put One Asset Delete One

Asset Get Many Asset Post One Asset Delete Many Asset Get Asset Fields Asset Rename Many Asset Get By Object Id

bcf-issues-archive-{id}-download

BCF Archive Download BCF Archive Download Head

bcf-issues-archive

BCF Archive Post Stream

bcf-issues-{issueId}/comments-{id}-download

BCF Comment Download BCF Comment Download Head

bcf-issues-{issueId}/comments-{id}

BCF Comment Get One BCF Comment Put One BCF Comment Delete One BCF Comment Put Stream

bcf-issues-{issueId}/comments

BCF Comment Get Many BCF Comment Post One BCF Comment Delete Many BCF Comment Post Stream

BCF Import Post Stream

bcf-comments/{id}

BCF Comment Delete Comment BCF Comment Update Comment

bimconnectors-{id}

BIM Connector Get One BIM Connector Put One

bimconnectors-{connectorId}/{entityType}/mappings-{mappingId}/rules

BIM Connector Field Mapping Rule Post One BIM Connector Field Mapping Rule Delete Many BIM Connector Field Mapping Rule Put One

bimconnectors-{connectorId}/{entityType}/mappings

BIM Connector Field Mappings Get Many BIM Connector Field Mappings Post One BIM Connector Field Mappings Delete Many BIM Connector Field Mappings Put One

BIM Connector Get Many BIM Connector Post One

{entitytype}-categories/fields-{id}

Category Custom Fields Get One Category Custom Fields Put One

{entitytype}-categories/fields

Category Custom Fields Get Many Category Custom Fields Post One Category Custom Fields Delete Many

{entitytype}-groups-{id}

Entity Type Custom Field Group Get One Entity Type Custom Field Group Put One

{entitytype}-groups

Entity Type Custom Field Group Get Many Entity Type Custom Field Group Post One Entity Type Custom Field Group Delete Many

{entitytype}-customfields-{id}

Entity Type Custom Fields Get One Entity Type Custom Fields Put One

{entitytype}-customfields-categories/{categoryId}/free-{id}

Entity Type Custom Fields Free Get One Entity Type Custom Fields Free Put One

{entitytype}-customfields-categories/{categoryId}/free

Entity Type Custom Fields Free Get Many Entity Type Custom Fields Free Post One Entity Type Custom Fields Free Delete Many

{entitytype}-customfields-free-{id}

Entity Type Custom Fields Free At All Get One Entity Type Custom Fields Free At All Put One

{entitytype}-customfields-free

Entity Type Custom Fields Free At All Get Many Entity Type Custom Fields Free At All Post One Entity Type Custom Fields Free At All Delete Many

{entitytype}-customfields

Entity Type Custom Fields Get Many Entity Type Custom Fields Post One Entity Type Custom Fields Delete Many

{entitytype}-tabs-{id}

Entity Type Custom Tab Get One Entity Type Custom Tab Put One

{entitytype}-tabs

Entity Type Custom Tab Get Many Entity Type Custom Tab Post One Entity Type Custom Tab Delete Many

clients-{clientName}/organizations-{id}

Client Organization Get One Client Organization Post One For Organization

clients-{clientName}/organizations

Client Organization Get Many Client Organization Post One Client Organization Delete Many

clients-{clientname}/users-{id}

Client User Get One Client User Post One Model

clients-{clientname}/users

Client User Get Many Client User Post One Client User Delete Many

customfields-{id}

Custom Field Definition Get One Custom Field Definition Put One

customfields-instances-{id}

Custom Field Definition Instance Get One Custom Field Definition Instance Put One

customfields-instances

Custom Field Definition Instance Get Many Custom Field Definition Instance Post One Custom Field Definition Instance Delete Many Custom Field Definition Instance Post Instances Custom Fields File

customfields-types-{id}

Field Type Get One Field Type Put One

customfields-types-{fieldTypeId}/values-{id}-download

Field Type Values Download Field Type Values Download Head

customfields-types-{fieldTypeId}/values-{id}

Field Type Values Get One Field Type Values Put One Field Type Values Delete One Field Type Values Put Stream

customfields-types-{fieldTypeId}/values

Field Type Values Get Many Field Type Values Post One Field Type Values Delete Many Field Type Values Post Stream

customfields-types

Field Type Get Many Field Type Post One Field Type Delete Many

Custom Field Definition Get Many Custom Field Definition Post One Custom Field Definition Delete Many Custom Field Definition Post Definitions File

{entityType}-{baseEntityId}/tabs/{groupId}/values

Custom Tab Value Get Many Custom Tab Value Post One Custom Tab Value Delete Many

{entityType}-categories-{id}

Entity Categories Get One Entity Categories Put One

{entityType}-categories-free-{id}

Entity Categories Free Get One Entity Categories Free Put One

{entityType}-categories-free

Entity Categories Free Get Many Entity Categories Free Post One Entity Categories Free Delete Many

{entityType}-categories

Entity Categories Get Many Entity Categories Post One Entity Categories Delete Many

{entityType}-groups/{groupId}/fields

Entity Type Group Fields Get Many Entity Type Group Fields Get One

{entityType}-tabs/{groupId}/fields

Entity Type Group Fields Get Many Entity Type Group Fields Get One

disciplines-{id}

Discipline Get One Discipline Put One

Discipline Get Many Discipline Post One Discipline Delete Many

folders/{folderId}/documents-autoname

Document Autonaming Get Document Autoname Document Autonaming Get Document Autoname Validated Document Autonaming Get Document Required Fields Document Autonaming Get Is Autoname

documents-{documentId}-files/actual-{id}

Document File Version Get One Document File Version Put One

documents-{documentId}-files/actual

Document File Version Get Many Document File Version Post One Document File Version Delete Many

documents-{documentId}

Document History Get Many Document Tags Get Many Folder Statuses Statistics Get Many

documents-fromsurvey-{id}

Document From Survey Get One Document From Survey Put One

documents-fromsurvey

Document From Survey Get Many Document From Survey Post One Document From Survey Delete Many Document From Survey Create From Survey

documents-massupdate

Document Mass Update Update Document Mass Update Put One

documents-{folderId}/alldocuments-{id}

Folder All Documents Get One Folder All Documents Put One

documents-{folderId}/alldocuments

Folder All Documents Get Many Folder All Documents Post One Folder All Documents Delete Many

Document Get One Document Put One Document Download Document Put Stream

documents-export-statuses/{taskId}

Document Export Get File Compression Status Document Export Cancel Compression

documents-export

Document Export Get Compressed File

Document Get Many Document Post One Document Delete Many Document Autonaming Fields Get Many Document File Import Cancel Import Document Post Stream

documenttypes-{id}

Document Type Get One Document Type Put One

Document Type Get Many Document Type Post One Document Type Delete Many

document-types-groups-{id}

Document Type All Custom Field Group Get One Document Type All Custom Field Group Put One

document-types-groups

Document Type All Custom Field Group Get Many Document Type All Custom Field Group Post One Document Type All Custom Field Group Delete Many

document-types-fields-{id}

Document Type All Custom Fields Get One Document Type All Custom Fields Put One

document-types-fields

Document Type All Custom Fields Get Many Document Type All Custom Fields Post One Document Type All Custom Fields Delete Many

document-types-tabs-{id}

Document Type All Custom Field Tab Get One Document Type All Custom Field Tab Put One

document-types-tabs

Document Type All Custom Field Tab Get Many Document Type All Custom Field Tab Post One Document Type All Custom Field Tab Delete Many

document-types-{documentTypeId}-groups-{id}

Document Type Custom Field Group Get One Document Type Custom Field Group Put One

document-types-{documentTypeId}-groups-{groupId}/fields

Document Type Custom Fields Get Many Document Type Custom Fields Get One

document-types-{documentTypeId}-groups

Document Type Custom Field Group Get Many Document Type Custom Field Group Post One Document Type Custom Field Group Delete Many

document-types-{documentTypeId}-tabs-{id}

Document Type Custom Field Tab Get One Document Type Custom Field Tab Put One

document-types-{documentTypeId}-tabs

Document Type Custom Field Tab Get Many Document Type Custom Field Tab Post One Document Type Custom Field Tab Delete Many

document-types-{id}

Entity Document Types Get One Entity Document Types Put One

document-types-free-{id}

Entity Document Types Free Get One Entity Document Types Free Put One

document-types-free

Entity Document Types Free Get Many Entity Document Types Free Post One Entity Document Types Free Delete Many

Entity Document Types Get Many Entity Document Types Post One Entity Document Types Delete Many

document-customfields/types/{documentTypeId}/free-{id}

Document Type Custom Fields Free Get One Document Type Custom Fields Free Put One

document-customfields/types/{documentTypeId}/free

Document Type Custom Fields Free Get Many Document Type Custom Fields Free Post One Document Type Custom Fields Free Delete Many

entities-{ownerId}-files-{id}

Owned File Get One Owned File Put One

entities-{ownerId}-files

Owned File Get Many Owned File Post One Owned File Delete Many Owned File Renew File

entities-{ownerId}-documents-{id}

Entity Document Get One Entity Document Put One Entity Document Download Entity Document Put Stream

entities-{ownerId}-documents

Entity Document Get Many Entity Document Post One Entity Document Delete Many Entity Document Post Stream

Entity Type Permission Get Many

facilities-{id}

Facility Get One Facility Put One

facilities-massupdate

Facility Mass Update Update Facility Mass Update Put One

Facility Get Many Facility Post One Facility Delete Many Facility Affects Get Many Facility Get By Object Id

files-common-{id}

File Get One File Put One File Get Thumbnails

File Get Many File Post One File Delete Many

files-{fileId}-zip-{id}

File Zip Get One File Zip Put One

files-{fileId}-zip-{name}/download

File Zip Get File From Zip File Zip Get File From Zip Head

files-{fileId}-zip

File Zip Get Many File Zip Post One File Zip Delete Many

File Versions Get Many

File Compare Compare

Floor Get One Floor Put One Floor Delete One

floors-massupdate

Floor Mass Update Update Floor Mass Update Put One

floors-{floorId}/spaces-assessment

Space Assessment Get Many Space Assessment Get One Space Assessment Get Spaces And Last Assessment

floors-{floorId}/spaces-{id}-download

Floor Spaces Download Floor Spaces Download Head

floors-{floorId}/spaces-{id}

Floor Spaces Get One Floor Spaces Put One Floor Spaces Delete One Floor Spaces Put Stream

floors-{floorId}/spaces

Floor Spaces Get Many Floor Spaces Post One Floor Spaces Delete Many Floor Unassigned Spaces Get Many Floor Spaces Post Stream

Floor Get Many Floor Post One Floor Delete Many Floor Category Get Many Floor Get By Object Id

formprocesses-{formprocessId}/questions

Form Process Answer Get Many Form Process Answer Post One Form Process Answer Delete Many Form Process Answer Put One

Form Process Get Many Form Process Post One Form Process Get One

inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files-{id}

Inspection File Get One Inspection File Put One

inspections-{inspectionId}-entities/{baseEntityId}/rolepassresults/{rolePassResultId}/files

Inspection File Get Many Inspection File Post One Inspection File Delete Many

inspections-{inspectionId}-questions-{id}

Common Question Answer Get One Common Question Answer Put One Common Question Answer Delete One

inspections-{inspectionId}-questions

Common Question Answer Get Many Common Question Answer Post One Common Question Answer Delete Many

inspections-{inspectionId}-forms/{formId}-questions-{id}

Form Question Answer Get One Form Question Answer Put One Form Question Answer Delete One

inspections-{inspectionId}-forms/{formId}-questions

Form Question Answer Get Many Form Question Answer Post One Form Question Answer Delete Many

inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions-{id}

Section Question Answer Get One Section Question Answer Put One Section Question Answer Delete One

inspections-{inspectionId}-forms/{formId}-sections/{sectionId}/questions

Section Question Answer Get Many Section Question Answer Post One Section Question Answer Delete Many

inspections-{inspectionId}

Inspection Get Sections

inspections-types-{id}

Inspection Type Get One Inspection Type Put One

inspections-types

Inspection Type Get Many Inspection Type Post One Inspection Type Delete Many Inspection Workflow Roles Get Many

Inspection Get Many Inspection Delete Many Inspection Put One

issues-{issueId}

Issue Assign To User Get Many Issue Log Get Many

issues-types-{id}

Issue Category Get One Issue Category Put One

Issue Category Get Many Issue Category Post One Issue Category Delete Many Issue Category Get Create Permission Categories

issues-organizations

Issues Organizations Get Many Issues Organizations Delete Many Issues Organizations Get One

issues-{categoryId}/workflows-{id}

Issue Workflow Get One Issue Workflow Put One

issues-{categoryId}/workflows

Issue Workflow Get Many Issue Workflow Post One Issue Workflow Delete Many

Work Order Get One Work Order Put One Work Order Delete One

issues-printform-{id}-download

Issue Print Form Download Issue Print Form Download Head

issues-printform-{id}

Issue Print Form Get One Issue Print Form Put One Issue Print Form Delete One Issue Print Form Put Stream

issues-printform

Issue Print Form Download Issue Print Form Post One Issue Print Form Delete Many Issue Print Form Post Stream

Work Order Get Many Work Order Delete Many Issue Priority Get Many Work Order New Closed Statistics Get Many Work Order Attach File Work Order Detach File

issuecategories-{id}

Issue Categories Get One Issue Categories Put One

issuecategories-free-{id}

Issue Categories Free Get One Issue Categories Free Put One

issuecategories-free

Issue Categories Free Get Many Issue Categories Free Post One Issue Categories Free Delete Many

issuecategories

Issue Categories Get Many Issue Categories Post One Issue Categories Delete Many

issue-categories-groups-{id}

Issue Category All Custom Field Group Get One Issue Category All Custom Field Group Put One

issue-categories-groups

Issue Category All Custom Field Group Get Many Issue Category All Custom Field Group Post One Issue Category All Custom Field Group Delete Many

issue-categories-tabs-{id}

Issue Category All Custom Field Tab Get One Issue Category All Custom Field Tab Put One

issue-categories-tabs

Issue Category All Custom Field Tab Get Many Issue Category All Custom Field Tab Post One Issue Category All Custom Field Tab Delete Many

issue-categories-{issueCategoryId}-groups-{id}

Issue Category Custom Field Group Get One Issue Category Custom Field Group Put One

issue-categories-{issueCategoryId}-groups-{groupId}/fields

Issue Category Custom Fields Get Many Issue Category Custom Fields Get One

issue-categories-{issueCategoryId}-groups

Issue Category Custom Field Group Get Many Issue Category Custom Field Group Post One Issue Category Custom Field Group Delete Many

issue-categories-{issueCategoryId}-tabs-{id}

Issue Category Custom Field Tab Get One Issue Category Custom Field Tab Put One

issue-categories-{issueCategoryId}-tabs

Issue Category Custom Field Tab Get Many Issue Category Custom Field Tab Post One Issue Category Custom Field Tab Delete Many

issue-types/fields-{id}

Issue Category All Custom Fields Get One Issue Category All Custom Fields Put One

issue-types/fields

Issue Category All Custom Fields Get Many Issue Category All Custom Fields Post One Issue Category All Custom Fields Delete Many

issue-customfields/issuecategories/{issueCategoryId}/free-{id}

Issue Category Custom Fields Free Get One Issue Category Custom Fields Free Put One

issue-customfields/issuecategories/{issueCategoryId}/free

Issue Category Custom Fields Free Get Many Issue Category Custom Fields Free Post One Issue Category Custom Fields Free Delete Many

Job Get One Job Put One

Job Get Many Job Post One Job Delete Many Type Job Resources Get Many

Location Tree Get Many Location Tree Post One Location Tree Delete Many Location Tree Put One

locations-massupdate

Space Mass Update Update Space Mass Update Put One

Location Get One Location Put One Location Delete One

locations-barcode

Location Barcode Get Pdf Stream Location Barcode Generate Codes

Location Get Many Location Post One Location Delete Many Location Impact Get Many Location Get Assets Linkups Location Get By Object Id

Markup Get One Markup Put One

Markup Get Many Markup Post One Markup Delete Many

models/animations/raw

Model Animations Raw Get Many Model Animations Raw Post One Model Animations Raw Delete Many Model Animations Raw Get One

Model View Folder Get Many Model View Folder Post One Model View Folder Delete Many Model View Folder Put One

viewer-models/threedimensional-{id}

Three Dimensional Get One Three Dimensional Put One

viewer-models/threedimensional

Three Dimensional Get Many Three Dimensional Post One Three Dimensional Delete Many

viewer-views/{viewType}-{id}

View Get One View Put One View Delete

viewer-views/{viewType}

View Get Many View Post One View Delete Many

Organization Get Many Organization Delete Many Organization Get One

Phases Get One Phases Put One

Phases Get Many Phases Post One Phases Delete Many

maintenances-{id}

Preventive Maintenance Get One Preventive Maintenance Put One

Preventive Maintenance Get Many Preventive Maintenance Post One Preventive Maintenance Delete Many Preventive Maintenance Get Calendar

roles-{roleId}-members

Project Role Member Get Many Project Role Member Post One Project Role Member Delete Many

roles-{roleId}-users-{id}-download

Role Users Download Role Users Download Head

roles-{roleId}-users-{id}

Role Users Get One Role Users Put One Role Users Delete One Role Users Put Stream

roles-{roleId}-users

Role Users Get Many Role Users Post One Role Users Delete Many Role Users Post Stream

roles-{roleId}-permissions-{id}-download

Role Permissions Download Role Permissions Download Head

roles-{roleId}-permissions-{id}

Role Permissions Get One Role Permissions Put One Role Permissions Delete One Role Permissions Put Stream

roles-{roleId}-permissions

Role Permissions Get Many Role Permissions Post One Role Permissions Delete Many Role Permissions Post Stream

Role Get One Role Put One

Role Get Many Role Post One Role Delete Many

remote/rds-archive

Rds Archive Get Many Rds Archive Post One

remote/rds-{rdsId}/variables

Rds Variable Get Many Rds Variable Get One

Rds Sync Get Many Rds Sync Get One

rds-{rdsid}-devices/{deviceId}-retrievetags

Retrieve Remote Tags Get Root Tags Retrieve Remote Tags Get Folder Tags

rds-{rdsid}-devices/{deviceId}-retrievefolders

Retrieve Remote Tags Get Root Folders Retrieve Remote Tags Get Folder Folders

rds-{rdsid}-devices/{deviceId}

Retrieve Remote Tags Get Many

rds-{rdsid}-remotedevices-{id}

Remote Devices Get One Remote Devices Put One Remote Devices Delete One

rds-{rdsid}-remotedevices

Remote Devices Get Many Remote Devices Post One Remote Devices Get One Remote Devices Test

Remote Connetors Get Many

Rds Get One Rds Put One Rds Delete One

Rds Get Many Rds Post One Rds Delete Many Rds Variable Mass Update Update Rds Test

sensors-panels-{id}

Sensor Panel Get One Sensor Panel Put One

sensors-panels-templates-{id}

Sensor Panel Template Get One Sensor Panel Template Put One

sensors-panels-templates

Sensor Panel Template Get Many Sensor Panel Template Post One Sensor Panel Template Delete Many

Sensor Panel Get Many Sensor Panel Post One Sensor Panel Delete Many Sensor Panel Create Panel

Sensor Rds Var Get Sensor Panel Value

simulations-{id}

Simulation Get One Simulation Put One

simulations-import-{id}

Simulation Import Get One Simulation Import Put One

simulations-import

Simulation Import Get Many Simulation Import Post One Simulation Import Delete Many

simulations-{simulationId}/rdsvars

Simulation Rds Var Get Many Simulation Rds Var Get One

Simulation Get Many Simulation Post One Simulation Delete Many

types-{typeId}-assemblies-{id}

Type Assembly Get One Type Assembly Put One Type Assembly Delete One

types-{typeId}-assemblies-{assemblyId}/items-{id}

Type Assembly Item Get One Type Assembly Item Put One Type Assembly Item Delete One

types-{typeId}-assemblies-{assemblyId}/items

Type Assembly Item Get Many Type Assembly Item Post One

types-{typeId}-assemblies

Type Assembly Get Many Type Assembly Post One

types-{typeId}-jobs-{jobId}/tasks-{id}

Type Job Task Get One Type Job Task Put One

types-{typeId}-jobs-{jobId}/tasks

Type Job Task Get Many Type Job Task Put Models Type Job Task Post One

types-{typeId}-jobs-{id}

Type Job Get One Type Job Put One

types-{typeId}-jobs

Type Job Get Many Type Job Post One

types-{typeId}-spares-{id}-download

Type Spare Download Type Spare Download Head

types-{typeId}-spares-{id}

Type Spare Get One Type Spare Put One Type Spare Delete One Type Spare Put Stream

types-{typeId}-spares

Type Spare Get Many Type Spare Post One Type Spare Delete Many Type Spare Post Stream

types-massupdate

Type Mass Update Update Type Mass Update Put One

Type Get One Type Put One Type Delete One

Type Get Many Type Post One Type Delete Many Spare Category Get Many Type Assign Designer Type Assign Contractor Type Assign Specification Type Assign Major Attribute Type Unassign Standard Type Merge Type Get By Object Id

Stage Get One Stage Put One

Stage Get Many Stage Post One Stage Delete Many Stage Get Create Permission Stages

Statuses Get One Statuses Put One

Statuses Get Many Statuses Post One Statuses Delete Many

systems-{systemId}-subsystems-{id}-download

System Subsystems Download System Subsystems Download Head

systems-{systemId}-subsystems-{id}

System Subsystems Get One System Subsystems Put One System Subsystems Delete One System Subsystems Put Stream

systems-{systemId}-subsystems

System Subsystems Get Many System Subsystems Post One System Subsystems Delete Many System Subsystems Post Stream

systems-{systemId}

System Affects Get Many

systems-massupdate

System Mass Update Update System Mass Update Put One

System Get One System Put One System Delete One

System Get Many System Post One System Delete Many System Get By Object Id

Tag Get Many Tag Get One

usergroups-{id}

User Group Get One User Group Put One

usergroups-{groupId}/users-{id}-download

User Group Members Download User Group Members Download Head

usergroups-{groupId}/users-{id}

User Group Members Get One User Group Members Put One User Group Members Delete One User Group Members Put Stream

usergroups-{groupId}/users

User Group Members Get Many User Group Members Post One User Group Members Delete Many User Group Members Post Stream

User Group Get Many User Group Post One User Group Delete Many

Current User Details User Permission Get Many

workorders/notifications-{id}

Work Order Notification Get One Work Order Notification Put One

workorders/notifications-by

Work Order Notification Batch Create By Users Work Order Notification Batch Create By Organizations

workorders/notifications

Work Order Notification Get Many Work Order Notification Post One Work Order Notification Delete Many Work Order Notification Batch Create

regulations-statistics/organizations

Work Order Notification Organization Statistics Get Many Work Order Notification Organization Statistics Get One

Regulation Report Download

zones-massupdate

Zone Mass Update Update Zone Mass Update Put One

Zone Get One Zone Put One

zones-{zoneId}/locations-{id}-download

Zone Location Download Zone Location Download Head

zones-{zoneId}/locations-{id}

Zone Location Get One Zone Location Put One Zone Location Delete One Zone Location Put Stream

zones-{zoneId}/locations

Zone Location Get Many Zone Location Post One Zone Location Delete Many Zone Location Post Stream

Zone Get Many Zone Post One Zone Delete Many Zone Get By Object Id

workflows-inspections-{id}-download

Workflow Metadata Inspection Download Workflow Metadata Inspection Download Head

workflows-inspections-{id}

Workflow Metadata Inspection Get One Workflow Metadata Inspection Put One Workflow Metadata Inspection Delete One Workflow Metadata Inspection Get One Status Workflow Metadata Workflow Metadata Inspection Get Many Status Workflow Metadata Workflow Metadata Inspection Put Stream

workflows-inspections-move

Workflow Move Inspection Move Workflow Workflow Move Inspection Move Workflow Many

workflows-inspections

Workflow Metadata Inspection Get Many Workflow Metadata Inspection Post One Workflow Metadata Inspection Delete Many Workflow Metadata Inspection Post Stream

workflows-issues-{id}-download

Workflow Move Issue Download Workflow Move Issue Download Head

workflows-issues-{id}

Workflow Move Issue Get One Workflow Move Issue Put One Workflow Move Issue Delete One Workflow Metadata Issue Get One Status Workflow Metadata Workflow Metadata Issue Get Many Status Workflow Metadata Workflow Move Issue Put Stream

workflows-issues-move

Workflow Move Issue Move Workflow Workflow Move Issue Move Workflow Many

workflows-issues

Workflow Move Issue Get Many Workflow Move Issue Post One Workflow Move Issue Delete Many Workflow Move Issue Post Stream

workflows-documents-{id}-download

Workflow Move Document Download Workflow Move Document Download Head

workflows-documents-{id}

Workflow Move Document Get One Workflow Move Document Put One Workflow Move Document Delete One Workflow Metadata Document Get One Status Workflow Metadata Workflow Metadata Document Get Many Status Workflow Metadata Workflow Move Document Put Stream

workflows-documents-move

Workflow Move Document Move Workflow Workflow Move Document Move Workflow Many

workflows-documents

Workflow Move Document Get Many Workflow Move Document Post One Workflow Move Document Delete Many Workflow Move Document Post Stream

Form Get One Form Put One Form Delete One

forms-{formId}-questions-{id}

Form Question Get One Form Question Put One Form Question Delete One

forms-{formId}-questions

Form Question Get Many Form Question Post One Form Question Delete Many

forms-{formId}-sections-{id}

Section Get One Section Put One Section Delete One

forms-{formId}-sections-{sectionId}/questions-{id}

Section Question Get One Section Question Put One Section Question Delete One

forms-{formId}-sections-{sectionId}/questions

Section Question Get Many Section Question Post One Section Question Delete Many

forms-{formId}-sections

Section Get Many Section Post One Section Delete Many

Form Get Many Form Post One Form Delete Many

variables/{variableId}/displayvalue-{id}-download

Rds Variable Display Values Download Rds Variable Display Values Download Head

variables/{variableId}/displayvalue-{id}

Rds Variable Display Values Get One Rds Variable Display Values Put One Rds Variable Display Values Delete One Rds Variable Display Values Put Stream

variables/{variableId}/displayvalue

Rds Variable Display Values Get Many Rds Variable Display Values Post One Rds Variable Display Values Delete Many Rds Variable Display Values Post Stream

{metadataType}/filters-{id}

Filter Set Get One Filter Set Put One Filter Set Delete One

{metadataType}/filters

Filter Set Get Many Filter Set Post One Filter Set Delete Many

users/{userId}/roles-{id}-download

User Roles Download User Roles Download Head

users/{userId}/roles-{id}

User Roles Get One User Roles Put One User Roles Delete One User Roles Put Stream

users/{userId}/roles

User Roles Get Many User Roles Post One User Roles Delete Many User Roles Post Stream

clientprojects-{projectId}

Client Projects Get One Client Projects Get Client Id

clientprojects-{id}

Client Projects Get One Client Projects Put One Client Projects Delete One

Client Projects Get Many Client Projects Create Project Client Projects Delete Many

projects-{projectId}

Projects Get One Projects Get Client Id

Projects Get One Projects Put One Projects Delete One

Projects Get Many

Role Member Get Many Type Job Task Resource Get Many Asset Relations Get Asset Relations With Element Id

Walkinside Web Api

Gets a single job.Cancels a given job.

projects-{id}-share

Unshare a project to one or multiple users.Share a project to one or multiple users.

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.

Get Project(s).Upload a Project.

Deletes a User.Gets user information using its identifier.Updates user information.

Gets User Information.Updates user information.

Gets all Users Information.Creates a User Gets 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 charger Get time series data of a charger connector

RFID Management API

RFID Bulk Import Update 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.

Query container tags based on given search criteria.

Aviation Data Hub API - Airport Vertical

Query all airports.Insert (or overwrite) an airport.Query airports by IATA code.

Agent Management API

agents-{id}-boarding

Get boarding configuration Offboard agent Get boarding status

agents-{id}-dataSourceConfiguration

Get Data Source Configuration Update Data Source Configuration

Get agent Update agent Delete agent Get online status

Create agent Get agents

Register client.Update client information.

Grant an Access Token Returns the JWT signing key currently employed by Agent IAM Returns 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 Model Import calculations from the given data table using an import configuration

api/v1-MasterData

Export Master Data Export Master Data To Response Model Import Master Data Import Master Data From Request Model Cost Factor Life Time Lookup Exchange Rate Master Data Life Time Lookup By Unique Names Increase Rate Life Time Lookup Material Price Life Time Lookup Overhead Life Time Lookup

Logout Delete RefreshToken

Export Tool Calculation Cbd Export Cost Break Down Returns the profitability calculation report. Available since version 2406.0001 Master 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.

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.

Get error status description of stream.

Default endpoint list.Get the list registered apps.

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 account Update a cross account access Delete a cross account access.

crossAccounts-{id}-accesses

Create a cross account access Get a list of cross account accesses

crossAccounts-{id}

Get details of selected cross account Update a cross account Delete cross account and corresponding accesses.

Create a cross account Get a list of cross accounts

accessTokenPermissions-{id}

Details of the write folder request for the given id Delete write permission on folder for the given id

accessTokenPermissions

Allows to give write premission on folder/path List all folders having write premission

objectMetadata-{path}

Create/Update Metadata for the object.Get Metadata for the object.

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 format Get protection settings zip by serialNumber in base64 format

api/v1/settings

Get protection settings by deviceId Get protection settings by serialNumber

fileDeleteRules-{id}

get file delete rule (Time To Live - TTL) for the given id delete 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.

Performs a file download Allows 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.

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 operation Performs a directory deletion

Creates a directory

Asset management related APIs

api/v1-assets-{id}

Get asset Delete asset Update asset

Get all assets Create an asset

api/v1-components-{id}

Get component Delete component Update component

api/v1-components

Create component

api/v1-stations-{id}

Get station Delete station Update station

api/v1-stations

Get stations Create station

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/onboarding-url /chargers/all/chargers

/locations /locations /locations/:id/image

/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/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/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-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/commandsStatus/charger/:chargerID /notifications/allNotificationTopicName /notifications/exportNotifications

/buses/:id /buses/:id /buses/:id

/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

Create Reservation Delete Reservation

medium-consumptions-{medium-consumption-id}

Get consumption values of medium consumption Get costs of medium consumption Get emissions of medium consumption

medium-consumptions

Get list of medium consumptions

IoT Time Series Bulk API

Create bulk import job for importing time series data Retrieve status of bulk import job

Retrieve time series data

Job Manager API

Retrieves the details regarding a job execution Stops a job execution

Retrieves all the jobs executions Creates a new job execution

Retrieves information about a schedule Removes a schedule Updates the status of the schedule to started Updates the status of the schedule to stopped

Retrieves a list with all schedules stored within the same tenant Schedules a job for execution specified by its model id and a cron string

Aviation Data Hub API - Baggage Vertical

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.

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.

Query bag tags based on given search criteria.Query bag tags by flight segment based on given search criteria.

Force Terminate Connection

Disconnects charger

List Devices List Events

VDV-261-Interface API

Communicate VDV-261 parameters to the backend system

Carbon Footprint Indicator for Transportation API

calculate /calculate/jobScheduler /calculate/result

Battery Passport API

passports-{passport_id}-auditLogs

Get the transaction event history of a private passport Get the audit log of a certain event id.Get all attribute changes between two events.

passports-{passport_id}

Get private passport of a battery Update a passport of a battery Delete a private passport of a battery Restores a passport of a battery

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 info Retrieve 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.

Get user by user name Add user Update user sends feedback to siemens

Resource Access Management API

Get a policy Update a policy.Delete a policy.

List all policies.Create a policy.

resourceGroups-{id}

Get a resource group Update a resource group.Delete a resource group.

List all resource groups.Create a resource group.

Data Contextualization - Data Contextualization APIs

Retrieves DataLake for a given DataLake Id Updates base path for a given data lake type

Retrieves all DataLakes Creates a data lake record with a given data lake type and base path

iotDataRegistries

Retrieves an IoT Data Registry entries Add a new IoT Data Registry entry

dataRegistries-{id}

Retrieves Data Registry for a given registry id Updates a Data Registry Delete Data Registry by registry id

Retrieves Data Registry entries Add a new Data Registry entry

dataTypes-{name}

Retrieves datatype for a given datatype name Deletes custom datatype for a given datatype name Updates Datatype

Retrieves the custom datatypes for the current tenant.Custom datatype registration.

ingestJobStatus

Retrieve a list of jobIds.Retreive the job status.

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

Retrieve query by query id Update query by query id Delete query by query id

Retrieve all queries Create new queries.

executionJobs-{id}

Retrieve job details by job id Delete job by job id Retrieve query results by job id

Retrieve all jobs

ontologies-{id}

Retrieve ontology.Delete ontology

Retrieve all ontologies

Upload file and submit job for create/update ontology Retrieve status of ontology creation/updation job

Generates the regular expression patterns for a given set of sample values Upload 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 document Posts a specific revision.

public/api-projects/v1/dbs/{dbid}/projects-{projid}-documents/{docid}

Downloads a document based on document Id Gets the revisons of a document Posts a new redlining document for a specific revision.

public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}-specs

Get the specifications for an object Updates the specifications for an object Validates the specifications update

public/api-projects/v1/dbs/{dbid}/projects-{projid}-objects-{objid}

Gets an object Deletes the COMOS Object Updates the given object Upload 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 hierarchy Updates 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 overlays Create a working layer

public/api-projects/v1/dbs/{dbid}/projects-{projid}-languages

Gets a collection of supported languages Gets default project language

public/api-projects/v1/dbs/{dbid}/projects-{projid}

Performs revision step on given revision.Gets the object properties Gets 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 user Remove the session based on session Id Update the specified session (heartbeat) passed

Provides discovery services for public apis EStamp the given pdf document.Get the details of the current user

customers/{customerId}

List Partitions for Customer List 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/BROKEN Delete a registration by Id Validates 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.

Gets all registrations for the tenant Create a registration for specific assets and destination.

Identity Management API

Groups-{id}-members

List members of a group Add member to a group Delete member from a group

Get group Update group.Delete group

Create external group mapping Get external group mapping

List all the groups of a tenant.Create group Unmap external group mapping

Get user Update user Delete user

List of users of a tenant.Create user Get 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 secret Update OAuth client's secret Delete old OAuth client's secret

provider/oauth/clients/{id}

Get OAuth client details

Updating the specific IDP with attribute mapping for external group

projects-{id}-nodes

Read project's nodes Create or replace flow nodes Starts a flow

Read the project Rename a project Delete a project

Reads all projects of the specified user Create new project

Rules Management API

Get rule by ID Delete a single rule Update existing rule Patch existing rule

Get a list of rules Add a new rule

IoT Time Series API

timeseries-{entityId}/{propertySetName}

Retrieve time series data Create or update time series data Create or merge time series data Delete time series data

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 model Updates the last version metadata information of a model, without allowing updates to the model payload itself Deletes the last version of a model

models-{modelId}-versions-{versionId}

Retrieves the version payload or the version metadata Deletes the specified version of a model and the corresponding metadata

models-{modelId}-versions

Creates a new model version Retrieves 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

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 type Deletes a file assignment from an asset type

assettypes-{id}

Create or Update an asset type Patch an asset type Read an asset type Delete an asset type Update variables from an asset type

List all asset types

aspecttypes-{id}

Create or Update an aspect type Patch an aspect type Read an aspect type Delete aspect type patch aspect type variables

List all aspect types

assets-{id}-fileAssignments/{key}

Save an file assignment to an asset Deletes a file assignment from an asset

assets-{id}-location

Create or Update location assigned to given asset Delete location assigned to given asset.

Returns an asset.Update an asset Patch an asset Delete an asset Move an asset Get all variables of an asset Get all aspects of an asset

List all available assets Create an asset Returns the root asset of the user.

Returns a file's metadata by its id Update a file Delete a file.Returns a file by its id

Upload files to be used in Asset Management.Get metadata of uploaded files.

Returns lock state of an asset model.Enable/disable lock state of an asset model.

List all links for available resources

Transaction Management API

Get transactions Get info of a specific transaction

Aviation Data Hub - Asset Vertical

Query asset by id.Delete a single asset.Patch asset by id.

Search assets by search criteria.Change an asset.Create an asset.Delete all assets.

Search System State Events by Search Criteria.Post a system state event.

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 id Update a subtenant by id Delete a subtenant by id

Get subtenants Create a subtenant

legalConfigRegions-{regionId}

Update a region configuration of current tenant Delete legal information configuration of a region

legalConfigRegions

Get the complete legal information configuration of current tenant Creates tenant legal information Delete the complete legal information configuration of current tenant

Get specific legal information Get the region specific legal information for a given tenant with fallback logic to core tenant

tenantInfo-logo

Get tenant logo Upload tenant logo Delete tenant logo

Get tenant info Patch tenant info Get tenant logo metadata

Get the region specific legal information for a given tenant without fallback logic

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 Id Deletes a delivery job and its related commands.

Create a delivery job Get all delivery jobs

addresses-{addressId}

Get Address Update Address Delete Address

List Addresses Create Address

locations-{locationId}-relationships

List/Get isPartOf relationships for the Location List/Get hasParts relationships for the Location List/Get hasAssets relationships for the Location

locations-{locationId}

Get Location Update Location Delete Location

List Locations Create Location

assets/{assetId}/relationships/has-location

Update hasLocation List/Get hasLocations relationships for the Asset

equipment-{equipmentId}

Get Equipment Update Equipment Delete Equipment

List Equipments Create Equipment

equipment-types

List EquipmentTypes Get EquipmentType

point-groups-{point-groupId}-points

List Points Create Point

point-groups-{point-groupId}-relationships/has-points

Add hasPoints Delete hasPoints

point-groups-{point-groupId}

Get PointGroup List PointValues

List PointGroups

List Countries List TimeZones List BuildingTypes

Building Geometry API

floorplans-{floorplanId}-floorplan-images

List Floorplan Images Get Floorplan Image

floorplans-{floorplanId}-geometry

List Geometry Get Geometry Center Point Get Geometry

floorplans-{floorplanId}

List Floorplans

palettes-{paletteId}/symbols

List Symbols Get Symbol Palette by ID

MindConnect MQTT API

caCertificates-{id}

Get CA Certificate Delete CA certificate.Verify CA certificate Get registration code

Upload CA certificate Get CA certificates

agentCertificates-{id}

Get Auto Generated Agent Certificate Delete Auto Generated Agent Certificate.

agentCertificates

Create Auto Generated Agent Certificate Get Auto Generated Agent Certificates

SDI - Semantic Data Interconnect APIs

Retrieves DataLake for a given DataLake Id Updates base path for a given data lake type

Retrieves all DataLakes Creates a data lake record with a given data lake type and base path

iotDataRegistries

Retrieves an IoT Data Registry entries Add a new IoT Data Registry entry

dataRegistries-{id}

Retrieves Data Registry for a given registry id Updates a Data Registry

Retrieves Data Registry entries Add a new Data Registry entry

dataTypes-{name}

Retrieves datatype for a given datatype name Deletes custom datatype for a given datatype name Updates Datatype

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

Retrieve query by query id Update query by query id Delete query by query id

Retrieve all queries Create new queries

executionJobs-{id}

Retrieve job details by job id Delete job by job id Retrieve query results by job id

Retrieve all jobs

ontologies-{id}

Retrieve ontology.Delete ontology

Retrieve all ontologies

Upload file and submit job for create/update ontology Retrieve status of ontology creation/updation job

Generates the regular expression patterns for a given set of sample values Upload 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

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-obsolescence get-delivery

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 batterypassid Update public and private battery passport attributes by providing the batterypassid Delete battery passport by providing the batterypassid Restore

Get list of a user's private passes given a certain state Create a new passport in its entirety

Get user by user name Add user Update user

Work Order Management API

workorders-{woHandle}

Retrieves work order for given work order handle Update work order for given work order handle Delete work order for given work order handle Partial update attachments work order for given work order handle Partial update associations work order for given work order handle Partial update externalSystems work order for given work order handle

Get list of work orders Create work order Get list of work orders activities Get 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.

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.

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 SiGREEN Get a list Bill of Material entries for a product in SiGREEN

products-{productId}

Offset your emissions.

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.

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.

Delete an unused factory for a company in SiGREEN.Update a factory for a company in SiGREEN.

Get factories for a company in SiGREEN.Create a factory for a company in SiGREEN.

Event Management API

events-{eventId}

Get an event Update an event

Create new event Query events

eventTypes-{eventTypeId}

Update an event type Get an event type Delete an event type

Create new event type Query event types

deleteEventsJobs

Create a delete events job Get a delete events job

createEventsJobs

Create a create events job Get a create events job

Info about the API

VPP Integration API

vppController/{siteId}-energyPrices

Write VPP energy prices Get VPP energy prices

vppController/{siteId}

Get calculated power consumption

Case Management API

cases-{handle}-comments-{id}

Partial update comment for given case handle Delete case comment for given case handle

cases-{handle}-comments

Create comment for given case handle Get list of case comments for given case handle

Retrieves case for given case handle Update case for given case handle Delete case for given case handle Partial update attachments case for given case handle Partial update associations case for given case handle Partial update externalSystems case for given case handle Partial update tags of case for given case handle

Get list of cases Create case Get list of cases activities Get list of cases comments Get 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 returned Get 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 returned Get 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.

Query flight legs based on given search criteria.

devices-{deviceId}-events-{eventId}

Get Event Lists event transition history

devices-{deviceId}-events

devices-{deviceId}

Get Device Patch device attributes List Devices behind a Gateway List Points

List Devices Create device

points/{pointId}-values

Get Point Values Add Point Values

points/{pointId}-alarm-configurations-{alarmConfigurationId}

Get Alarm Configuration by ID Update Alarm Configuration by ID Delete Alarm Configuration by ID

points/{pointId}-alarm-configurations

List AlarmConfigurations Create new Alarm Configuration

points/{pointId}

Get Point Update Point - Set Value

List Locations Get 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 measurement Get the threshold for the given measurement id.

Get measurements

measurementGroups

Get measurement groups Get 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.

Retrieve information about all eligible fleets of assets.

OAuth Authorization Server

Client Credentials Grant Token keys endpoint

Remote Services API

Retrieve a tenant Delete a tenant

Create a new tenant List all tenants

organizations-{id}

Retrieve an organization Delete an organization List owners of an organization List an organization's ownership history List appointed owners for an organization Add a user as an owner to an organization Remove a user's organization owner status from an organization Update an organization's name

Create a new organization List all organizations

Retrieve a user Delete a user Get organizations a user has access to Get a user's roles in an organization Get a user's all grants in an organization Update a user's first and last name Update a user's company Update a user's country Activate a user's account Suspend a user's account

Create a new user List all users

external-users-{id}

Retrieve an external user referral Rescind the referral of an external user Admit a pending external user Revoke an admitted external user Reject a referred external user

Refer an external user to an organization List all external users List all external user referrals audit records Revoke all admitted external users Reject all external users by their status

user-groups-{id}

Retrieve a usergroup Delete a usergroup List all users in a usergroup Update a usergroup's name Add a user to a usergroup Remove a user from a usergroup

Create a new usergroup List all usergroups

Retrieve a product node Delete a product node Update a product's name Move product from a parent to another Copy product from a parent to another

Create a new product node List all product nodes

Retrieve a node Delete a node Update a node's name Move a node to another parent

Create a new node List all nodes

Retrieve a site Delete a site Update a site's name Update a site's contact email Update a site's timezone Update a site's country Move a site to another parent

Create a new site List all sites

connectors-{id}

Retrieve a connector Delete a connector Update connector's name Update connector's description Enforce permission for connector Do not require a permission for connector Set idle timeout configuration to be infinite Update connector's idle timeout configuration Update connector's parameters

Create a new connector List all connectors

user-grants-{id}

Retrieve a user grant Delete a user grant

Create a new user grant List all user grants

user-group-grants-{id}

Retrieve a usergroup grant Delete a usergroup grant

user-group-grants

Create a new usergroup grant List all usergroup grants

Retrieve a user session info List 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 jobs Shows 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.

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.

Shows the details of the specified template.Update the specified template definition.Delete the specific template definition.Download the template file for review

Create a template for notification.Shows a list of templates.

DepotFinity Token Management API

Home Lifecycle Twin API clientprojects-{id}Client Projects Delete One

Client Projects Delete One

DELETE {{baseUrl}}/clientprojects/:id

HEADERS

Key	Datatype	Required	Description
`clientname`	string		(Required) Portfolio name
`projectId`	string		UUID of a site

Client Projects Put One