List Objects

This will list all standard and custom objects in a company.

inspect

<inspect>
    <object>*</object>
</inspect>

Parameters

Name Required Type Description
object Optional string Use * to return all objects

Get Object Definition

This will return the object definition and all field details of a specific standard or custom object in a company.

inspect

Get object definition by integration name

<inspect detail="1">
    <object>DEPARTMENT</object>
</inspect>

Get object definition by printable name

<inspect detail="1">
    <name>Sales Order</name>
</inspect>

Parameters

Name Required Type Description
detail Optional integer Use 1 to return details otherwise use 0 to return summary info
object Optional string The object integration name to get. Required if not using name
name Optional string The object name to get. Required if not using object. If you need to get objects that utilize transaction definitions (docparid), you should use inspect with the name element instead of the object element.

List Object Audit Trail Logs

readByQuery

List changes made to all objects on April 19, 2012

<readByQuery>
    <object>ACTIVITYLOG</object>
    <fields>*</fields>
    <query>OBJ_ID &lt; 0 AND CREATED_AT &gt;= '04/19/2012 12:00:00' AND CREATED_AT &lt; '04/20/2012 12:00:00'</query>
    <pagesize>100</pagesize>
</readByQuery>

List changes made to custom object ID 10006

<readByQuery>
    <object>ACTIVITYLOG</object>
    <fields>*</fields>
    <query>OBJ_ID = -10006</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ACTIVITYLOG
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

query

Name Required Type Description
OBJ_ID Required integer Object system ID. Must be prefixed with a dash -. Lookup this value in the object definition.

Response

The above function returns data structured like this:

<activitylog>
    <RECORDNO>11033</RECORDNO>
    <OBJ_ID>-10006</OBJ_ID>
    <TRAIL_TEXT>Validation script for field &quot;Estimated Fees&quot; has been updated.</TRAIL_TEXT>
    <EMAIL_TEXT></EMAIL_TEXT>
    <CREATED_BY>1</CREATED_BY>
    <CREATEDBYUSER>jsmith</CREATEDBYUSER>
    <CREATED_AT>04/19/2012 19:38:32</CREATED_AT>
</activitylog>

Get Object Audit Trail Log

read

<read>
    <object>ACTIVITYLOG</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ACTIVITYLOG
keys Required string The log RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Provide feedback