Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ProjectSummary

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

Properties

Optional description

description: undefined | string

A user defined description for the project.

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

Generated key that can be used in API calls to identify project.

Optional keyMap

keyMap: undefined | object

A key map. If provided, the 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 type of the object.

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

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

Functions

getDeserializedJsonObj

getJsonObj