Profile

Get profiles

get

Retrieve a list of profiles for a specific hub ID optionally filtered by profile IDs

Path parameters

hidstring · min: 6 · max: 6Required

Hub ID of the profiles

Example: 000001Pattern: \b^[0-9A-F]{6}$\b

Query parameters

pidsstringOptional

JSON array of profile IDs to retrieve e.g. pids=["0001","01FF","00A0"] or all profiles if not specified

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

408

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/historian/v3/profile/{hid}

HTTPcURLJavaScriptPython

GET /api/historian/v3/profile/{hid} HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "data": [
    {
      "header": {
        "pid": "002F",
        "profileName": "text",
        "description": "text",
        "uiname": "text",
        "group": "text",
        "tags": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "from": "text"
          }
        }
      },
      "resources": [
        {
          "rid": "40",
          "name": "text",
          "type": "bool",
          "uiname": "text",
          "attribute": true,
          "settings": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "tags": {
            "ANY_ADDITIONAL_PROPERTY": {
              "value": "text",
              "from": "text"
            }
          }
        }
      ]
    }
  ]
}

Get profile PIDs

get

Retrieve a list of all profile PIDs for a specific hub ID

Path parameters

hidstring · min: 6 · max: 6Required

Hub ID of the profiles

Example: 000001Pattern: \b^[0-9A-F]{6}$\b

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

408

Default Response

application/json

422

Default Response

application/json

500

Default Response

application/json

get

/api/historian/v3/profile/{hid}/pids

HTTPcURLJavaScriptPython

GET /api/historian/v3/profile/{hid}/pids HTTP/1.1
Accept: */*

{
  "ts": "2025-01-01T00:00:00.000Z",
  "data": [
    "0001",
    "01FF",
    "00A0"
  ]
}