Obtaining All Fields in a Table in the Data Source

This API is used to obtain all fields in a table in the data source.

GET /v2/{project_id}/fdi/instances/{instance_id}/datasources/{datasource_id}/columns

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.
instance_id	Yes	String	Instance ID
datasource_id	Yes	String	Data source ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
direction_type	Yes	String	Location of the task where the data source is located. SOURCE: the data source is at the source end of the task. TARGET: the data source is at the target end of the task.
db_name	No	String	Database name. Only data sources of the MRSHIVE type is supported.
table_name	Yes	String	Name of the table where a field is located.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
columns	Array of ColumnInfo objects	Returned entity object.

**Table 5** ColumnInfo
Parameter	Type	Description
field_name	String	Field name.
field_type	String	Field type.
field_length	String	Field length.
null_able	String	Indicates whether it can be null.
is_partition	Boolean	Whether it is a partition field.
primary	String	Whether it is a primary key field.
unique	String	Whether it is a unique key field.
decimal_digits	String	Number of decimal places. If the value is not a number, null is returned.

Status code: 400

Status code: 404

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

Status code: 500

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

None

Status code: 500

Internal Server Error

{
  "error_code" : "FDI.3126",
  "error_msg" : "Failed to query the field."
}

Parent topic: Data Source Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel