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": "a1e4a709-d73e-46e1-a4d7-538c38204392",
"jobs_id": "7098f38b-e68c-4100-8471-9152cf158812",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d82cb9ca-f2a7-4a31-a33b-6d7fdc5e0670",
"_parent_id": "3b44b54a-fa41-4483-b4cb-50fc0e8e25c2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8664cc37-64a4-4284-a87e-a6fcded55862",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b80af3e4-9c28-4d2b-9cae-b8ce63dba68b",
"_parent_id": "ad3fbf4e-ceee-4ea6-bf48-a87354ee93e8",
"root_parent_id": "b813712a-324f-4de9-ba0a-6413b66c26c0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "21afa06c-eaff-437f-bb98-be2f74b722b3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bf2823ad-70b9-4f33-b3be-fafa7929d7f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8a8c6afe-4835-4852-9936-71d22f6399b4",
"_parent_code": "sample string 6",
"sales_organization_id": "eda13cd5-657e-4d53-abcd-34c6ad5b34da",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00"
},
"equipment_model_id": "a6c3cb1e-fd30-4cd7-8fd9-54212d7d5f76",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4240128e-7b48-41c3-a979-1c708a9e4f53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "74551fa9-4cfa-41d9-a264-234ce5e5d6fd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d4ad2d44-552f-4e84-8872-96927c51f3f3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b3f8e4f1-7dc8-43b6-a1d4-9b1fc8b9e46e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00"
},
"equipment_family_id": "0ef3a624-df6c-4691-a5c2-92a004eb784f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bf2823ad-70b9-4f33-b3be-fafa7929d7f3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8a8c6afe-4835-4852-9936-71d22f6399b4",
"_parent_code": "sample string 6",
"sales_organization_id": "eda13cd5-657e-4d53-abcd-34c6ad5b34da",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00"
},
"date_in_production_since": "2026-01-31T19:20:23.8789959+00:00",
"date_out_of_production_since": "2026-01-31T19:20:23.8789959+00:00",
"date_end_support": "2026-01-31T19:20:23.8789959+00:00",
"sales_organization_id": "a7417ea1-f5ed-4405-9bb3-ad986dccab8b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+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-01-31T19:20:23.8789959+00:00"
},
"project_status_id": "6f80dfa5-2502-4482-9418-022eee920000",
"project_status_code": "sample string 10",
"project_status": {
"id": "d48e19ca-81bd-4700-89a1-4c018da3843c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f0aef01a-5c8d-4acf-b8ad-8dfc4d05c841",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00"
},
"company_id": "6a450f3b-0df2-4b67-a155-125a8855bed4",
"company_code": "sample string 12",
"db_address_id": "54eb689a-376f-4a1f-806e-17a4b3e4ee9d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a842e74e-3d02-4869-a8fa-f0a1adf23a5e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8263ba36-331c-4b25-9647-dfc9d31baefb",
"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-01-31T19:20:23.8789959+00:00",
"date_create": "2026-01-31T19:20:23.8789959+00:00",
"date_update": "2026-01-31T19:20:23.8789959+00:00",
"updated_by_user_id": "765da6e1-e62a-44ad-b05c-e53690ffb04f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-31T19:20:23.8789959+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-01-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-31T19:20:23.8789959+00:00",
"date_last_job": "2026-01-31T19:20:23.8789959+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-31T19:20:23.8789959+00:00",
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00",
"is_mobile_installation": true
},
"job_type_id": "921cda2b-a277-4fe4-810e-084419e39441",
"job_type_code": "sample string 7",
"job_type": {
"id": "e637a77a-a016-4aeb-a4be-c9af6b16d1e3",
"name": "sample string 2",
"sales_organization_id": "cf9a5c27-aee3-4135-ade2-0719151f2e1d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00",
"code": "sample string 7"
},
"job_priority_id": "e5f436d2-ae48-4a67-a413-311c1e179cd4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "317e7a60-3060-410f-909e-560e39468177",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "eb5fa542-3d98-4561-a454-1876d75f4009",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00"
},
"job_status_id": "a86e28cd-9950-4e6b-bc22-1fd01e14ff08",
"job_status_code": "sample string 11",
"db_address_id": "2f14a57c-099e-460e-8e30-620215dc3633",
"contact_id": "fed4ce26-29a9-45f3-8730-b1fc9acacc4c",
"requested_by_company_id": "88b92a3f-727d-471a-bed3-f350a4867960",
"requested_by_contact_id": "7d58de70-7b63-4574-aae7-55d97b5b9f03",
"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-01-31T19:20:23.8789959+00:00",
"due_date": "2026-01-31T19:20:23.8789959+00:00",
"date_create": "2026-01-31T19:20:23.8789959+00:00",
"date_update": "2026-01-31T19:20:23.8789959+00:00",
"date_closed": "2026-01-31T19:20:23.8789959+00:00",
"suggested_user_id": "9bb2cf65-1b96-47a5-9620-fff16a672e3a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "922ddbb3-4e08-4c6a-8971-d11a35212ea6",
"db_language_id": "0d06348e-0983-4abb-b250-44b782072442",
"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-01-31T19:20:23.8789959+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b9749b60-101f-4c7e-a9d1-86dbf199cba1",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9f5026ce-cef1-4908-b018-93e6886c333e",
"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": "6b87fe52-34d8-4bf9-9031-5001a61c543b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-31T19:20:23.8789959+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fbaa9b2c-a891-4444-bb79-3d1747f5448a"
},
"suggested_date_start": "2026-01-31T19:20:23.8789959+00:00",
"skill_id": "55558a19-a31e-43e0-be22-8dd6f1feab4a",
"skill_code": "sample string 32",
"skill": {
"id": "07d64fc5-7cd4-41dd-bbe4-951167f6f475",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9139f1c2-8d56-4e76-bd86-0c7ce1063b4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f4a2a53-2a5e-4004-8e21-4afe8f47ba62",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "845069d3-d2cb-4152-9ea6-ebb90065f007",
"db_currency_id": "b691b969-c47a-4385-960b-1dac5484e657",
"db_language_id": "c9b8cbe2-400c-4b4f-9e49-0130bfbeeadb",
"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-01-31T19:20:23.8789959+00:00"
},
"modified_dateutc": "2026-01-31T19:20:23.8945481+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "99113559-8b6e-4e44-9808-ee631ba69bba",
"date_reported_by_company": "2026-01-31T19:20:23.8945481+00:00",
"id2": 36,
"company_id": "ef89530a-bcfe-4e43-9462-9fd93bba868c",
"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": "70f5db8a-ad19-4c35-80d2-341f0a4f9860",
"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-01-31T19:20:23.8945481+00:00"
},
"work_instruction_details_id": "b96ad2b9-87d7-472c-b0d1-317faed0f262",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9182a5e4-1215-4918-9c2c-f0d2101e2c50",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "92daa7d2-f484-4ac6-bac0-ccb12db4dc32",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-31T19:20:23.8945481+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": "53fea5f0-9aa6-48f9-a7da-da4cb6288e29",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-31T19:20:23.8945481+00:00"
}