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": "a766b6f2-8899-46fa-aed7-493f6f3a1dd1",
"jobs_id": "41b142be-f3f1-49b2-8fb9-940a30a1a027",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b010617a-8f75-4cbe-bb47-4251fbb2699c",
"_parent_id": "768225c4-b9bf-4239-b456-034b7d00a89f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cc22a6b7-78a3-4000-8592-bf5d81a37b43",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b00a2c1c-0cf2-43a6-92be-1f8512d95fb5",
"_parent_id": "4188a80f-34ff-4db7-9fe0-eaf91b9e3aa8",
"root_parent_id": "4fa84be2-83c3-4f21-b3a6-f2433a954932",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "330c82ad-aae0-4e9b-b839-f2d06a643921",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b713ec24-e356-4643-acaf-e6aa161570d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2d8f17a-c07f-4c2f-991e-30f341e34cdd",
"_parent_code": "sample string 6",
"sales_organization_id": "9884bd38-2e33-4aa7-8148-110227d9ef9c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
},
"equipment_model_id": "dea4cc18-816e-4c5b-bee2-70e1744063c7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9b9440a2-2dc8-4bd0-860f-cd04a0babb3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4037edaa-e0ee-4ccf-a976-367b37147fd0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d57ddbb0-2704-48c2-906f-171f2c41239c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "655067f6-9625-4754-ac47-8c98aa57f669",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
},
"equipment_family_id": "8332a29a-536b-4766-9a18-aa2577774b37",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b713ec24-e356-4643-acaf-e6aa161570d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2d8f17a-c07f-4c2f-991e-30f341e34cdd",
"_parent_code": "sample string 6",
"sales_organization_id": "9884bd38-2e33-4aa7-8148-110227d9ef9c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
},
"date_in_production_since": "2025-11-09T21:36:29.0496601+00:00",
"date_out_of_production_since": "2025-11-09T21:36:29.0496601+00:00",
"date_end_support": "2025-11-09T21:36:29.0496601+00:00",
"sales_organization_id": "bfb7f7b0-16e9-4999-bc9a-0a8b14ba1f49",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+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": "2025-11-09T21:36:29.0496601+00:00"
},
"project_status_id": "15f04ffb-0584-4cd3-9483-a71e0adc38e7",
"project_status_code": "sample string 10",
"project_status": {
"id": "2ac81424-9c28-412e-b0ef-aa2d6c855c47",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4c2bfd84-a6b2-4956-bed8-57d42e2977d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
},
"company_id": "ef71c5ed-0f27-4007-bcb7-07f35f2a02f3",
"company_code": "sample string 12",
"db_address_id": "d862b6dc-718b-4cc8-971e-0886aa8e4b30",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e350bf36-310a-4d98-9bfa-d9e6cf7a0ec3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d9fd7e1b-0181-4ba4-bd20-256a0b3335c7",
"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": "2025-11-09T21:36:29.0496601+00:00",
"date_create": "2025-11-09T21:36:29.0496601+00:00",
"date_update": "2025-11-09T21:36:29.0496601+00:00",
"updated_by_user_id": "b94bc02d-9237-4e41-86bf-2b182bd9adc1",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-09T21:36:29.0496601+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": "2025-11-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-09T21:36:29.0496601+00:00",
"date_last_job": "2025-11-09T21:36:29.0496601+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-09T21:36:29.0496601+00:00",
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00",
"is_mobile_installation": true
},
"job_type_id": "defe710e-72cf-4034-b3fd-8e3b8ece8d3e",
"job_type_code": "sample string 7",
"job_type": {
"id": "d85e7b10-2757-4793-bd21-fe919ee64b54",
"name": "sample string 2",
"sales_organization_id": "88140b66-c52d-42f4-926b-72f5a6eb48a3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00",
"code": "sample string 7"
},
"job_priority_id": "39444956-69e9-45f5-a077-9805bd1d0089",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb9864cd-487c-4c66-aa0a-b02a318823a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "907d8fc7-fd58-4fbc-9eeb-69e05c829627",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
},
"job_status_id": "22d1c33d-a761-49e1-8abd-88bf8ab00934",
"job_status_code": "sample string 11",
"db_address_id": "87c718d4-5877-4529-9134-f21bac35f3a8",
"contact_id": "d2b35edb-40dd-48e2-8975-3911ab577671",
"requested_by_company_id": "bb400665-5a9b-4faa-977c-6f9eebe754fa",
"requested_by_contact_id": "ac414098-4829-4fbe-a878-74ac33ba3773",
"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": "2025-11-09T21:36:29.0496601+00:00",
"due_date": "2025-11-09T21:36:29.0496601+00:00",
"date_create": "2025-11-09T21:36:29.0496601+00:00",
"date_update": "2025-11-09T21:36:29.0496601+00:00",
"date_closed": "2025-11-09T21:36:29.0496601+00:00",
"suggested_user_id": "8c6edbda-9cdd-470a-ab98-0fa876e59ebf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c2ab51a1-58c5-4b6e-a798-e3327790372c",
"db_language_id": "ca80796f-b518-44ef-bf34-21eef34ef060",
"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": "2025-11-09T21:36:29.0496601+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "de5897a9-0112-4497-9535-f8f42cc10f4c",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "96f700a8-002c-4d3e-84fa-b71a4e1bae5c",
"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": "f5c5a2b8-90e2-4629-8fb4-818c3923b3a7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8e95fcc-8548-46f7-9349-9e0566665f00"
},
"suggested_date_start": "2025-11-09T21:36:29.0496601+00:00",
"skill_id": "cf046ce5-96ad-4dbc-9075-4610c040bb74",
"skill_code": "sample string 32",
"skill": {
"id": "36d9a5d4-771c-483f-8a1a-773f745df365",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c8bc65f9-701a-49f0-ae28-18c11423fdf0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1bb945c-f07f-40a7-9a2b-637723459517",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1408fe26-ee25-4667-9751-88d2a2719ef1",
"db_currency_id": "e3ac568e-559f-419d-aaed-49971f3e75e7",
"db_language_id": "6ac2f000-59f4-48fe-b9f6-050a46c734d8",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4b2c2db-271e-480e-bb67-9247c5982671",
"date_reported_by_company": "2025-11-09T21:36:29.0496601+00:00",
"id2": 36,
"company_id": "8e8a49f3-2cfa-4570-bddb-fcbd5ff44d8d",
"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": "fb640891-1fb4-4010-b81a-7b70b75cdb38",
"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": "2025-11-09T21:36:29.0496601+00:00"
},
"work_instruction_details_id": "ff499590-8987-469a-8df8-7a354195e830",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "935407f2-0fc0-4d4e-8fe5-eb9818d27174",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a7f8f452-72f0-4778-9a48-584fb1490a0c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-09T21:36:29.0496601+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": "26736001-6009-4f5b-9f06-badc25ea6aa6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-09T21:36:29.0496601+00:00"
}