Get a Job Sheet Form
Purpose
To fetch the details of a specific job sheet form.
Request URL
https://fsm.zoho.com/fsm/v1/meta/job_sheet_forms/<job_sheet_form_id>
job_sheet_form_id - The unique ID of the job sheet form. You can obtain this ID from the List Job Sheets Forms API.
Request Method
GET
Scope
scope=ZohoFSM.meta.JobSheets.READ
Sample Request
Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/meta/job_sheet_forms/1003000001848527'\
--header 'Authorization: Zoho-oauthtoken 1000.3xxxxxxxxx.xxxxxxxxxxxxx0e'Sample Success Response
Copied{
"job_sheet_forms": [
{
"layout": {
"name": "Substation maintenance",
"id": "1003000001848528",
"sections": [
{
"fsm_section_name": "Details",
"fsm_section_label": "Details",
"sequence_number": 1,
"id": "1003000001848529",
"fields": [
{
"fsm_data_type": "autonumber",
"required": false,
"id": "1003000001848530",
"api_name": "Name",
"field_sequence": 1,
"fsm_field_label": "Name",
"length": 120,
"sequence_number": 1
},
{
"fsm_data_type": "textarea",
"required": false,
"id": "1003000001848531",
"fsm_field_label": "Description",
"length": 32000,
"sequence_number": 2,
"api_name": "Description"
},
{
"fsm_data_type": "imageupload",
"required": false,
"id": "1003000001859758",
"internal_cf": true,
"fsm_field_label": "Before Images",
"length": 3,
"sequence_number": 3,
"api_name": "Image_Upload_1__C"
},
{
"fsm_data_type": "imageupload",
"required": false,
"id": "1003000001859782",
"fsm_field_label": "After Images",
"length": 3,
"sequence_number": 4,
"api_name": "Image_Upload_2__C"
},
{
"fsm_data_type": "rating",
"required": false,
"id": "1003000001859761",
"fsm_field_label": "Rating",
"sequence_number": 5,
"rating_props": {
"length": 5,
"type": "star"
},
"api_name": "Rating_1__C"
}
]
}
]
},
"modified_on": "2024-08-28T17:03:49+05:30",
"created_on": "2024-08-19T19:03:23+05:30",
"name": "Substation maintenance",
"modified_by": {
"name": "Marianne Sheehan",
"id": "1003000000208001"
},
"description": "",
"id": "1003000001848527",
"services": [
{
"id": "1003000001854006",
"Name": "Substation Equipment - Emergency Repair"
},
{
"id": "1003000001854700",
"Name": "Substation Equipment - Testing"
},
{
"id": "1003000001854696",
"Name": "Substation Equipment - Inspection"
},
{
"id": "1003000001854010",
"Name": "Substation Equipment - Routine Maintenance"
},
{
"id": "1003000001884077",
"Name": "Power Transformer Electrical Testing"
}
],
"created_by": {
"name": "Marianne Sheehan",
"id": "1003000000208001"
},
"status": "ACTIVE"
}
]
}Sample Failure Response
Copied{
"code": "INVALID_DATA",
"details": {
"Form_Id": "100300000184852"
},
"message": "invalid jobsheet form id",
"status": "error"
}