Get all the patch envelopes

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

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

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

{
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  },
  "list": [
    {
      "name": "<string>",
      "title": "<string>",
      "action": "PATCH_ENVELOPE_ACTION_UNSPECIFIED",
      "artifacts": [
        {
          "format": "OpaqueObjectCategoryUnknown",
          "base64Artifact": {
            "base64Data": "<string>",
            "fileNameToUse": "<string>",
            "base64MetaData": "<string>"
          },
          "binaryArtifact": {
            "imageName": "<string>",
            "fileNameToUse": "<string>",
            "blobMetaData": "<string>",
            "imageId": "<string>"
          },
          "artifactMetaData": "<string>",
          "id": "<string>"
        }
      ],
      "id": "<string>",
      "description": "<string>",
      "revision": {
        "curr": "<string>",
        "createdAt": {},
        "createdBy": "<string>",
        "updatedAt": {},
        "updatedBy": "<string>",
        "prev": "<string>"
      },
      "userDefinedVersion": "<string>",
      "projectId": "<string>",
      "deviceCount": 123,
      "projectName": "<string>"
    }
  ],
  "summaryByAction": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "totalCount": 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>"
    }
  ]
}

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

projectNamePattern

string

project name pattern

namePattern

string

patch envelope name pattern

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.

summary

boolean

Only summary of the records required

Response

A successful response.

Cursor is used as filter in list operation. · object

cursor next

Show child attributes

list

Opaque data for application instances · object[]

patch envelope summary list

Show child attributes

summaryByAction

Summary is used to store the Summary details · object

patch envelopes summary by action

Show child attributes

totalCount

integer<int64>

patch envelope total count

⌘I

Get all the patch envelopes

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

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

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

{
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  },
  "list": [
    {
      "name": "<string>",
      "title": "<string>",
      "action": "PATCH_ENVELOPE_ACTION_UNSPECIFIED",
      "artifacts": [
        {
          "format": "OpaqueObjectCategoryUnknown",
          "base64Artifact": {
            "base64Data": "<string>",
            "fileNameToUse": "<string>",
            "base64MetaData": "<string>"
          },
          "binaryArtifact": {
            "imageName": "<string>",
            "fileNameToUse": "<string>",
            "blobMetaData": "<string>",
            "imageId": "<string>"
          },
          "artifactMetaData": "<string>",
          "id": "<string>"
        }
      ],
      "id": "<string>",
      "description": "<string>",
      "revision": {
        "curr": "<string>",
        "createdAt": {},
        "createdBy": "<string>",
        "updatedAt": {},
        "updatedBy": "<string>",
        "prev": "<string>"
      },
      "userDefinedVersion": "<string>",
      "projectId": "<string>",
      "deviceCount": 123,
      "projectName": "<string>"
    }
  ],
  "summaryByAction": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "totalCount": 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>"
    }
  ]
}

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

API guides

API services

Get all the patch envelopes

Authorizations

Headers

Query Parameters

Response