AttachmentLinkModel

An Attachment Link represents a single link between any nestable object and an attachment

Methods

The following API methods use this data model.

• Retrieve Attachment Link
• Upload Attachment
• Query Attachment Links

Read-Only Fields

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

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 the Attachment Link was created.

createdUserId

uuid, read-only

The unique ID of the UserAccount of the user
who created this Attachment Link.

Required Fields

attachmentId

uuid

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

objectKey

uuid

An Attachment is connected to an existing item within the Lockstep Platform by the fields TableKey and
ObjectKey. For example, an Attachment connected to Invoice 12345 would have a TableKey value of
Invoice and an ObjectKey value of 12345.

The ObjectKey value contains the primary key of the record within the Lockstep Platform to which this
Attachment is connected.

For more information, see linking metadata to an object.

Optional Fields

tableKey

string, nullable, 0-40 characters

An Attachment is connected to an existing item within the Lockstep Platform by the fields TableKey and
ObjectKey. For example, an Attachment connected to Invoice 12345 would have a TableKey value of
Invoice and an ObjectKey value of 12345.

The TableKey value contains the name of the table within the Lockstep Platform to which this Attachment
is connected.

For more information, see linking metadata to an object.