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

Querying a Layout by object_id

Function

This API is used to query a layout of an object instance by object_id.

URI

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

Table 1 URI parameter

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

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

Array

Explanation

If the request is successful, the list of layout object instances is returned.

Example Request

Query the layout list by ObjectID.
GET https://Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/object/cust000001Dgez2L19N2/Layout

Example Response

{
  "resCode": "0",
  "resMsg": "Success",
  "result": [
        {
            "belongTo": "",
            "content": "{\"name\":\"\",\"type\":\"\",\"view\":{\"name\":\"__layout__Test__t1__CST__detail\",\"fields\":[\"name\",\"Test__xxx__CST\",\"Test__Field1__CST\",\"Test__Field11__CST\",\"Test__Field3__CST\"]}}",
            "createdBy": "10gd000001DHHEwmE1NQ",
            "createdBy.name": "test00xx",
            "createdDate": "2024-06-06 16:19:07",
            "custom": true,
            "description": "Object detail layout",
            "events": [],
            "id": "000D000001Dgez2PYjS4",
            "isBaseline": false,
            "label": "t1 Detail",
            "lastModifiedBy": "10gd000001DHHEwmE1NQ",
            "lastModifiedBy.name": "test00xx",
            "lastModifiedDate": "2024-06-07 11:05:50",
            "name": "t1 Detail",
            "objectId": "cust000001Dgez2L19N2",
            "owner": "10gd000001DHHEwmE1NQ",
            "owner.name": "test00xx",
            "params": [],
            "protectMode": 0,
            "type": "ObjectDetailLayout",
            "visibility": 0
        },
        {
            "belongTo": "",
            "content": "{\"name\":\"\",\"type\":\"\",\"view\":{\"name\":\"__layout__Test__t1__CST__tymbj\",\"fields\":[\"name\",\"Test__xxx__CST\",\"Test__Field1__CST\",\"Test__Field11__CST\",\"Test__Field3__CST\"]}}",
            "createdBy": "10gd000001DHHEwmE1NQ",
            "createdBy.name": "test00xx",
            "createdDate": "2024-06-07 11:41:37",
            "custom": true,
            "description": "Object detail layout",
            "events": [],
            "id": "000D000001Di03Y85Faq",
            "isBaseline": false,
            "label": "tymbj",
            "lastModifiedBy": "10gd000001DHHEwmE1NQ",
            "lastModifiedBy.name": "test00xx",
            "lastModifiedDate": "2024-06-07 11:41:37",
            "name": "tymbj",
            "objectId": "cust000001Dgez2L19N2",
            "owner": "10gd000001DHHEwmE1NQ",
            "owner.name": "test00xx",
            "params": [],
            "protectMode": 0,
            "type": "ObjectDetailLayout",
            "visibility": 0
        },
        {
            "belongTo": "",
            "content": "{\"name\":\"\",\"type\":\"\",\"view\":{\"name\":\"__lay#@@#out__Test__t1__CST__asdasdassadasdasssssssssssssssssssssssssdasfasfasfasf\",\"fields\":[\"name\",\"Test__xxx__CST\",\"Test__Field1__CST\",\"Test__Field11__CST\",\"Test__Field3__CST\"]}}",
            "createdBy": "10gd000001DHHEwmE1NQ",
            "createdBy.name": "test00xx",
            "createdDate": "2024-06-07 14:12:39",
            "custom": true,
            "description": "Object detail layout",
            "events": [],
            "id": "000D000001DiAqgg54Nc",
            "isBaseline": false,
            "label": "asdassdasdasfasadsdasd",
            "lastModifiedBy": "10gd000001DHHEwmE1NQ",
            "lastModifiedBy.name": "test00xx",
            "lastModifiedDate": "2024-06-07 14:12:39",
            "name": "asdassdasdasfasadsdasd",
            "objectId": "cust000001Dgez2L19N2",
            "owner": "10gd000001DHHEwmE1NQ",
            "owner.name": "test00xx",
            "params": [],
            "protectMode": 0,
            "type": "ObjectDetailLayout",
            "visibility": 0
        },
        {
            "belongTo": "",
            "content": "{\"name\":\"\",\"type\":\"\",\"view\":{\"name\":\"__layout__Test__t1__CST__records\",\"fields\":[\"name\"]}}",
            "createdBy": "10gd000001DHHEwmE1NQ",
            "createdBy.name": "test00xx",
            "createdDate": "2024-06-06 16:19:07",
            "custom": true,
            "description": "Object records layout",
            "events": [],
            "id": "000D000001Dgez2PYjS5",
            "isBaseline": false,
            "label": "t1 Records",
            "lastModifiedBy": "10gd000001DHHEwmE1NQ",
            "lastModifiedBy.name": "test00xx",
            "lastModifiedDate": "2024-06-06 16:19:07",
            "name": "t1 Records",
            "objectId": "cust000001Dgez2L19N2",
            "owner": "10gd000001DHHEwmE1NQ",
            "owner.name": "test00xx",
            "params": [],
            "protectMode": 0,
            "type": "ObjectRecordsLayout",
            "visibility": 0
        },
        {
            "belongTo": "",
            "content": "{\"name\":\"\",\"type\":\"\",\"view\":{\"name\":\"__layout__Test__t1__CST__dasdsdasdasdsdddddddddddddddddd\",\"fields\":[\"name\"]}}",
            "createdBy": "10gd000001DHHEwmE1NQ",
            "createdBy.name": "test00xx",
            "createdDate": "2024-06-07 11:45:07",
            "custom": true,
            "description": "Object records layout",
            "events": [],
            "id": "000D000001Di0J4JicDo",
            "isBaseline": false,
            "label": "dasdsdasdasdsdddddddddddddddddd",
            "lastModifiedBy": "10gd000001DHHEwmE1NQ",
            "lastModifiedBy.name": "test00xx",
            "lastModifiedDate": "2024-06-07 11:45:07",
            "name": "dasdsdasdasdsdddddddddddddddddd",
            "objectId": "cust000001Dgez2L19N2",
            "owner": "10gd000001DHHEwmE1NQ",
            "owner.name": "test00xx",
            "params": [],
            "protectMode": 0,
            "type": "ObjectRecordsLayout",
            "visibility": 0
        }
    ]
}   

Status Code

See Status Codes.

Error Code

See Error Codes.