How to Retrieve Assets

There are two endpoints dedicated to retrieving information related to the assets of the current project.

The first endpoint, which can be used with the GET method, is as follows:

get

Return the list of assets. At the moment also info about assets are returned.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Query parameters

filterstringOptional

Filtro basato sui campi supportati.

Responses

200

OK

application/json

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

get

/assets

HTTPcURLJavaScriptPython

GET /assets HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[]

For example, if you wanted to retrieve all the assets of the project, you could simply invoke the Data Manager in this way:

https://myProject.40mat.com/dm/assets

This would yield a response of the following type:

[
  {
    "machineId": "40-line-1",
    "machineName": "40-line-1",
    "timezone": "Europe/Rome",
    "typeId": "40factory.FACTORY",
    "location": {
      "country": "Italy",
      "latitude": 45.0480,
      "locality": "Piacenza",
      "longitude": 9.6922,
      "postalCode": "29121",
      "streetAddress": "Via A. Callegari"
    }
  },
  {
    "machineId": "40-line-2",
    "machineName": "40-line-2",
    "timezone": "Europe/Rome",
    "typeId": "40factory.FACTORY",
    "location": {
      "country": "Italy",
      "latitude": 45.0480,
      "locality": "Piacenza",
      "longitude": 9.6922,
      "postalCode": "29121",
      "streetAddress": "Via A. Callegari"
    }
  },
]

Within the query, it is possible to indicate a parameter named "filter" in which to specify a string to filter the data that will be returned. For example, you can filter out machines that do not belong to a certain timezone, retrieve data only from a specific machine, or get a list of all machines of a certain type.

Some usage examples are provided below:

https://myProject.40mat.com/dm/assets?filter={"machineId":"40-line-1"}

This call allows for retrieving only the machine named "40-line-1".

https://myProject.40mat.com/dm/assets?filter={"timezone": "Europe/Rome", "typeId": "40factory.FACTORY"}

This call enables retrieving all machines that have the timezone "Europe/Rome" and simultaneously the type is "40factory.FACTORY".

For the syntax to use in constructing the filters, refer to the page General Rules of the Data Manager.

The second method to obtain information about the assets refers to an endpoint that, taking the ID of a machine of interest, allows returning all the data related to that machine. The endpoint to use with the GET method is as follows:

get

Return the data representing the specified asset.

Authorizations

thirdPartyAuth

AuthorizationstringRequired

The identity provider authentication token.

Path parameters

assetIdstringRequired

Asset instance ID.

Responses

200

Success.

application/json

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

500

Internal server error.

503

Service temporarily unavailable.

504

Timeout.

get

/assets/{assetId}

HTTPcURLJavaScriptPython

GET /assets/{assetId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "assetId": "ae0be0a8a06ce0a6e3b63c2083",
  "assetName": "Asset 2",
  "customer": "Customer 1"
}

As can be seen, it is necessary to add the ID of the asset being analyzed in the URL. The response will contain only the information of the requested machine.