Query hardware models

curl --request GET \
  --url https://{apiHost}/api/v1/sysmodels \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/sysmodels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "terse": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByDeviceDistribution": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByBrandDistribution": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "list": [
    {
      "name": "<string>",
      "title": "<string>",
      "brandId": "<string>",
      "state": "SYS_MODEL_STATE_UNSPECIFIED",
      "type": "UNSPECIFIED",
      "attr": {},
      "originType": "ORIGIN_UNSPECIFIED",
      "id": "<string>",
      "description": "<string>",
      "revision": {
        "curr": "<string>",
        "createdAt": {},
        "createdBy": "<string>",
        "updatedAt": {},
        "updatedBy": "<string>",
        "prev": "<string>"
      },
      "productStatus": "<string>",
      "productURL": "<string>",
      "brandName": "<string>",
      "ioMemberList": [
        {
          "ztype": 1,
          "phylabel": "eth0",
          "logicallabel": "eth0"
        }
      ],
      "logo": {},
      "parentDetail": {
        "idOfParentObject": "<string>",
        "versionOfParentObject": 123,
        "updateAvailable": true,
        "referenceExists": true
      },
      "PCRTemplates": [
        {
          "eveVersion": "<string>",
          "PCRValues": [
            {
              "type": "PCR_TYPE_UNSPECIFIED",
              "index": 123,
              "value": "<string>"
            }
          ],
          "firmwareVersion": "<string>",
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "isImported": true
    }
  ],
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Query Parameters

summary

boolean

Only summary of the records required

namePattern

string

Model name pattern to be matched.

brandId

string[]

System defined universally unique Id of the brand.

originType

enum<string>

default:ORIGIN_UNSPECIFIED

origin of object

ORIGIN_UNSPECIFIED: default options, which says no Operation/Invalid Operation
ORIGIN_IMPORTED: Object imported from global enterprise.
ORIGIN_LOCAL: Objectl created locally.
ORIGIN_GLOBAL: Object created in global store, to use this type user should have root previlage.
ORIGIN_APP_PROFILE_LOCAL: Object created via App profile

Available options:

ORIGIN_UNSPECIFIED,

ORIGIN_IMPORTED,

ORIGIN_LOCAL,

ORIGIN_GLOBAL,

ORIGIN_APP_PROFILE_LOCAL

includeGlobal

boolean

Include global models that are not imported.

titlePattern

string

Model title pattern to be matched.

next.pageToken

string

Page Token

next.orderBy

string[]

OrderBy helps in sorting the list response

next.pageNum

number<int64>

Page Number

next.pageSize

number<int64>

Defines the page size

next.totalPages

number<int64>

Total number of pages to be fetched.

Response

A successful response.

SysModels used when listing the available models, if consists of various model attributes like terse, model list and next filter.

terse

Summary is used to store the Summary details · object

Summary of filtered model records

Show child attributes

summaryByDeviceDistribution

Summary is used to store the Summary details · object

Summary by device distribution

Show child attributes

summaryByBrandDistribution

Summary is used to store the Summary details · object

Summary by brand distribution

Show child attributes

list

SysModel payload details · object[]

List of filtered Sys Models

Show child attributes

Cursor is used as filter in list operation. · object

Responded page details of filtered records

Show child attributes

⌘I

Query hardware models

curl --request GET \
  --url https://{apiHost}/api/v1/sysmodels \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/sysmodels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "terse": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByDeviceDistribution": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByBrandDistribution": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "list": [
    {
      "name": "<string>",
      "title": "<string>",
      "brandId": "<string>",
      "state": "SYS_MODEL_STATE_UNSPECIFIED",
      "type": "UNSPECIFIED",
      "attr": {},
      "originType": "ORIGIN_UNSPECIFIED",
      "id": "<string>",
      "description": "<string>",
      "revision": {
        "curr": "<string>",
        "createdAt": {},
        "createdBy": "<string>",
        "updatedAt": {},
        "updatedBy": "<string>",
        "prev": "<string>"
      },
      "productStatus": "<string>",
      "productURL": "<string>",
      "brandName": "<string>",
      "ioMemberList": [
        {
          "ztype": 1,
          "phylabel": "eth0",
          "logicallabel": "eth0"
        }
      ],
      "logo": {},
      "parentDetail": {
        "idOfParentObject": "<string>",
        "versionOfParentObject": 123,
        "updateAvailable": true,
        "referenceExists": true
      },
      "PCRTemplates": [
        {
          "eveVersion": "<string>",
          "PCRValues": [
            {
              "type": "PCR_TYPE_UNSPECIFIED",
              "index": 123,
              "value": "<string>"
            }
          ],
          "firmwareVersion": "<string>",
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "isImported": true
    }
  ],
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Query hardware models

Authorizations

Headers

Query Parameters

Response