Update hardware brand

curl --request PUT \
  --url https://{apiHost}/api/v1/brands/id/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "originType": "ORIGIN_UNSPECIFIED"
}
'

import requests

url = "https://{apiHost}/api/v1/brands/id/{id}"

payload = {
    "name": "<string>",
    "title": "<string>",
    "originType": "ORIGIN_UNSPECIFIED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', title: '<string>', originType: 'ORIGIN_UNSPECIFIED'})
};

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

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

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

Body

application/json

SysModel consists of various brand attributes like id, name, title, svg, state, systemMfgName

name

string

required

user defined sys brand name

Required string length: 3 - 256

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

title

string

required

user defined title for sys brand

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

originType

enum<string>

default:ORIGIN_UNSPECIFIED

required

origin of object

Available options:

ORIGIN_UNSPECIFIED,

ORIGIN_IMPORTED,

ORIGIN_LOCAL,

ORIGIN_GLOBAL,

ORIGIN_APP_PROFILE_LOCAL

description

string

Detailed description of the image.

Maximum string length: 256

svg

string

Deprecated: base64 encoded string of svg file

attr

object

Map of <string, string>

Show child attributes

state

enum<string>

default:SYS_MODEL_STATE_UNSPECIFIED

Sys Model Status

Available options:

SYS_MODEL_STATE_UNSPECIFIED,

SYS_MODEL_STATE_ARCHIVE,

SYS_MODEL_STATE_ACTIVE

revision

ObjectRevision is used to store the user information. · object

Object Revision of the sys brand

Show child attributes

systemMfgName

string

System Manufacturer name

logo

object

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

Show child attributes

Response

A successful response.

operationType

enum<string>

default:OPS_TYPE_UNSPECIFIED

Available options:

OPS_TYPE_UNSPECIFIED,

OPS_TYPE_READ,

OPS_TYPE_DELETE,

OPS_TYPE_CREATE,

OPS_TYPE_UPDATE,

OPS_TYPE_LIST

operationStatus

enum<string>

default:OPS_STATUS_UNSPECIFIED

OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING
OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.
OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases.

Available options:

OPS_STATUS_UNSPECIFIED,

OPS_STATUS_PENDING,

OPS_STATUS_ONGOING,

OPS_STATUS_COMPLETE

objectKind

string

objectId

string

objectName

string

objectRevision

string

objectType

enum<string>

default:OBJECT_TYPE_UNSPECIFIED

Available options:

OBJECT_TYPE_UNSPECIFIED,

OBJECT_TYPE_USER,

OBJECT_TYPE_EDGE_NODE,

OBJECT_TYPE_EDGE_APP,

OBJECT_TYPE_IMAGE,

OBJECT_TYPE_EDGE_APP_INSTANCE,

OBJECT_TYPE_PROJECT,

OBJECT_TYPE_NETWORK,

OBJECT_TYPE_DATASTORE,

OBJECT_TYPE_SERVICE,

OBJECT_TYPE_SERVICE_INSTANCE,

OBJECT_TYPE_ENTERPRISE,

OBJECT_TYPE_ROLE,

OBJECT_TYPE_CREDENTIAL,

OBJECT_TYPE_NETWORK_INSTANCE,

OBJECT_TYPE_VOLUME_INSTANCE,

OBJECT_TYPE_REALM,

OBJECT_TYPE_AUTHPROFILE,

OBJECT_TYPE_POLICY,

OBJECT_TYPE_APP_POLICY,

OBJECT_TYPE_CLUSTER_INSTANCE,

OBJECT_TYPE_PLUGIN,

OBJECT_TYPE_DOC_POLICY,

OBJECT_TYPE_ORCHESTRATOR_CLUSTER,

OBJECT_TYPE_TAGS,

OBJECT_TYPE_EDGE_NODE_INTERFACE,

OBJECT_TYPE_DEPLOYMENT,

OBJECT_TYPE_ENTITLEMENTS,

OBJECT_TYPE_DATA_STREAM,

OBJECT_TYPE_API_USAGE,

OBJECT_TYPE_APP_INSTANCE_SNAPSHOT,

OBJECT_TYPE_PATCH_ENVELOPE,

OBJECT_TYPE_RESOURCE_USAGE_TRACK,

OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE,

OBJECT_TYPE_DEV_PASSTHROUGH,

OBJECT_TYPE_EDGE_NODE_CLUSTER,

OBJECT_TYPE_ASSET_GROUP,

OBJECT_TYPE_APP_PROFILE,

OBJECT_TYPE_PROFILE_DEPLOYMENT,

OBJECT_TYPE_ZKS_INSTANCE,

OBJECT_TYPE_CLUSTER_GROUP

operationTime

string

startTime

string

endTime

string

user

string

httpStatusCode

integer<int32>

httpStatusMsg

string

jobId

string

error

one or more errors will be set if the operation failed i.e. httpStatusCode != 2xx · object[]

Show child attributes

⌘I

Update hardware brand

curl --request PUT \
  --url https://{apiHost}/api/v1/brands/id/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "title": "<string>",
  "originType": "ORIGIN_UNSPECIFIED"
}
'

import requests

url = "https://{apiHost}/api/v1/brands/id/{id}"

payload = {
    "name": "<string>",
    "title": "<string>",
    "originType": "ORIGIN_UNSPECIFIED"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', title: '<string>', originType: 'ORIGIN_UNSPECIFIED'})
};

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

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

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

Update hardware brand

Authorizations

Headers

Path Parameters

Body

Response