Asset Management¶

Building¶

Get all buildings of a site¶

GET /facilities

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
pagination	(mandatory)
select	(mandatory)

Specification and schema can be found in the API Reference

Response:

[
    {
        "Name": "Mapping test",
        "Address": "13",
        "ShortId": 15,
        "Specifications": [],
        "CustomFields": [],
        "CreatedOn": "2025-03-27T17:05:13.147Z",
        "ModifiedOn": "2025-03-28T13:14:57.21Z",
        "Id": "45902784-c0e8-430c-87fe-1454dd82b88c",
        "CreatedOnLocal": "2025-03-27T18:05:13.147+01:00",
        "ModifiedOnLocal": "2025-03-28T14:14:57.21+01:00"
    },
    {
        "Name": "Siemens HQ (TH1C)_DE",
        "Description": "Building Type - office",
        "City": "Zug",
        "Longitude": 47.1661672,
        "Latitude": 8.5154946,
        "ShortId": 6,
        "Specifications": [],
        "CustomFields": [],
        "CreatedOn": "2023-10-19T08:14:12.013Z",
        "ModifiedOn": "2025-03-18T05:57:57.78Z",
        "Id": "d5ed6946-1bed-48dd-82d5-54398082e75b",
        "CreatedOnLocal": "2023-10-19T10:14:12.013+02:00",
        "ModifiedOnLocal": "2025-03-18T06:57:57.78+01:00"
    }
]

Create Building¶

POST /facilities

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier

Specification and schema can be found in the API Reference

Body:

{
    "Name": "Building 1",
    "Description": "",    
}

Response:

{
    "Value": "f05ef55f-c84b-4769-98aa-1752f9c74b51"
}

Update Building¶

PUT /facilities/{buildingId}

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
select	(mandatory) Fields to update

Specification and schema can be found in the API Reference

Body:

{
    "Name": "Building 1",
    "Description": "Main building",    
}

Floors¶

Get all floors of a site¶

GET /floors

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
pagination	(mandatory)
select	(mandatory)
filter	(optional) {"equals":{"Facility.Id":"f1646641-a4bd-4e78-a65d-371691c53cc0"}}

Specification and schema can be found in the API Reference

Response:

[
    {
        "Name": "Floor Level 9 - Building 9",
        "Facility": {
            "Name": "Building9",
            "ShortId": 0,
            "Specifications": [],
            "CustomFields": [],
            "Id": "f1646641-a4bd-4e78-a65d-371691c53cc0"
        },
        "Locations": [],
        "LocationsCount": 0,
        "GrossArea": 0.0,
        "NetArea": 0.0,
        "CreatedOn": "2025-03-10T06:38:35.107Z",
        "CreatedBy": {
            "UserId": "4c5b7447-c36a-4180-9758-b5577d5ab973",
            "Name": "Shivani Bhilare",
            "PasswordExpired": false,
            "FullNameWithCompany": "Shivani Bhilare",
            "SystemGroup": 0,
            "IsLicenseAccepted": false,
            "IsActive": false,
            "Id": "4c5b7447-c36a-4180-9758-b5577d5ab973"
        },
        "ModifiedOn": "2025-03-26T12:59:02.727Z",
        "ModifiedBy": {
            "UserId": "497a0cb6-98bd-4538-84c9-5dfc03759197",
            "Name": "Bhushan Goyanka",
            "PasswordExpired": false,
            "FullNameWithCompany": "Bhushan Goyanka",
            "SystemGroup": 0,
            "IsLicenseAccepted": false,
            "IsActive": false,
            "Id": "497a0cb6-98bd-4538-84c9-5dfc03759197"
        },
        "Id": "6aee3485-6576-4b38-bb8a-8a0e0f22605c",
        "CreatedOnLocal": "2025-03-10T06:38:35.107+00:00",
        "ModifiedOnLocal": "2025-03-26T12:59:02.727+00:00"
    }
]

Create floor¶

POST /floors

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier

Specification and schema can be found in the API Reference

Body:

{
    "Name": "Floor 1",
    "Facility": { 
        "Id": "f05ef55f-c84b-4769-98aa-1752f9c74b51"
    }
}

Response:

{
    "Value": "6cf7a7c3-f386-4b85-a3ed-6c0c48f9b6bd"
}

Update floor¶

PUT /floors/{floorId}

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
select	(mandatory) Fields to update

Specification and schema can be found in the API Reference

Body:

{
    "Name": "Floor 1 - updated",
    "GrossArea": 123
}

Rooms¶

Get all rooms¶

GET /locations

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
pagination	(mandatory)
select	(mandatory)
filter	(optional) {"equals":{"Floor.Id":"6cf7a7c3-f386-4b85-a3ed-6c0c48f9b6bd"}}

Specification and schema can be found in the API Reference

Response:

[
    {
        "Name": "Room 1",
        "Description": "Hall",
        "FullName": "Room 1 - Hall",
        "Facility": {
            "Name": "Building 1",
            "ShortId": 0,
            "Specifications": [],
            "CustomFields": [],
            "Id": "f05ef55f-c84b-4769-98aa-1752f9c74b51"
        },
        "Floor": {
            "Name": "Floor 1 - updated",
            "Locations": [],
            "LocationsCount": 0,
            "GrossArea": 0.0,
            "NetArea": 0.0,
            "Id": "6cf7a7c3-f386-4b85-a3ed-6c0c48f9b6bd"
        },
        "GrossArea": 0.0,
        "NetArea": 0.0,
        "Specifications": [],
        "AssetsCount": 0,
        "Assets": [],
        "Attributes": [],
        "LocationContacts": [],
        "Id": "68c5c0d4-e99a-419f-9ab1-b57f2bbd16fa"
    }
]

Create room¶

POST /locations

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier

Specification and schema can be found in the API Reference

Body:

{
    "Name": "Room 1",
    "Description": "Hall",
    "Facility": {
        "Id": "f05ef55f-c84b-4769-98aa-1752f9c74b51"
    },
    "Floor": { 
        "Id": "6cf7a7c3-f386-4b85-a3ed-6c0c48f9b6bd"
    }
}

Response:

{
    "Value": "68c5c0d4-e99a-419f-9ab1-b57f2bbd16fa"
}

Update room¶

PUT /locations/{roomId}

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
select	(mandatory) Fields to update

Specification and schema can be found in the API Reference

Body:

{
    "Description": "Lobby"    
}

Components¶

Get all components¶

GET /assets

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
pagination	(mandatory)
select	(mandatory)
filter	(optional) {"equals":{"Locations[].Id":"6cf7a7c3-f386-4b85-a3ed-6c0c48f9b6bd"}}

Specification and schema can be found in the API Reference

Response:

[
    {
        "Name": "6 x 15 mit Deckprofil",
        "Facility": {
            "Name": "Asset Mapping Test Site",
            "Description": "Building Type - factory",
            "Address": "B000001",
            "Longitude": 35.6952301,
            "Latitude": 139.7835006,
            "ShortId": 13,
            "Specifications": [],
            "CustomFields": [],
            "CreatedOn": "2025-03-03T09:43:59.213Z",
            "ModifiedOn": "2025-03-21T11:39:58.48Z",
            "Id": "8667b2b9-8ef5-4e0d-b6ac-cb03b6d76cb5",
            "CreatedOnLocal": "2025-03-03T09:43:59.213+00:00",
            "ModifiedOnLocal": "2025-03-21T11:39:58.48+00:00"
        },
        "Type": {
            "Name": "Rechteckiger Pfosten: 6 x 15 mit Deckprofil",
            "IsMajor": false,
            "Specifications": [],
            "Assets": [],
            "AssetsCount": 0,
            "CreatedOn": "2025-03-03T09:48:57.613Z",
            "Id": "73377cb6-3ba1-4cce-905f-c68c3e844725",
            "CreatedOnLocal": "2025-03-03T09:48:57.613+00:00"
        },
        "ModifiedOn": "2025-03-03T09:52:36.217Z",
        "NumberOfOpenTasks": 0,
        "LocationsCount": 0,
        "CustomFields": [],
        "Id": "6601d617-551c-4332-8a03-6ebdc078976a",
        "ModifiedOnLocal": "2025-03-03T09:52:36.217+00:00"
    }
]

Create component¶

POST /assets

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier

Specification and schema can be found in the API Reference

Body:

{
    "Name": "AC-OU-1",        
    "Facility": {
        "Id": "f05ef55f-c84b-4769-98aa-1752f9c74b51"
    },
    "Locations": [
        {
            "Id": "68c5c0d4-e99a-419f-9ab1-b57f2bbd16fa"
        }
    ]
}

Response:

{
    "Value": "268e1c76-c984-4fe3-953b-d700dbc4a92b"
}

Update component¶

PUT /assets/{componentId}

Headers:

Parameter	Description
clientname	(mandatory) Portfolio name
authorization	(mandatory) Authentication token
projectId	(mandatory) Project identifier
select	(mandatory) Fields to update

Specification and schema can be found in the API Reference

Body:

{
    "InstallationDate": "2025-01-15"    
}

Types¶

Endpoint - /types

The endpoint is used to manage Types.

Specification and schema can be found in the API Reference

Additional endpoints¶

Endpoint - /types/{typeId}/assemblies

Manages assemblies of a given type. More details you can find in the Assemblies page

Additional endpoints¶

/assets/{assetId}/systems - To manage systems of a component with the given ID.

/assets/{assetId}/assemblies - To manage assemblies of a given component. More details you can find in the Assemblies page

Systems¶

Endpoint - /systems

The endpoint is used to manage systems.

Zones¶

Endpoint - /zone

The endpoint is used to manage Zones.

Additional endpoints¶

/zones/{zoneId}/locations - To manage spaces of a zone with a given ID

Specification and schema can be found in the API Reference