REST API - Custom Object Metadata

Version 2

    The REST API provides access to create, retrieve, update and delete custom objects.

     

    Accessing Custom Object Metadata

    • GET  /assets/customObject/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
      "type": "CustomObject",
      "id": "7",
      "depth": "complete",
      "description": "Capture Information on Prospects",
      "name": "Prospecting ",
      "fields": [
        {
          "type": "CustomObjectField",
          "id": "48",
          "depth": "complete",
          "name": "Call Notes",
          "dataType": "text",
          "defaultValue": "",
          "displayType": "text"
        },
        {
          "type": "CustomObjectField",
          "id": "47",
          "depth": "complete",
          "name": "Subject",
          "dataType": "text",
          "defaultValue": "",
          "displayType": "text"
        },
        {
          "type": "CustomObjectField",
          "id": "46",
          "depth": "complete",
          "name": "Assigned To",
          "dataType": "text",
          "defaultValue": "",
          "displayType": "text"
        },
        {
          "type": "CustomObjectField",
          "id": "40",
          "depth": "complete",
          "name": "Business Phone",
          "dataType": "text",
          "defaultValue": "",
          "displayType": "text"
        },
        {
          "type": "CustomObjectField",
          "id": "44",
          "depth": "complete",
          "name": "Date Called",
          "dataType": "date",
          "defaultValue": "",
          "displayType": "text"
        },
        {
          "type": "CustomObjectField",
          "id": "45",
          "depth": "complete",
          "name": "Call Status",
          "dataType": "text",
          "defaultValue": "",
          "displayType": "singleSelect"
        },
        {
          "type": "CustomObjectField",
          "id": "43",
          "depth": "complete",
          "name": "Title",
          "dataType": "text",
          "defaultValue": "",
          "displayType": "text"
        }
      ],
      "uniqueCodeFieldId": "40"
    }
    

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    type"CustomObject"
    displayNameFieldIdstringReadOnly
    fieldsList of Custom
    Object Field
    A list of custom fields defined by the user for the custom object
    uniqueCodeFieldIdstringThe unique identifier of the custom object's unique code fieldReadOnly
    accessedAtintegerDateRequirement
    createdAtintegerReadOnlyDateRequirement
    createdByintegerReadOnlyIdRequirement
    currentStatusstring
    depthRequestDepthEnumRequirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerThe unique id of the custom objectIdRequirement
    namestring
    permissionsInstance
    Permissions
    EnumRequirement
    scheduledForintegerDateRequirement
    updatedAtintegerReadOnlyDateRequirement
    updatedByintegerReadOnlyIdRequirement 

     

    Related Operations

    • DELETE :  /assets/customObject/{id}
    • GET (list) :  /assets/customObjects?search={searchTerm}&page={page}&count={count}&orderBy={orderBy}