Retrieve Custom Object Record

Retrieves a single record from a custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObjectRecord/retrieveCustomObjectRecord

Request

https://api.neoncrm.com/neonws/services/api/customObjectRecord/retrieveCustomObjectRecord?userSessionId=[session id]&customObjectRecord.objectApiName=Museum_Visits_c&customObjectRecord.recordId=2

Response

{
  "retrieveCustomObjectRecordResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2017-04-20T04:14:26.728+0000",
    "customObjectRecord": {
      "objectApiName": "Museum_Visits_c",
      "recordId": 2,
      "customObjectRecordDataList": {
        "customObjectRecordData": [
          {
            "name": "id",
            "value": "2"
          },         
          {
            "name": "Account_ID_c",
            "value": "1247"
          },
          {
            "name": "Visit_Date_c",
            "value": "04/19/2017"
          },
          {
            "name": "Group_Size_c",
            "value": "3"
          },
		  {
            "name": "createTime",
            "value": "04/19/2017 23:12:45"
          },
          {
            "name": "createBy",
            "value": "Edward Shen"
          },
          {
            "name": "lastModifyBy",
            "value": "Edward Shen"
          },
          {
            "name": "lastModifyTime",
            "value": "04/19/2017 23:12:45"
          }
        ]
      }
    }
  }
}

Request Parameters

Parameter	Required	Description
customObjectRecord.objectApiName	Required	This is the token used to identify the Custom Object when accessing it from the API.
customObjectRecord.recordId	Required	The ID of the record to be retrieved. Use the List Custom Object Records API method to retrieve IDs.

Response Parameters

Parameter	Description
customObjectRecord.objectApiName	This is the token used to identify the Custom Object when accessing it from the API.
customObjectRecord.recordId	The ID of the record to be retrieved. Use the List Custom Object Records API method to retrieve IDs.
customObjectRecord.customObjectRecordDataList.customObjectRecordData.name	The name of each field for this custom object.
customObjectRecord.customObjectRecordDataList.customObjectRecordData.value	The value for each field of this custom object record.

Error Codes

Code	Text	Description