Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PatchSummary

The patch summary type contains the audit summary information and the definition of the patch.

Properties

Optional applicationVersion

applicationVersion: undefined | number

The application version of the patch. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dependentObjectMetadata

dependentObjectMetadata: Array<PatchObjectMetadata>

List of dependent objects in this patch.

Optional description

description: undefined | string

Detailed description for the object.

Optional errorMessages

errorMessages: undefined | object

The errors encountered while applying the patch, if any.

Optional identifier

identifier: undefined | string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional key

key: undefined | string

The object key.

Optional keyMap

keyMap: undefined | object

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Optional metadata

metadata: model.ObjectMetadata

Optional modelType

modelType: undefined | string

The object type.

Optional modelVersion

modelVersion: undefined | string

The object's model version.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectVersion

objectVersion: undefined | number

The version of the object that is used to track changes in the object instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional patchObjectMetadata

patchObjectMetadata: Array<PatchObjectMetadata>

List of objects that are published or unpublished in this patch.

Optional patchStatus

patchStatus: PatchStatus

Status of the patch applied or being applied on the application

Optional patchType

patchType: PatchType

The type of the patch applied or being applied on the application.

Optional timePatched

timePatched: Date

The date and time the patch was applied, in the timestamp format defined by RFC3339.

Functions

getDeserializedJsonObj

getJsonObj