Previewing Data (Invitational Test)

Function

This API is used to preview table data. Ten data records are returned. This API is in invitational test and will be available in OBT in the future.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/datamap/entities/guid/{guid}/preview

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
guid	Yes	String	Asset GUID. For details about how to obtain the asset GUID, see Data Development Job ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
data_connection_id	No	String	Data connection ID
source_type	No	String	Data source type
database	No	String	Database name
schema	No	String	Schema name
table	No	String	Table name
queue	No	String	Queue name

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
instance	Yes	String	Instance ID. For details about how to obtain the instance ID, see Instance ID and Workspace ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
rows	Array<Array<Object>>	Data list in the table
schema	Array of objects	Field information list

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

None

Example Responses

Status code: 200

{
  "rows" : null,
  "schema" : [ {
    "name" : "string"
  }, {
    "school" : "string"
  }, {
    "id" : "int"
  }, {
    "address" : "string"
  } ]
}