Import hardware model to local enterprise if it is not already imported and return imported model information.

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

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

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

{
  "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
}

{
  "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

This operation can change resources or access. After signing in, open API request settings and select Enable modifying requests, then Apply settings, to use its playground. Check the request body and destination before selecting Send. Your existing API permissions still apply.

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

string

required

System defined universally unique Id of the model

Response

A successful response.

SysModel consists of various model attributes like id, name, title, brandId etc

name

string

required

user defined model name

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

title

string

required

User defined title of the model. Title can be changed at any time.

Required string length: 3 - 256

Pattern: [a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+

brandId

string

required

System defined universally unique Id of the brand.

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12

state

enum<string>

default:SYS_MODEL_STATE_UNSPECIFIED

required

SysModel State which denotes the status of the model

Available options:

SYS_MODEL_STATE_UNSPECIFIED,

SYS_MODEL_STATE_ARCHIVE,

SYS_MODEL_STATE_ACTIVE

type

enum<string>

default:UNSPECIFIED

required

Defines the Architecture type of the model

Available options:

UNSPECIFIED,

UNDEFINED,

AMD64,

ARM64

attr

object

required

Map of <string, string> which defines attr

Show child attributes

originType

enum<string>

default:ORIGIN_UNSPECIFIED

required

origin of object

Available options:

ORIGIN_UNSPECIFIED,

ORIGIN_IMPORTED,

ORIGIN_LOCAL,

ORIGIN_GLOBAL,

ORIGIN_APP_PROFILE_LOCAL

string

read-only

System defined universally unique Id of the model.

Pattern: [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

description

string

Detailed description of the model.

Maximum string length: 256

revision

ObjectRevision is used to store the user information. · object

Object Revision of the model

Show child attributes

productStatus

string

Product status

productURL

string

Product URL

brandName

string

Brand name.

ioMemberList

ioMember payload details · object[]

List of IoMembers

Show child attributes

logo

object

Map of <string, string> which holds the key:url for the logo artifact of the model

Show child attributes

parentDetail

Object Import Detail · object

origin and parent related details

Show child attributes

PCRTemplates

PCR template · object[]

PCR templates keyed by EVE version

Show child attributes

isImported

boolean

Flag to represent whether sysModel is imported

⌘I

Import hardware model to local enterprise if it is not already imported and return imported model information.

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

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

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

{
  "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
}

{
  "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

Import hardware model to local enterprise if it is not already imported and return imported model information.

Authorizations

Headers

Path Parameters

Response