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": "367a96d7-cc75-4cb2-9fd2-5a0925694730",
"jobs_id": "652a6849-81b4-4018-915f-d4b86c5a91d0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "95a9c8ab-754d-43b0-8778-f1cfa5d3a8ff",
"_parent_id": "6b6b16c2-2669-49d9-a7d9-198debcf154e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7f55b8ee-2af7-44d8-8367-02b5356ec0dc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "89a28c74-0583-4dbe-b9dd-cdddb3ec5ea4",
"_parent_id": "fbb4bcff-d8ad-46d7-a463-a53a431ec8a8",
"root_parent_id": "881560c7-7050-4a9c-84e1-8558f9482603",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c2824f0d-5bb1-42c0-bab9-68d0700e723f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c47dbe53-8099-45fc-8de1-bd91e51ffdda",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2705ab3d-0991-446c-975b-714d5070d7b4",
"_parent_code": "sample string 6",
"sales_organization_id": "8635c8ea-aa08-4665-879b-e04bb7e71b99",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
},
"equipment_model_id": "006ee034-86e2-447c-9046-6c75c27a3179",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "173db1af-13d0-4acc-a74a-2df85e5cf4a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "361acd70-9be2-4c63-9665-136ce6c01173",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1a61bd2b-d48f-46b4-a406-1e03865d3ea2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5a167270-19bd-412a-8eb8-68c1aa874b37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
},
"equipment_family_id": "8253a703-7345-4e17-a925-eea5e64d4fdf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c47dbe53-8099-45fc-8de1-bd91e51ffdda",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2705ab3d-0991-446c-975b-714d5070d7b4",
"_parent_code": "sample string 6",
"sales_organization_id": "8635c8ea-aa08-4665-879b-e04bb7e71b99",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
},
"date_in_production_since": "2025-12-05T18:47:16.7934718+00:00",
"date_out_of_production_since": "2025-12-05T18:47:16.7934718+00:00",
"date_end_support": "2025-12-05T18:47:16.7934718+00:00",
"sales_organization_id": "01652f24-bd7a-4ce6-b1c5-d32d6691fbe2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+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-12-05T18:47:16.7934718+00:00"
},
"project_status_id": "7b95b668-50c7-46f3-8be4-d3c8e149f496",
"project_status_code": "sample string 10",
"project_status": {
"id": "bfbb58ae-ff8b-4e73-89e5-58b306fd33ed",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4588d493-99b8-46f9-b77b-0b71248e543b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
},
"company_id": "6d2e148b-3f2b-4e15-b240-34efc0f54dd8",
"company_code": "sample string 12",
"db_address_id": "285f4e70-e5fa-4db9-abf1-90712446368b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "65e0077d-1093-4dcb-92c6-56780b6e7ffe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "981e1928-5bae-48bf-966b-4becbe824ee0",
"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-12-05T18:47:16.7934718+00:00",
"date_create": "2025-12-05T18:47:16.7934718+00:00",
"date_update": "2025-12-05T18:47:16.7934718+00:00",
"updated_by_user_id": "ce8d7ecd-9213-4eaf-849f-da27228cd426",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T18:47:16.7934718+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-12-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T18:47:16.7934718+00:00",
"date_last_job": "2025-12-05T18:47:16.7934718+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T18:47:16.7934718+00:00",
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00",
"is_mobile_installation": true
},
"job_type_id": "a7b311c3-ae36-4209-a878-b34c0b3ff47c",
"job_type_code": "sample string 7",
"job_type": {
"id": "e65d2070-bfea-45ff-a7cf-5ff6a86e8883",
"name": "sample string 2",
"sales_organization_id": "5f20066a-f492-4a35-a987-fa676dec848f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00",
"code": "sample string 7"
},
"job_priority_id": "9aff50bd-dc94-4c33-8dc0-d337c7afb932",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "06c9bc7b-b105-4fd2-b8fb-f3fd0b387ed4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b8f75ef2-a42d-4fe1-bfb3-c1376d0a3c4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
},
"job_status_id": "727c2073-1614-40cb-bd06-318ad7080af9",
"job_status_code": "sample string 11",
"db_address_id": "fd267b6d-4f1e-42cf-83c3-de4614c167e0",
"contact_id": "f6541eb9-0230-4096-8de8-e66a383dfc99",
"requested_by_company_id": "3626d0f6-103d-4c0a-9389-20fce8111706",
"requested_by_contact_id": "97373c96-b8c5-4b6b-8ef1-c306447433a8",
"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-12-05T18:47:16.7934718+00:00",
"due_date": "2025-12-05T18:47:16.7934718+00:00",
"date_create": "2025-12-05T18:47:16.7934718+00:00",
"date_update": "2025-12-05T18:47:16.7934718+00:00",
"date_closed": "2025-12-05T18:47:16.7934718+00:00",
"suggested_user_id": "8f471f91-d3be-498e-9855-a41c1a816fb0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "033d7843-69c5-4371-8cc4-07dd8c3d5639",
"db_language_id": "2f5b25c2-2eb9-45a4-b328-d34f91ca0c84",
"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-12-05T18:47:16.7934718+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dfe6febf-4ca5-49d5-bda3-0121c06e5c07",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "32b74f8d-66aa-4ed6-958b-407c83fa8374",
"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": "2d04e411-5981-4b54-88e0-c2b63ac732be",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5aaaa2f8-cf7e-477d-a7ef-99fa9459c2a7"
},
"suggested_date_start": "2025-12-05T18:47:16.7934718+00:00",
"skill_id": "66eaa9e3-c213-4942-bccf-1882ad56e379",
"skill_code": "sample string 32",
"skill": {
"id": "b9191401-2cf9-4cae-9564-a274ef58dff0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7b26f9d7-0b1a-451e-bf60-05b4ba6c94b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "369e32d0-bde0-41ee-8110-b8e521d21641",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b9eda13-c879-443a-bad3-55aaefd55f59",
"db_currency_id": "8099d1e6-6596-494f-9661-15d7b665ebfc",
"db_language_id": "da142139-3c35-4e1a-9dd7-8a0cae6965a7",
"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-12-05T18:47:16.7934718+00:00"
},
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cad9e7e7-6df4-49d1-8325-40d9866b1b19",
"date_reported_by_company": "2025-12-05T18:47:16.7934718+00:00",
"id2": 36,
"company_id": "7969ffb6-4272-42ce-9aa2-8d249539a927",
"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": "88c86cff-e45e-46d8-a228-b4180f34429f",
"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-12-05T18:47:16.7934718+00:00"
},
"work_instruction_details_id": "b2ed222f-3ee3-4294-946e-ec7d6e342e3f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5bf373de-25d8-4597-ac43-69836b248f47",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "25b7e1ad-62c0-4b21-95f7-b04a12f5c97a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T18:47:16.7934718+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": "67b27604-9ed2-46ed-838d-6467ea08c3f3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T18:47:16.7934718+00:00"
}