Industrial Asset Hub

https://industrial-assets.io/developers/
Admin
Industrial Asset Hub is a Siemens platform that provides a centrally hosted cloud service and...
Tokens:148,636
Snippets:1,672
Trust Score:5.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /hierarchies

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Get details of first context folder/root node for hierarchies.

```APIDOC
## GET /hierarchies

### Description
Get details of first context folder/root node for hierarchies.

### Method
GET

### Endpoint
/hierarchies
```

--------------------------------

### GET /jobs

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Retrieve a list of all file import jobs.

```APIDOC
## GET /jobs

### Description
Retrieve all file import jobs.

### Method
GET

### Endpoint
/jobs
```

--------------------------------

### GET /jobs

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Retrieve all IAH jobs.

```APIDOC
## GET /jobs

### Description
Retrieve all IAH jobs irrespective of the type of job.

### Method
GET

### Endpoint
/jobs
```

--------------------------------

### GET /instances/{instanceId}

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Retrieve a particular credential instance based on its ID.

```APIDOC
## GET /instances/{instanceId}

### Description
Retrieve a particular credential instance based on its ID.

### Method
GET

### Endpoint
/instances/{instanceId}

### Parameters
#### Path Parameters
- **instanceId** (string) - Required - The unique identifier of the credential instance.
```

--------------------------------

### GET /nodes/{nodeId}

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Get the details of the a node/root node/subgroup for a particular hierarchy.

```APIDOC
## GET /nodes/{nodeId}

### Description
Get the details of the a node/root node/subgroup for a particular hierarchy.

### Method
GET

### Endpoint
/nodes/{nodeId}

### Parameters
#### Path Parameters
- **nodeId** (string) - Required - The ID of the node.
```

--------------------------------

### GET /nodes/{nodeId}/children

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Get the direct children for a parent node for a particular hierarchy.

```APIDOC
## GET /nodes/{nodeId}/children

### Description
Get the direct children for a parent node for a particular hierarchy.

### Method
GET

### Endpoint
/nodes/{nodeId}/children

### Parameters
#### Path Parameters
- **nodeId** (string) - Required - The ID of the parent node.
```

--------------------------------

### POST /files

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Import asset information into the system using an *.xlsx file.

```APIDOC
## POST /files

### Description
Import asset information into the system using an *.xlsx file. Use the IAH import template for uploading.

### Method
POST

### Endpoint
/files
```

--------------------------------

### Obtain a JWT from a Server User

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Use the token service to exchange server user credentials for a JSON Web Token.

```bash
curl https://iahprod.eu1.sws.siemens.com/oauth/token \
 -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  -d grant_type=client_credentials \
  -d client_id=<clientId> \
  -d client_secret=<clientSecret>
```

--------------------------------

### POST /hierarchies

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Add a context folder of the hierarchy.

```APIDOC
## POST /hierarchies

### Description
Add a context folder of the hierarchy.

### Method
POST

### Endpoint
/hierarchies
```

--------------------------------

### Access API with JWT

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Include the obtained JWT in the Authorization header to authenticate API requests.

```bash
curl --header "Authorization: Bearer your_jwt_token" https://cloud.eu1.sws.siemens.com/api/assethubapi/v1/your_endpoint
```

--------------------------------

### POST /nodes/{nodeId}/children

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Add a subgroup folder of the hierarchy.

```APIDOC
## POST /nodes/{nodeId}/children

### Description
Add a subgroup folder of the hierarchy.

### Method
POST

### Endpoint
/nodes/{nodeId}/children

### Parameters
#### Path Parameters
- **nodeId** (string) - Required - The ID of the parent node.
```

--------------------------------

### POST /updates/lookup

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Lookup update information by ID Link.

```APIDOC
## POST /updates/lookup

### Description
Lookup update information by ID Link.

### Method
POST

### Endpoint
/updates/lookup
```

--------------------------------

### Credential Management API Endpoints

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Endpoints for managing credential instances, schemas, and asset mappings.

```APIDOC
## GET /instances/{instanceId}
Retrieve particular credential instance based on Id.

## DELETE /instances/{instanceId}
Delete the credential instance based on id.

## PATCH /instances/{instanceId}
Updates the credential instance based on Id.

## PUT /instances/gateways/{gatewayId}/schemas/{schemaId}
Add a new credential instance for a particular gateway and tenant.

## GET /instances/gateways/{gatewayId}/schemas/{schemaId}
Retrieve all instances of particular gateway and schema for a tenant.

## GET /instances/gateways/{gatewayId}/resources/{resourceIdentifier}/{resourceVersion}
Get all credentials based on the gateway and resource for specific parameter set.

## GET /schemas/{schemaId}
Get the schema based on its Id.

## DELETE /schemas/{schemaId}
Delete the schema based on id.

## GET /schemas/resources/{resourceIdentifier}/{resourceVersion}
Get the schema of a particular resource identifier and version.

## PUT /schemas/resources/{resourceIdentifier}/{resourceVersion}
Add a new schema for particular resource identifier and version in form of json.

## GET /assets/{assetId}/instances
Retrieve particular credential instance based on asset Id.
```

--------------------------------

### PATCH /nodes/{nodeId}

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Updates the node/context folder/subgroup based on Id for a hierarchy.

```APIDOC
## PATCH /nodes/{nodeId}

### Description
Updates the node/context folder/subgroup based on Id for a hierarchy.

### Method
PATCH

### Endpoint
/nodes/{nodeId}

### Parameters
#### Path Parameters
- **nodeId** (string) - Required - The ID of the node.
```

--------------------------------

### DELETE /jobs/{jobId}

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Deletes a specific remote connection job.

```APIDOC
## DELETE /jobs/{jobId}

### Description
Delete a remote connection job.

### Method
DELETE

### Endpoint
/jobs/{jobId}
```

--------------------------------

### PATCH /jobs/{jobId}/cancel

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Cancels an active remote access job.

```APIDOC
## PATCH /jobs/{jobId}/cancel

### Description
Cancel a remote access job for given jobId.

### Method
PATCH

### Endpoint
/jobs/{jobId}/cancel
```

--------------------------------

### DELETE /nodes/{nodeId}

Source: https://industrial-assets.io/developers/programing-interface/programing-interface.html

Delete the node/subgroup based on id for a particular hierarchy.

```APIDOC
## DELETE /nodes/{nodeId}

### Description
Delete the node/subgroup based on id for a particular hierarchy.

### Method
DELETE

### Endpoint
/nodes/{nodeId}

### Parameters
#### Path Parameters
- **nodeId** (string) - Required - The ID of the node.
```
Tokens:
Raw