Obtaining All Fields in a Table in the Data Source

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.

Minimum: 1

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 64

datasource_id

Yes

String

Data source ID.

Minimum: 1

Maximum: 64

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.

Minimum: 0

Maximum: 6

db_name

No

String

Database name. Only data sources of the MRSHIVE type is supported.

Minimum: 0

Maximum: 64

table_name

Yes

String

Name of the table where a field is located.

Minimum: 0

Maximum: 64

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

columns

Array of ColumnInfo objects

Returned entity object.

field_name

String

Field name.

Minimum: 0

Maximum: 256

field_type

String

Field type.

Minimum: 0

Maximum: 256

field_length

String

Field length.

Minimum: 0

Maximum: 200

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.

Minimum: 0

Maximum: 200

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

detail

String

Description details.

Minimum: 2

Maximum: 512

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

200

OK

400

Error response

404

Not Found

500

Internal Server Error