Skip to main content

GetFieldSettings

Get field settings

Description​

Obtain field settings

Method​

GET

Request URL Format​

/api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id

URL Params​

app-id          : Application ID (ID entered from the Hexabase screen)
datastore-id    : Data store ID (ID entered from the Hexabase screen)
field-id        : Field ID (ID entered from Hexabase screen)

Request URL Sample​

GET https://api.xxx.com/api/v0/applications/624bea3a879f4e8d8b5dcc6f/datastores/639912c0b1ea5632b8bc0545/fields/63991301fa9223af047f436f

Response Sample​

{
    "workspace_id": "624bea3a879f4e8d8b5dcc6c",
    "project_id": "624bea3a879f4e8d8b5dcc6f",
    "datastore_id": "639912c0b1ea5632b8bc0545",
    "field_id": "63991301fa9223af047f436f",
    "name": {
        "en": "select",
        "ja": "select"
    },
    "display_id": "Fld-MzZNUHau",
    "search": true,
    "show_list": true,
    "as_title": false,
    "status": false,
    "full_text": false,
    "unique": false,
    "hideOnInput": false,
    "hide_from_api": false,
    "has_index": false,
    "roles": [
        {
            "role_id": "624bea3a879f4e8d8b5dcc70",
            "display_id": "ADMIN",
            "name": "admin",
            "type": "admin",
            "project_id": "624bea3a879f4e8d8b5dcc6f",
            "can_use": true
        },
        {
            "role_id": "624bea3a879f4e8d8b5dcc72",
            "display_id": "ROLE-KZeMbuwz",
            "name": "member",
            "type": "other",
            "project_id": "624bea3a879f4e8d8b5dcc6f",
            "can_use": true
        }
    ]
}

If you want to get the option of the selected item​

Specify with_options=true in the Request URL if you want to get the option of a choice/radio/checkbox item.

Request URL Sample​

GET https://api.xxx.com/api/v0/applications/624bea3a879f4e8d8b5dcc6f/datastores/639912c0b1ea5632b8bc0545/fields/63991301fa9223af047f436f?with_options=true

Response Sample​

{
    "workspace_id": "624bea3a879f4e8d8b5dcc6c",
    "project_id": "624bea3a879f4e8d8b5dcc6f",
    "datastore_id": "639912c0b1ea5632b8bc0545",
    "field_id": "63991301fa9223af047f436f",
    "name": {
        "en": "select",
        "ja": "select"
    },
    "display_id": "Fld-MzZNUHau",
    "dataType": "select",
    "search": true,
    "show_list": true,
    "as_title": false,
    "status": false,
    "full_text": false,
    "unique": false,
    "hideOnInput": false,
    "hide_from_api": false,
    "has_index": false,
    "roles": [
        {
            "role_id": "624bea3a879f4e8d8b5dcc70",
            "display_id": "ADMIN",
            "name": "admin",
            "type": "admin",
            "project_id": "624bea3a879f4e8d8b5dcc6f",
            "can_use": true
        },
        {
            "role_id": "624bea3a879f4e8d8b5dcc72",
            "display_id": "ROLE-KZeMbuwz",
            "name": "member",
            "type": "other",
            "project_id": "624bea3a879f4e8d8b5dcc6f",
            "can_use": true
        }
    ],
    "options": [
        {
            "_id": "2c85596d-7bc3-4d7f-b139-a6d6b5b32f94",
            "color": "grey",
            "created_at": "2022-12-14T00:05:52.58Z",
            "d_id": "639912c0b1ea5632b8bc0545",
            "display_id": "2c85596d-7bc3-4d7f-b139-a6d6b5b32f94",
            "enabled": true,
            "o_id": "2c85596d-7bc3-4d7f-b139-a6d6b5b32f94",
            "selected": false,
            "sort_id": 0,
            "updated_at": "2022-12-20T04:02:01.238Z",
            "value": {
                "en": "option1",
                "ja": "option1"
            }
        },
        {
            "_id": "e66ec32c-b781-4f93-97b7-92d0e6dff438",
            "color": "grey",
            "created_at": "2022-12-14T00:05:52.58Z",
            "d_id": "639912c0b1ea5632b8bc0545",
            "display_id": "e66ec32c-b781-4f93-97b7-92d0e6dff438",
            "enabled": true,
            "o_id": "e66ec32c-b781-4f93-97b7-92d0e6dff438",
            "selected": false,
            "sort_id": 1,
            "updated_at": "2022-12-20T04:02:01.238Z",
            "value": {
                "en": "option2",
                "ja": "option2"
            }
        }
    ]
}