Updated on 2025-05-13 GMT+08:00

Querying a Field by field_id

Function

This API is used to query a field by field_id.

URI

GET Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/object/{object_id}/Field/{field_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

object_Id

Yes

String

Explanation

Object instance ID, which can be queried by calling the API of Querying All Custom Objects (id in the response message).

Constraints

None

Value

None

Default value

None

field_id

Yes

String

Explanation

Field ID, which can be viewed by calling the API described in Querying a Custom Object Instance by ID.

Constraints

None

Value

None

Default value

None

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

resCode

String

Explanation

Return code.

Value

If the request is successful, 0 is returned. For details about other error codes, see Error Codes.

resMsg

String

Explanation

Message returned.

Value

If the request is successful, "Success" is returned. In other cases, an error message is returned.

result

Object

Explanation

If the request is successful, the detailed information about the field is returned.

Example Request

Query a field by field ID.
GET https://Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/Object/cust000001Dgez2L19N2/Field/cust000001DoWciUWMaG

Example Response

{
  "resCode": "0",
  "resMsg": "Success",
  "result": {
        "name": "CNAME1__test__CST",
        "col": "D0.V4",
        "objectId": "cust000001Dgez2L19N2",
        "id": "cust000001DoWciUWMaG",
        "label": "test",
        "dataType": "Text",
        "category": 4,
        "isRequired": true,
        "isUnique": true,
        "isIndexed": true,
        "isUnionIndexed": false,
        "dataLength": 255,
        "scale": 0,
        "status": 0,
        "encryptType": 0,
        "caseSensitive": true,
        "enableFilter": true,
        "enableSort": true,
        "visibleLines": 3,
        "populateRows": 1,
        "startingNumber": 0,
        "defaultValue": "vfdsg",
        "createdBy": "10gd000001DHHEwmE1NQ",
        "createdDate": "2024-06-11 10:02:59",
        "lastModifiedBy": "10gd000001DHHEwmE1NQ",
        "lastModifiedDate": "2024-06-11 10:02:59",
        "inlineHelpText": "dsf",
        "description": "fsdf",
        "sequenceNo": 1005,
        "protectMode": 0,
        "installedPackage": "",
        "isSearchable": true,
        "visibility": 0,
        "belongTo": "",
        "minEncryptedSearchableLength": 0,
        "rollbackType": false,
        "autoType": "",
        "resetUnit": "",
        "autoExpand": false,
        "createdBy.name": "hw065922111",
        "lastModifiedBy.name": "hw065922111"
    }
}   

Status Code

See Status Codes.

Error Code

See Error Codes.