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": "36f409cd-9432-4588-8ea5-eb3916c6aba3",
"jobs_id": "6d2a09db-53d5-4862-b049-e93e52fd24de",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e509b28d-5f19-4fcd-b08b-587f6c4481da",
"_parent_id": "573dd576-f30e-47db-8cea-b01e63fa652e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b74a1f73-ea6c-4644-871a-3b646eb034c6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9d49a2d3-4d61-49c9-a515-407f5bc7d4b3",
"_parent_id": "06a338cb-2c22-4f93-b689-d653a2c63be5",
"root_parent_id": "bc692844-eccb-4d94-a7fb-733735eaddf2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e347d660-3e9c-440c-8a66-e6a8191651a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fac42167-7a65-4339-96dc-f6ad2e25d9d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "82718023-3bb3-43ec-834f-eaca30131c47",
"_parent_code": "sample string 6",
"sales_organization_id": "167d13f5-e90a-4778-ac7a-af460f82448a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
},
"equipment_model_id": "9b8bc4ed-cf93-4bd5-85bb-86b00ed7e660",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "87dd2539-1e95-40a7-abec-812801738cb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "56b2ede8-6966-416e-8dc4-0b35492f5e06",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4f88d19f-fd14-4070-b574-13d9984e75b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7191c39d-d025-4c25-91c3-d944cfc40295",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
},
"equipment_family_id": "7892dc34-32f3-485f-8b2f-e5b57bfc5dfd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fac42167-7a65-4339-96dc-f6ad2e25d9d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "82718023-3bb3-43ec-834f-eaca30131c47",
"_parent_code": "sample string 6",
"sales_organization_id": "167d13f5-e90a-4778-ac7a-af460f82448a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
},
"date_in_production_since": "2026-06-08T16:52:07.7385802+00:00",
"date_out_of_production_since": "2026-06-08T16:52:07.7385802+00:00",
"date_end_support": "2026-06-08T16:52:07.7385802+00:00",
"sales_organization_id": "16da3819-00e2-4eb2-8150-d28e4cb736c6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+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-06-08T16:52:07.7385802+00:00"
},
"project_status_id": "a38b047f-12c8-4d4b-8dc3-a7555b552b57",
"project_status_code": "sample string 10",
"project_status": {
"id": "8db827f8-bd86-4307-a73b-68e91659e91e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1e32dbdb-8032-4d39-9b98-49c2c3cf4353",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
},
"company_id": "b24fc164-4398-4517-a62a-fd3943949c22",
"company_code": "sample string 12",
"db_address_id": "2770ba54-b738-4365-91d3-d85307fa7212",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6f2aafea-556b-4dfa-8813-fad50ce740e2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "641f9ea6-e395-43e8-8921-45cadf2eae15",
"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-06-08T16:52:07.7385802+00:00",
"date_create": "2026-06-08T16:52:07.7385802+00:00",
"date_update": "2026-06-08T16:52:07.7385802+00:00",
"updated_by_user_id": "73d2c9dd-f96f-4993-ab09-b8a3286a2575",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-08T16:52:07.7385802+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-06-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-08T16:52:07.7385802+00:00",
"date_last_job": "2026-06-08T16:52:07.7385802+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-08T16:52:07.7385802+00:00",
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00",
"is_mobile_installation": true
},
"job_type_id": "7dc1f85e-0ccf-4c5d-9165-bfb414418a70",
"job_type_code": "sample string 7",
"job_type": {
"id": "15995cde-026c-4dd3-a271-e9412673acbd",
"name": "sample string 2",
"sales_organization_id": "2c892afe-57f4-4fb3-9c88-566b6091ba8e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00",
"code": "sample string 7"
},
"job_priority_id": "1880040f-7532-4d6f-be1c-4dcbcc8848ec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c79c4a79-10d7-457b-8b45-16d88c42dde1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "563aaeec-e73e-42d3-8258-32a2376b8a38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
},
"job_status_id": "efce28ff-9545-4bbf-bda1-e031a3798b4c",
"job_status_code": "sample string 11",
"db_address_id": "e2f0217c-87a7-44ad-bbc9-6ec24ab0e493",
"contact_id": "c4f6e226-13c9-48b0-aca5-44c598cff193",
"requested_by_company_id": "4098b0bd-ffe3-487c-814b-c91065b57e90",
"requested_by_contact_id": "18c94f3a-249d-4df4-9d36-722effc813e2",
"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-06-08T16:52:07.7385802+00:00",
"due_date": "2026-06-08T16:52:07.7385802+00:00",
"date_create": "2026-06-08T16:52:07.7385802+00:00",
"date_update": "2026-06-08T16:52:07.7385802+00:00",
"date_closed": "2026-06-08T16:52:07.7385802+00:00",
"suggested_user_id": "4caf6407-51cb-4cf9-9718-fcf9aeb4d128",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7369c497-9f36-45e4-ab16-8a122b1e00ff",
"db_language_id": "489ee87e-eb6c-4d74-8a93-255442508e7c",
"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-06-08T16:52:07.7385802+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6b9df05f-bf62-48b2-b08e-a055035a545f",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b997d93-a907-4be4-9ca5-0347490bf8f5",
"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": "9f8430a4-f56e-4743-8a7a-1f9e34f8d439",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "63254032-e5cf-4477-b3c3-e46464a46902"
},
"suggested_date_start": "2026-06-08T16:52:07.7385802+00:00",
"skill_id": "7405578f-d200-461a-a9ad-f1651c448756",
"skill_code": "sample string 32",
"skill": {
"id": "0b7d5b1d-8c72-4864-bf32-f577efe5c58e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8ca74f56-c03e-448f-accb-5cf0355df514",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1857bcb-5011-46f9-8990-25b23d8004b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e7d8899-e542-4ac5-940e-7cb588a7f06a",
"db_currency_id": "7aa3b1c1-2b1a-48f9-ad88-c3ee09febd57",
"db_language_id": "f2555349-044f-4ced-b9ff-a29722b4866c",
"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-06-08T16:52:07.7385802+00:00"
},
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fee69ec5-a893-4cb7-bf8c-ec831fa5200a",
"date_reported_by_company": "2026-06-08T16:52:07.7385802+00:00",
"id2": 36,
"company_id": "0445385b-b63a-4c0c-8d4b-36b470ce268c",
"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": "0f92658f-1eba-410b-a679-994110924c7d",
"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-06-08T16:52:07.7385802+00:00"
},
"work_instruction_details_id": "b3a14280-48ca-4a3d-81bc-0e32716ea8ed",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2a5d1a20-522f-4209-a37a-ac8ede387f9f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2e60d187-a7af-4b3c-ac30-1173466049dc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-08T16:52:07.7385802+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": "e2bde0c2-a06f-4e1a-8d5e-d9f041f193d3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-08T16:52:07.7385802+00:00"
}