Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "78bd4816-bbca-4c1d-9560-51c4d9dfc565",
"jobs_id": "76c54526-5862-46c6-a0de-629fae87a4ef",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "26495c11-f441-4876-833e-5d971f4de744",
"_parent_id": "2b314a2c-3253-46ca-8e17-3ce7666be123",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e69f3d24-12c4-4902-93e1-9a20fb09f700",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c43f617b-ff69-4a29-9243-dc82664a0427",
"_parent_id": "3a9c5502-cf23-4d76-8574-d0c4a7c77d23",
"root_parent_id": "b4acb794-8fa6-4269-8b53-38cba768ea8e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ce0a47bc-2272-41fc-9364-025525a8c149",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "14cd5be1-eccf-4fa9-8ac6-ea9c9cac11d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "33956509-2401-4b6f-9c2f-09654d31ae19",
"_parent_code": "sample string 6",
"sales_organization_id": "ed2d4262-94c8-4e89-b263-41f984d97eef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"equipment_model_id": "613475f1-653a-46da-8d59-037fc2641412",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "14216f14-1a48-4478-a536-0205b1ff50b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "edc198b5-0a81-4e27-82da-f33e29942c81",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5e822677-7357-4e90-8470-33770a2fb572",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "522fe277-231a-477b-a91f-91c0b93e0432",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"equipment_family_id": "b97e9f92-21bd-4628-bf90-7d93e161d8e1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "14cd5be1-eccf-4fa9-8ac6-ea9c9cac11d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "33956509-2401-4b6f-9c2f-09654d31ae19",
"_parent_code": "sample string 6",
"sales_organization_id": "ed2d4262-94c8-4e89-b263-41f984d97eef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"date_in_production_since": "2026-05-22T06:10:18.9876131+00:00",
"date_out_of_production_since": "2026-05-22T06:10:18.9876131+00:00",
"date_end_support": "2026-05-22T06:10:18.9876131+00:00",
"sales_organization_id": "01ebc744-fe52-4fef-9268-5a96e3a56a84",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"project_status_id": "cff1d771-2bde-4609-a323-254d50ed77ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "5807b517-09d8-4168-a51c-12229e6b6b1b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4a089e74-0b1a-486a-a39e-c659fbf4e650",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"company_id": "7621bb3a-a0d3-4de9-a1c5-7687a4beb39b",
"company_code": "sample string 12",
"db_address_id": "06683a98-27e1-44ce-aec9-f6d2832de14e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a27b3713-5a21-41ba-8218-148cfcbc2c7c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "17306531-b560-4277-b7ec-deb6a07fc276",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-05-22T06:10:18.9876131+00:00",
"date_create": "2026-05-22T06:10:18.9876131+00:00",
"date_update": "2026-05-22T06:10:18.9876131+00:00",
"updated_by_user_id": "05d0310b-0ef4-4a77-8a8b-7bc29c8ee457",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-22T06:10:18.9876131+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-05-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-22T06:10:18.9876131+00:00",
"date_last_job": "2026-05-22T06:10:18.9876131+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-22T06:10:18.9876131+00:00",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ff8b69b-dd70-4155-b1a6-b24ac4cc8009",
"job_type_code": "sample string 7",
"job_type": {
"id": "344f278c-caf1-489d-8095-296fd152640d",
"name": "sample string 2",
"sales_organization_id": "360459f1-4a61-4f25-a145-448f570273fc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00",
"code": "sample string 7"
},
"job_priority_id": "74d09791-016d-4778-912b-c879df4f2464",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ace88181-0c86-4808-89f4-857239e9123e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0b531145-3254-4447-8472-2e042d348c48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"job_status_id": "717f73f8-f036-47ba-aeb3-7e88f4f205d3",
"job_status_code": "sample string 11",
"db_address_id": "75869344-890e-4b4a-9bb4-9adfed50d0e2",
"contact_id": "8e3f3bf6-7fb8-4f38-bb4f-56078150ca95",
"requested_by_company_id": "74cfa637-74ab-4052-a7c8-cef98791b1a2",
"requested_by_contact_id": "898af0e1-0f67-4d63-8d72-ffa0dbdfefd8",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-05-22T06:10:18.9876131+00:00",
"due_date": "2026-05-22T06:10:18.9876131+00:00",
"date_create": "2026-05-22T06:10:18.9876131+00:00",
"date_update": "2026-05-22T06:10:18.9876131+00:00",
"date_closed": "2026-05-22T06:10:18.9876131+00:00",
"suggested_user_id": "b5a32d4c-1bc6-40e0-a215-9931fc55c635",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b5df6392-8e1c-4816-bb68-b8a088f59343",
"db_language_id": "96948500-e313-4ce1-8ee4-9ab9665cae5a",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-05-22T06:10:18.9876131+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc7a2d56-5273-4016-9f6b-cf1f5226f543",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "45a9e01f-ac10-4d7b-8170-d3d05ff7b085",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "ef01956e-70ac-4c65-ae94-9f08fec70623",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "00c830c7-150b-4798-9b27-fe18cb7d18b8"
},
"suggested_date_start": "2026-05-22T06:10:18.9876131+00:00",
"skill_id": "7d602acd-6746-482e-8a70-4aa8118746e8",
"skill_code": "sample string 32",
"skill": {
"id": "f3d8773f-5e3a-4920-90d2-d8c4686cd8df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "db2634f4-4590-4e98-8b83-a0c7cb075bfb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d0abe0db-eb5d-4ba8-bb02-2d387b382085",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cceaf33c-bb0f-480c-bdde-018f54c43b9a",
"db_currency_id": "3341ff26-d8f7-45ee-b0be-396ed92a4e38",
"db_language_id": "26c4df61-486f-4fe9-9904-886fbc70dd8c",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f973bcaa-6d0a-49a5-97fd-3222017e8f06",
"date_reported_by_company": "2026-05-22T06:10:18.9876131+00:00",
"id2": 36,
"company_id": "d119b74b-097e-4463-88d3-3b7a1b9019d1",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "ac7cdfa4-9adb-4522-ab50-9e2e4d741213",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
},
"work_instruction_details_id": "9c0c9368-e98c-4271-9600-7fee30b2761b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e9885d0e-a0c0-4993-bc81-5b0d5089dc3a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "434964b2-12cf-4dbb-9b54-2fce597530bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-22T06:10:18.9876131+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "977add78-ad72-4f50-a33c-61aff01ff337",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-22T06:10:18.9876131+00:00"
}