Resource

The REST API operations that can be performed on the resources are:

GET /children
GET /custom_functions
GET /columns

GET /children

This API is used to get the children of resources.

Parameters:

Name

Description

Parameter Type

Data Type

path

resource path

query

string

type

resource type

query

string

metadataVersion

resource version

query

long

start

the start index in children list

query

integer

count

the count of children

query

integer

component

component name, (only supports “cbs” now.)

query

string

Example to get children of resource "/shared/examples"

curl -X GET -u admin:admin "http://localhost:9400/rest/resource/v1/children?path=/shared/examples&type=CONTAINER"

Example to get children of resource "/shared/examples" by page

curl -X GET -u admin:admin "http://localhost:9400/rest/resource/v1/children?path=/shared/examples&type=CONTAINER&metadataVersion=&start=0&cound=10"

GET /custom_functions

This API is used to get all custom functions.

Parameters:

None

Example to get all custom functions

curl -X GET -u admin:admin "http://localhost:9400/rest/resource/v1/custom_functions"

GET /columns

This API is used to get table/view columns.

Parameters:

Name

Description

Parameter Type

Data Type

path

table path

query

string

metadataVersion

table version

query

long

start

the start index in children list

query

integer

count

the count of children

query

integer

Example to get view "/shared/examples/ViewOrder" columns

curl -X GET -u admin:admin "http://localhost:9400/rest/resource/v1/table/columns?path=/shared/examples/ViewOrder"

 

Example to get view "/shared/examples/ViewOrder" columns by page

curl -X GET -u admin:admin "http://localhost:9400/rest/resource/v1/table/columns?path=/shared/examples/ViewOrder&metadataVersion=&start=0&cound=10"