Introduction

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Introduction

Within a given data type, the format of the data returned in a GET is identical to the format expected in the
body of a PUT or POST.


TIP: Given this equivalence of input and output format, the easiest way to build PUTs and POSTs is often to perform a GET from the same collection and tweak the returned JSON to create a new or updated object.

Common Properties

Most objects share some or all
of these common properties that provide bookkeeping information about the object.

NameTypeDescription

createdId

number

The instanceId of the user who created this object.

createdName

text

The full name of the user who created this object.

createdDate

number

The GMT Unix epoch time this object was created.

lastModifiedId

number

The instanceId of the user who last modified this object.

lastModifiedName

text

The full name of the user who last modified this object.

lastModifiedDate

number

The GMT Unix epoch time this object was last modified.

id

number

The instanceId of this object.

organizationId

number

The organizationId of this object.

status

character

The status of the object. All records returned by the API should have a status of 'A' indicating that the record is active and has not been deleted. (Deleted records of any type are invisible to the API.)