How to get (read) a row from a custom object

Audience:

api

•

Version: 10

• 1 minute to read

Request

RESTful AGENT
RESTful REST

To get a row using the DatabaseTable agent, specify the TableName and Id as body parameters.

POST https://{{env}}.superoffice.com/{{tenant}}/api/v1/Agents/DatabaseTable/ReadRow HTTP/1.1
Authorization: Bearer {{token}}
Accept: application/json; charset=utf-8
Content-Type: application/json
{
    "TableName": "y_equipment",
    "Id": 1
}

For details, see the DatabaseTable agent reference.

To get a row using the TableRecord endpoint, specify the table name and row ID as query string parameters.

POST https://{{env}}.superoffice.com/{{tenant}}/api/v1/Table/y_equipment/1 HTTP/1.1
Authorization: Bearer {{token}}
Accept: application/json; charset=utf-8
Content-Type: application/json

For details, see the Table REST endpoint reference.

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "Values": {
    "id": "[I:1]",
    "last_changed": "[DT:04/28/2024 20:28:37.0000000]",
    "dbi_agent_id": "[I:-1]",
    "dbi_key": "",
    "dbi_last_syncronized": "[DT:01/01/0001 00:00:00.0000000]",
    "dbi_last_modified": "[DT:04/28/2024 20:28:37.0000000]",
    "x_name": "computer",
    "x_company": "[I:1]",
    "x_company:DisplayText": "SuperOffice Software Limited"
  },
  "TableRight": null,
  "FieldProperties": {}
}