Get Job Sheet Form Fields

Purpose

To fetch the details of the fields in a job sheet form.

Request URL

https://fsm.zoho.com/fsm/v1/meta/fields

Request Method

GET

Scope

scope=ZohoFSM.meta.modules.READ

Parameters

NameData TypeDescription
moduleStringUse the value Job_Sheets
form_idStringThe unique ID of the job sheet form. You can obtain this ID from the List Job Sheets Forms API.

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/meta/fields?module=Job_Sheets&form_id=1003000001848527'\
--header 'Authorization: Zoho-oauthtoken 1000.26xxxxxxxxxx.xxxxxxxxxx0'

Sample Response

Copied{
    "fields": [
        {
            "formid": 1003000001848527,
            "system_mandatory": false,
            "field_label": "Name",
            "id": "1003000001848530",
            "length": 120,
            "api_name": "Name",
            "data_type": "autonumber"
        },
        {
            "system_mandatory": true,
            "field_label": "Service Appointment",
            "id": "1003000001847674",
            "lookup": {
                "api_name": "Job_Sheets",
                "module": {
                    "api_name": "Service_Appointments",
                    "id": "1003000000159063"
                },
                "id": "1003000001847786"
            },
            "length": 120,
            "api_name": "Service_Appointment",
            "data_type": "lookup"
        },
        {
            "system_mandatory": false,
            "field_label": "Description",
            "id": "1003000001847672",
            "length": 32000,
            "api_name": "Description",
            "data_type": "textarea"
        },
        {
            "system_mandatory": false,
            "field_label": "Status",
            "id": "1003000001847678",
            "length": 120,
            "api_name": "Status",
            "data_type": "picklist",
            "pick_list_values": [
                {
                    "display_value": "Draft",
                    "colorcode": "#F5B149",
                    "actual_value": "Draft",
                    "id": "1003000001847778"
                },
                {
                    "display_value": "Completed",
                    "colorcode": "#369627",
                    "actual_value": "Completed",
                    "id": "1003000001847781"
                }
            ]
        },
        {
            "formid": 1003000001848527,
            "system_mandatory": false,
            "field_label": "Before Images",
            "id": "1003000001859758",
            "length": 3,
            "max_size": 10,
            "api_name": "Image_Upload_1__C",
            "data_type": "imageupload"
        },
        {
            "formid": 1003000001848527,
            "system_mandatory": false,
            "field_label": "After Images",
            "id": "1003000001859782",
            "length": 3,
            "max_size": 10,
            "api_name": "Image_Upload_2__C",
            "data_type": "imageupload"
        },
        {
            "formid": 1003000001848527,
            "system_mandatory": false,
            "field_label": "Rating",
            "id": "1003000001859761",
            "length": 2,
            "rating_props": {
                "length": 5,
                "type": "star"
            },
            "api_name": "Rating_1__C",
            "data_type": "rating"
        }
    ]
}