Skip to main content
Get Custom Object Definition

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

DefinitionName

GetCustomObjectDefinition: Returns the schema (table + field definitions) for a Custom Object Definition by its database table name.

DefinitionName
string

Response

OK

Schema definition for a Custom Object: the underlying table and its fields. Carrier object for CustomObjectDefinition. Services for the CustomObjectDefinition Carrier is available from the CustomObject Agent.

Id
integer<int32>

Primary key in the extra-tables table.

Name
string

Database table name of the Custom Object, e.g. 'y_equipment'.

Title
string

User-visible title of the Custom Object.

DisplayField
string

Name of the field used to represent a row in lists and previews.

Description
string

Description of the Custom Object.

IconId
integer<int32>

Icon binary-object id used in the UI.

Flags
integer<int32>

Bitmask of ExtraTableFlag values.

Fields
object[]

Field definitions for this Custom Object.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.