CodeDefinitionModel

Represents a Code Definition. Codes can be used as shortened, human readable strings.
Additionally, this table can be used to store lists of system values for Lockstep objects.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

codeDefinitionId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

created

date-time, read-only

The date that the Code Definition was created

createdUserId

uuid, read-only

The ID of the user who created the Code Definition

modified

date-time, read-only

The date the Code Definition was last modified

modifiedUserId

uuid, read-only

The ID of the user who last modified the Code Definition

Optional Fields

codeType

string, nullable, 0-40 characters

The type of the Code Definition

code

string, nullable, 0-40 characters

The Code to be defined.

codeDescription

string, nullable, 0-200 characters

The definition of the Code


Did this page help you?