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": "bb978afb-0940-481f-9f09-e17e96ee34f5",
"jobs_id": "bf3ebd83-22c3-4f07-b8a8-bf136872fe9d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "061de303-e694-43e9-8264-1f37409a7e30",
"_parent_id": "24a6f509-6e04-4290-b6b8-a90d5fb3e291",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "049d7b04-eee7-499c-a326-9af46ab521c7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "15381f3b-c3d9-4fdd-9679-8bc4872ab875",
"_parent_id": "77a40b35-740c-43ed-82af-978850bd6c65",
"root_parent_id": "b70896c9-982a-46b4-a18a-ec6a8b5b350d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8ef6dbe5-88bf-484d-890e-3d34745c027c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e321990a-028f-431e-882f-30371bb3d76d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3b7ef16-c36d-4663-9fb6-9121ecc251ca",
"_parent_code": "sample string 6",
"sales_organization_id": "201a0093-c1c0-4fdf-95e5-96d7b98b2e1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
},
"equipment_model_id": "b6ccf623-2b9e-4820-b03d-8795baf4382a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "154ee4bc-1d1a-4cf5-ac78-8506cc7ef902",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "12d900e9-d6cf-485c-8dcf-e8e47a94f0e0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05ad02c5-b329-4a7c-9b2a-4d8109da0f73",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a97650c0-d912-4a00-9205-2543bc822d1f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
},
"equipment_family_id": "f1457899-45ab-429f-95ae-84b03bdc004a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e321990a-028f-431e-882f-30371bb3d76d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3b7ef16-c36d-4663-9fb6-9121ecc251ca",
"_parent_code": "sample string 6",
"sales_organization_id": "201a0093-c1c0-4fdf-95e5-96d7b98b2e1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
},
"date_in_production_since": "2026-02-12T08:29:04.9302049+00:00",
"date_out_of_production_since": "2026-02-12T08:29:04.9302049+00:00",
"date_end_support": "2026-02-12T08:29:04.9302049+00:00",
"sales_organization_id": "3d516e0b-0123-48f1-b6f8-88fda4b3c376",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+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-02-12T08:29:04.9302049+00:00"
},
"project_status_id": "c1f3a1a5-d091-4185-8e94-d85840ec2828",
"project_status_code": "sample string 10",
"project_status": {
"id": "5bf1b0fe-de1d-437b-8062-3be53e650d41",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4e77536a-5cad-4093-8ec4-3b7e669e8eb7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
},
"company_id": "b8335035-801c-4eea-b5cf-5cf233165602",
"company_code": "sample string 12",
"db_address_id": "1124270c-268b-4209-8c2c-9c18e2ef016c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7df79ad7-bae7-474c-9de1-3a6122d4b9db",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7c7083f5-8d95-4e39-9d7e-493e411aea74",
"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-02-12T08:29:04.9302049+00:00",
"date_create": "2026-02-12T08:29:04.9302049+00:00",
"date_update": "2026-02-12T08:29:04.9302049+00:00",
"updated_by_user_id": "3e6a97a6-27bb-4256-98d8-37c4a069e515",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-12T08:29:04.9302049+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-02-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-12T08:29:04.9302049+00:00",
"date_last_job": "2026-02-12T08:29:04.9302049+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-12T08:29:04.9302049+00:00",
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00",
"is_mobile_installation": true
},
"job_type_id": "a1efc969-05d3-472f-81d5-c7f7cabe316d",
"job_type_code": "sample string 7",
"job_type": {
"id": "51e17926-f645-40fa-a94a-3d09da6813a3",
"name": "sample string 2",
"sales_organization_id": "71a9bc85-57aa-4e95-9d90-0f07def1e81c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00",
"code": "sample string 7"
},
"job_priority_id": "02984979-05c9-41f3-9fc2-e0450c82fe8c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c31702fe-6f23-4318-8cb4-b3728f944a73",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "15dd5278-c325-44a5-8442-e691b349925a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
},
"job_status_id": "603fc107-f5be-4467-b47d-e232f388494a",
"job_status_code": "sample string 11",
"db_address_id": "3ea4e2bb-661e-4321-982a-ca01fd116dac",
"contact_id": "69befbcb-f5c2-49b7-b525-2fd7e4579387",
"requested_by_company_id": "159f806e-ba8a-4ce5-b07d-6f18668724e6",
"requested_by_contact_id": "61382cea-cc19-4a6d-9cd5-a5cf5ee42bb5",
"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-02-12T08:29:04.9302049+00:00",
"due_date": "2026-02-12T08:29:04.9302049+00:00",
"date_create": "2026-02-12T08:29:04.9302049+00:00",
"date_update": "2026-02-12T08:29:04.9302049+00:00",
"date_closed": "2026-02-12T08:29:04.9302049+00:00",
"suggested_user_id": "16b285e1-55b1-4610-b76b-d9313f6d7541",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1977ff66-e023-46d5-96df-15c99a232007",
"db_language_id": "97f7603b-df3d-4fc3-9a62-76b672369344",
"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-02-12T08:29:04.9302049+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "035f53d6-53f7-4920-9030-f6cc4174a02d",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "287ed195-fdf4-4c53-803d-8a54768d05ba",
"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": "938a144e-6460-4892-9dc5-20c237e174e5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c8c4ae89-542f-4c35-b26d-aa175314919c"
},
"suggested_date_start": "2026-02-12T08:29:04.9302049+00:00",
"skill_id": "2edae6a5-118a-47f4-86d9-694a7e3fe704",
"skill_code": "sample string 32",
"skill": {
"id": "dbc57d7e-1e97-4396-bc3c-c48f8e9ed877",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "80af9755-eef1-4b3f-9d09-c5ce1dba7cdd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d8597938-f470-46e1-b8b6-54f5217e65d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0df4855-fee5-46e7-9ce7-6246c75b99e0",
"db_currency_id": "c02d2dd5-80f6-4a41-9803-8192ec30db81",
"db_language_id": "d2bbaaf1-ce11-4a49-9d6d-5bfac475e2e3",
"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-02-12T08:29:04.9302049+00:00"
},
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8c35eff5-81ab-41d9-bc40-fdbef0a1e1b4",
"date_reported_by_company": "2026-02-12T08:29:04.9302049+00:00",
"id2": 36,
"company_id": "7545603d-2c24-4358-a913-bb8fc4727b5a",
"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": "46ee0068-621f-4cdc-82b8-0a2ca99cce4e",
"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-02-12T08:29:04.9302049+00:00"
},
"work_instruction_details_id": "6ff86ca6-4bbe-484a-9996-22924ed0845b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "29e85cb4-a8aa-4456-a2be-f232ee883e39",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a16d69db-bc59-4e5f-aebe-ac5ba6cb9f11",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-12T08:29:04.9302049+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": "7d52d1a2-4c2e-40fc-bd0e-613a1706b10b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-12T08:29:04.9302049+00:00"
}