getDataField

Purpose

Retrieves the value of a single field from a specific record.

For objects in dedicated tables or external objects (such as those mapped to external tables, to OpenEdge Service objects, or through a HDP connection), you must specify both the objName and id parameters.

IS objName optional for native RB objects or is it also required now? Also, I wasn't sure whether I put objName in the right order in the parameter list? Same question on all four methods.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getDataField

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

objName

The object integration name.

id

The record ID.

fieldName

The field integration name.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Note:
  • The format of date or date/time fields is governed by the shared property UseISODateFormatInRESTJSON and can be configured from System Console > System > Shared Properties > General > API. For more information, see Shared Properties.
  • The shared property mentioned above is applicable only if the output is in JSON format.

Permissions Required

View permission for the requested object type.

Response

Field's value.

Example

Output example in XML:

 <?xml version="1.0" encoding="utf-8" ?>
        <resp status="ok">
        <Field  name="status">Created</Field>
        </resp>

Output example in JSON:

{ "status": "Created" }