AssetDatabase GetTableCategories

Retrieve table categories for a given Asset Database.

Request

GET assetdatabases/{webId}/tablecategories

URL Parameters

• webId

  The ID of the database. See WebID for more information.

• selectedFields

  List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields for more information.

• webIdType

  Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.

Status Codes

200: The table categories on the specified database.

Sample Response Body

{
  "Items": [
    {
      "WebId": "I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ",
      "Id": "89c70cc2-5221-4e77-873f-894a3ea61e7d",
      "Name": "CategoryName",
      "Description": "Relative energy use per ton of process feed.",
      "Path": "\\\\MyAssetServer\\Database\\CategoriesTable[CategoryName]",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/tablecategories/I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ"
      }
    },
    {
      "WebId": "I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ",
      "Id": "89c70cc2-5221-4e77-873f-894a3ea61e7d",
      "Name": "CategoryName",
      "Description": "Relative energy use per ton of process feed.",
      "Path": "\\\\MyAssetServer\\Database\\CategoriesTable[CategoryName]",
      "Links": {
        "Self": "https://localhost.osisoft.int/piwebapi/tablecategories/I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ"
      }
    }
  ],
  "Links": {}
}