Help Center> ROMA Connect> API Reference> FDI APIs> Data Source Management> Obtaining All Fields in a Table in the Data Source
View PDF

Obtaining All Fields in a Table in the Data Source

Function

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

URI

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.

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

position

Yes

String

Task location of the data source.

  • SOURCE: Data source is at the task source.

  • TARGET: Data source is at the task destination.

Minimum: 0

Maximum: 6

db_name

No

String

Database name. Only data sources of the MRSHIVE and FIHIVE types are supported.

Minimum: 0

Maximum: 64

table_name

Yes

String

Name of the table where a field is located.

Minimum: 0

Maximum: 64

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

columns

Array of ColumnInfo objects

Returned entity object.
Table 4 ColumnInfo

Parameter

Type

Description

field_name

String

Field name.

Minimum: 0

Maximum: 256

field_length

Long

Field length.

Minimum: 0

Maximum: 200

null_able

Boolean

Indicates whether it can be null.

partition_column

Boolean

Whether it is a partition field.

primary

String

Whether it is a primary key field.

Minimum: 0

Maximum: 1

unique

String

Whether it is a unique key field.

Minimum: 0

Maximum: 1

decimal_digits

Long

Number of decimal places. If the value is not a number, null is returned.

Minimum: 0

Maximum: 200

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

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

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Example Requests

None

Example Responses

Status code: 200

OK

  • Example 1

    null

  • Example 2

    [ {
  "unique" : "0",
  "field_name" : "name",
  "field_type" : "VARCHAR",
  "field_length" : "255",
  "null_able" : "1",
  "is_partition" : false,
  "fields_name" : "name"
} ]

Status Codes

Status Code

Description

200

OK

400

Error response

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Data Source Management