Get Row Field

Retrieve a single field value from a row from a business object. The result is not JSON encoded, and is the literal value.

HTTP Request

GET /icweb.dll/bo/{tableName}/{keyValue}/{fieldname}?format={format}

URI Parameters

Name

In

Required

Type

Description

tableName

Path

Yes

String

Table Name of the business object.

keyValue

Path

Yes

Integer

Id of the row to be returned.

fieldName

Path

Yes

String

Field Name within the business object.

format

Path

No

string

Format of results. Possible values are value, png, and thumbnail, but depends on the field type. FT_CALC supports png, some Repository items support png and thumbnail.

page

Path

No

Integer

Where this is a multi-page document, such as PDF, return the specific page rendered as png.

Responses

Name

Type

Description

200 OK

Literal Value

OK

404 Not Found

No row found for specified keyValue

404 Not Found

Field fieldName not found in tableName

Literal Value

The response contains the literal value of the field. The content type in the response header describes the type of content returned.

Example

Retrieve the name of a workpack.

Request

GET /icweb.dll/bo/Workpack/4/Name

Response

Content-Type: text/plain
2015 ROV Inspection

Example

Retrieve the icon for an Asset

Request

GET /icweb.dll/bo/Comp_Icon/4/Icon

Response

Content-Type: image/png
{binaryData}