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": "720047b7-56a2-424e-9c73-6faee644fb3b",
"jobs_id": "e3a545ba-27e5-4d92-bb6f-c69717bea7f2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6eb4076d-cd70-47a4-bca4-46bbcb6ce1b3",
"_parent_id": "f6af5125-0721-4060-ad69-89a0e97c996a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1a8fa197-8f0f-4f95-8ee5-09c7a4b284e0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "616128a9-1ce0-40ef-97b7-50d72adcb1c9",
"_parent_id": "44f8a8a9-b78f-45d8-a826-a630276ac701",
"root_parent_id": "8ed4d9a4-da6c-44ca-93fe-952b2119b813",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a5081bf4-7410-4e4e-b78d-e45647dbfefe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "571462dc-b07c-4c63-a463-1f7b1db3bcdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b84cd079-4c90-44b2-afb5-729ddb28ddde",
"_parent_code": "sample string 6",
"sales_organization_id": "7682ca7d-51ce-479c-8eeb-13d6b2f270f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
},
"equipment_model_id": "bc89c8c3-31b3-40eb-b68c-7a535a62c51e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "74ece249-4f44-42e2-a660-19f5a59a7d94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b917086f-30a4-4842-a786-13fb9b7b9314",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "13e55965-3b6c-46f9-bdc2-fc2780692a62",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1eada7bc-efff-4d2f-b3a3-3b2c7b25d2c6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
},
"equipment_family_id": "452b63a0-bd5a-4b36-a448-f0acaf47da43",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "571462dc-b07c-4c63-a463-1f7b1db3bcdb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b84cd079-4c90-44b2-afb5-729ddb28ddde",
"_parent_code": "sample string 6",
"sales_organization_id": "7682ca7d-51ce-479c-8eeb-13d6b2f270f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
},
"date_in_production_since": "2026-07-09T05:27:15.1342082+00:00",
"date_out_of_production_since": "2026-07-09T05:27:15.1342082+00:00",
"date_end_support": "2026-07-09T05:27:15.1342082+00:00",
"sales_organization_id": "f4b343e3-204c-4cd3-874e-5c28fc807c28",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+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-07-09T05:27:15.1342082+00:00"
},
"project_status_id": "ef7f7c05-ddd1-4e7b-857f-8f5d8c0d5379",
"project_status_code": "sample string 10",
"project_status": {
"id": "8393e4c0-33bb-4e9f-a2c5-247d91d47d6b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f10b7007-aaae-4cf7-908c-da36b19e1682",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
},
"company_id": "f5394913-5454-4e37-ae85-252f51c777be",
"company_code": "sample string 12",
"db_address_id": "11623979-0da6-4259-8ab3-6f7d0ee8d3c2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "68ca1e7a-302d-412a-a997-2dd8cdcae492",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5a788b57-6ca9-4131-a20f-06eb03aa8889",
"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-07-09T05:27:15.1342082+00:00",
"date_create": "2026-07-09T05:27:15.1342082+00:00",
"date_update": "2026-07-09T05:27:15.1342082+00:00",
"updated_by_user_id": "05595fc9-aff3-4a74-8abc-983fb9e9906f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-09T05:27:15.1342082+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-07-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-09T05:27:15.1342082+00:00",
"date_last_job": "2026-07-09T05:27:15.1342082+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-09T05:27:15.1342082+00:00",
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00",
"is_mobile_installation": true
},
"job_type_id": "09496c56-2f6b-4c71-b2a1-7557e567cb3a",
"job_type_code": "sample string 7",
"job_type": {
"id": "cba819fb-33b6-43fa-8ef2-d640523722ae",
"name": "sample string 2",
"sales_organization_id": "fd2f2aa0-1ad1-4f1f-842e-25457193bac3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00",
"code": "sample string 7"
},
"job_priority_id": "11ac3a97-7a49-45f2-a609-9500329fbd83",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7fa4998c-8069-457c-b214-7b6ebf7c90bb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "11598124-6ef8-4a25-b69b-1e618dd016a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
},
"job_status_id": "a5ab5f5b-8c7b-475e-8b8a-b7cbabe5cefe",
"job_status_code": "sample string 11",
"db_address_id": "097df177-aba1-4f43-82cc-9670ff3a4cbd",
"contact_id": "bdba2971-94b2-4c54-a4d9-779c40376b98",
"requested_by_company_id": "d4daa001-37a9-4efe-8674-b78b974d4c41",
"requested_by_contact_id": "c0e47f3f-0835-4571-b38a-96a64421fd7e",
"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-07-09T05:27:15.1342082+00:00",
"due_date": "2026-07-09T05:27:15.1342082+00:00",
"date_create": "2026-07-09T05:27:15.1342082+00:00",
"date_update": "2026-07-09T05:27:15.1342082+00:00",
"date_closed": "2026-07-09T05:27:15.1342082+00:00",
"suggested_user_id": "2949027d-51de-43e9-8406-097c6a356813",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e3974ead-b581-4d1a-a927-f740ccbf523a",
"db_language_id": "d639ea87-9172-4987-8cfc-724ed6c5ff84",
"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-07-09T05:27:15.1342082+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8029d430-97ff-443e-afa0-d989310ba14b",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f0a2e56a-5429-4ef2-905a-4c6c544d2036",
"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": "cba8a5d3-0d49-41c9-a848-728605a20c65",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "21798981-89c9-4a06-8488-88bc7adfa791"
},
"suggested_date_start": "2026-07-09T05:27:15.1342082+00:00",
"skill_id": "0cc3944e-fc6e-4412-96c0-97777dca85b9",
"skill_code": "sample string 32",
"skill": {
"id": "7d72030e-92db-42ec-ad7a-62c47a7f06d1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d3aa380c-de92-41bb-9d94-6941b27732c7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e49faae1-7594-4ad0-9fc0-78407047e56b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4806ac90-3634-470e-8aa8-297f8cfa8ed0",
"db_currency_id": "5b750345-ee4e-440c-992c-3150d1805c34",
"db_language_id": "42b15734-aaa9-4aef-bf73-244c9e1f06d8",
"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-07-09T05:27:15.1342082+00:00"
},
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e04a0b0c-5c1a-4eb1-9d47-0ac6dd0e5d98",
"date_reported_by_company": "2026-07-09T05:27:15.1342082+00:00",
"id2": 36,
"company_id": "f3cab4a4-e4b2-4bf1-a2c1-77f988ce07b3",
"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": "8cf30d7b-fcd1-4425-858b-74c4d58aa2f5",
"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-07-09T05:27:15.1342082+00:00"
},
"work_instruction_details_id": "79d51b36-f127-440d-a3d2-5dee7ba8112e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "957c0c57-679f-4889-b64b-158d7aada94a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9e734d71-90b6-4b55-91e6-f416f87c771f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-09T05:27:15.1342082+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": "83225d63-a5b2-4a9c-8044-d1d1e0a04b6d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-09T05:27:15.1342082+00:00"
}