Get Custom Object Definition
Returns the schema (table + field definitions) for a Custom Object Definition by its database table name.
NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
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.
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.
Primary key in the extra-tables table.
Database table name of the Custom Object, e.g. 'y_equipment'.
User-visible title of the Custom Object.
Name of the field used to represent a row in lists and previews.
Description of the Custom Object.
Icon binary-object id used in the UI.
Bitmask of ExtraTableFlag values.
Field definitions for this Custom Object.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Custom Object DefinitionGet Custom ObjectCreate Default Custom Object DefinitionDelete Custom Object