Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "da84d7dd-4765-436d-8910-a678813dd57e",
"jobs_id": "603a5136-8bbc-4980-8fba-e41907b0a0a3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c6551547-9d51-4a01-a1c9-8249c306c2da",
"_parent_id": "345af50d-68f7-4170-ae83-6e274c2ef289",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "690b5b87-7fec-4a3e-859e-3ccbc181da30",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0b510101-57f9-4741-bf7c-3311709131f7",
"_parent_id": "e43af167-3afd-4234-b22c-3df4dfaeb0ee",
"root_parent_id": "fa4b48e1-f0d2-4e16-97d8-d1cda9e93cb3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "66a1e8eb-9828-40c0-8e12-94471c94bc3d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "58107d0e-5206-4696-a26d-579b7d5f673c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0339b4ea-5fd6-439d-ad4f-c17592f08fcb",
"_parent_code": "sample string 6",
"sales_organization_id": "209fda6f-8946-4d33-b3a3-bf51b99faf5c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00"
},
"equipment_model_id": "53c5f852-1e3c-41d4-925b-2832effe74e7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "21a4b82d-310c-461d-b1a4-f5d01c14c309",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8375e4df-b8e0-4593-9a33-7d0b277c97c0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7e571db0-815a-4886-9824-e65de8577010",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d654ec9-3ffb-46ae-bd6d-bd65d6718179",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00"
},
"equipment_family_id": "2575550c-23e9-4838-84e7-cfe66a1e3b3c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "58107d0e-5206-4696-a26d-579b7d5f673c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0339b4ea-5fd6-439d-ad4f-c17592f08fcb",
"_parent_code": "sample string 6",
"sales_organization_id": "209fda6f-8946-4d33-b3a3-bf51b99faf5c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00"
},
"date_in_production_since": "2026-10-11T13:13:34.4759826+00:00",
"date_out_of_production_since": "2026-10-11T13:13:34.4759826+00:00",
"date_end_support": "2026-10-11T13:13:34.4759826+00:00",
"sales_organization_id": "744f7266-5029-47f6-8a0d-6f2c29e4d4ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+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-10-11T13:13:34.4759826+00:00"
},
"project_status_id": "849ac1ed-6e36-4648-bae8-b1dc7ca07709",
"project_status_code": "sample string 10",
"project_status": {
"id": "0c7dd80f-20be-4647-921a-7c24140fa940",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fd4cd71a-e9c6-492d-8bf7-e458a528f41e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00"
},
"company_id": "f6ab473f-677f-4e34-aedd-4350036893df",
"company_code": "sample string 12",
"db_address_id": "b50868c1-f8dc-4fc9-9af1-7ef813e716ed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "41a23a5d-68f9-4e08-9851-6fecea58bffe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "01554675-e8ca-4b3d-b82f-366c2383fe3c",
"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-10-11T13:13:34.4759826+00:00",
"date_create": "2026-10-11T13:13:34.4759826+00:00",
"date_update": "2026-10-11T13:13:34.4759826+00:00",
"updated_by_user_id": "17886eb4-d3f2-4f14-85c1-a73044739ce4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-11T13:13:34.4759826+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-10-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-11T13:13:34.4759826+00:00",
"date_last_job": "2026-10-11T13:13:34.4759826+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-11T13:13:34.4759826+00:00",
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00",
"is_mobile_installation": true
},
"job_type_id": "40b692d8-7741-4697-8eca-11d012bc4bc6",
"job_type_code": "sample string 7",
"job_type": {
"id": "4490481b-daae-403a-bec3-ce077a6d2057",
"name": "sample string 2",
"sales_organization_id": "2464ca46-038f-484b-b0e5-18e3e4904c46",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00",
"code": "sample string 7"
},
"job_priority_id": "894195eb-f2c8-4bf7-86f9-25315ab27fd3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b0731a9-b716-4dd2-a4fb-9697f069ee54",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f0b5ecda-ea1e-40dc-afed-d317216c950f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00"
},
"job_status_id": "be4b1227-da10-4497-a96b-bbea33c231af",
"job_status_code": "sample string 11",
"db_address_id": "624b6c4b-4d41-46f3-b9af-b6efa0ad40b9",
"contact_id": "5d8d960c-21fe-4260-a3ab-43f1507f26af",
"requested_by_company_id": "bea2846a-44a1-4d4a-9aad-7eaa7e77f521",
"requested_by_contact_id": "a9980b86-43c6-4235-bee1-8b7469b05651",
"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-10-11T13:13:34.4759826+00:00",
"due_date": "2026-10-11T13:13:34.4759826+00:00",
"date_create": "2026-10-11T13:13:34.4759826+00:00",
"date_update": "2026-10-11T13:13:34.4759826+00:00",
"date_closed": "2026-10-11T13:13:34.4759826+00:00",
"suggested_user_id": "dfa1d2d1-dd39-437e-890b-735d06c933e3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fd8171e4-f9f7-4842-bf03-32ac1a6204a9",
"db_language_id": "1bd44057-0c5e-483c-ace2-483adfde5374",
"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-10-11T13:13:34.4759826+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "26ba1d50-1402-466e-91b4-8b6efeac0aee",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8e8c9b4e-5fa5-424c-893b-b5bb4922c546",
"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": "07d8146f-c5cb-4c25-aab5-1ad4aec11d0c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6841d15a-8f75-4137-bc19-bec472040aa8"
},
"suggested_date_start": "2026-10-11T13:13:34.4759826+00:00",
"skill_id": "c06e7831-1f2f-4b0c-ade9-06a5ee269479",
"skill_code": "sample string 32",
"skill": {
"id": "6e3dd1fb-6fae-4916-9714-14c3afaf5d54",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5579b7c6-04ca-4b4c-9190-87f26e2a52c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd5f38dd-1ed7-4194-be50-1f01112570ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "75393b88-da51-4d90-8d9c-4c792263c053",
"db_currency_id": "b23a99df-88cd-482e-9986-b48f1eeae68d",
"db_language_id": "38dafc95-9bf3-4666-8a89-59b2f8a5478e",
"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-10-11T13:13:34.4603541+00:00"
},
"modified_dateutc": "2026-10-11T13:13:34.4759826+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c6f9eacd-f3f4-4f72-a21d-da41b31d95c5",
"date_reported_by_company": "2026-10-11T13:13:34.4916261+00:00",
"id2": 36,
"company_id": "742fc39c-9acb-4a9e-b175-ec89b7f21784",
"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": "f4849c5c-bb05-47e3-9f02-3c7d3cef8a12",
"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-10-11T13:13:34.4916261+00:00"
},
"work_instruction_details_id": "b36e4be9-8e95-487e-86b1-1a0e07d6377b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8fff67ca-f95e-4bad-8fe8-1aa02149ae34",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3f9c9ef2-2dbe-4fdc-8bac-acbc5a10e960",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-11T13:13:34.4916261+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": "c9376bfb-fb23-4cb2-94e6-c50bc0a3edf0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-11T13:13:34.4916261+00:00"
}