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": "9c8fd9b6-aa64-4a36-82ac-566c633f4946",
"jobs_id": "de1fb5fe-61d6-4519-b89d-13606f5b2195",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1a6242f9-f779-419f-a37f-8e2125ae1919",
"_parent_id": "c23cc33b-eebd-4756-9402-72bdba45f2ed",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5aa24570-d89e-4f6f-a186-4b3d067b4894",
"project_reference_back_office": "sample string 5",
"project": {
"id": "05e17da2-987e-4992-840e-c1f7342db8de",
"_parent_id": "dd4209bd-cfae-4904-a8dc-1c417de866b9",
"root_parent_id": "e879f034-1a2c-4714-8f28-173b8ecc3e9b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0a6bef6d-045c-45be-8580-7d01ac8e531c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9fe77f76-3d4c-4dff-b687-16cbc8233f4c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46532adf-e9d0-4d1e-ab5a-2161285d5638",
"_parent_code": "sample string 6",
"sales_organization_id": "7c5fd8ff-10b0-43f8-aad4-5ace57737a0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
},
"equipment_model_id": "558f8fb2-851a-4f7b-a92f-e2f4b427be84",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a302fb6b-a7ee-48ca-8499-c0d18a5ea22b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cc61023e-0ae6-4c1a-b145-cdc19bb4d3f3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7ca0f83a-ffe5-43c0-8d42-571de4a989bd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "30f4e59e-52f7-439b-a982-9a73ba1f36ae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
},
"equipment_family_id": "b29ab296-01f6-4f86-a011-85e369fa039a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9fe77f76-3d4c-4dff-b687-16cbc8233f4c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46532adf-e9d0-4d1e-ab5a-2161285d5638",
"_parent_code": "sample string 6",
"sales_organization_id": "7c5fd8ff-10b0-43f8-aad4-5ace57737a0a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
},
"date_in_production_since": "2025-11-09T08:04:28.6684322+00:00",
"date_out_of_production_since": "2025-11-09T08:04:28.6684322+00:00",
"date_end_support": "2025-11-09T08:04:28.6684322+00:00",
"sales_organization_id": "ee917582-7b25-4ad7-8799-d973d59af640",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+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-09T08:04:28.6684322+00:00"
},
"project_status_id": "975dabad-5c14-4c1a-8449-143990bb9b04",
"project_status_code": "sample string 10",
"project_status": {
"id": "d4d8c7f8-bee2-4f35-bf06-8adce6439e35",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3cbb76b6-1856-42c4-a6c3-6ceef865e5d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
},
"company_id": "e4908d0d-9cd4-4b38-81d3-16d956b26bea",
"company_code": "sample string 12",
"db_address_id": "8d92b6c5-83e5-4608-bfdc-b82e1c5beb56",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f8ea84cd-6f7a-412e-a248-6a3e74c4d96b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f80d0d5b-c2bb-4d76-b22d-eb224a512fb5",
"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-09T08:04:28.6684322+00:00",
"date_create": "2025-11-09T08:04:28.6684322+00:00",
"date_update": "2025-11-09T08:04:28.6684322+00:00",
"updated_by_user_id": "026ec3b7-5edd-4deb-b823-9434b2bf7d81",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-09T08:04:28.6684322+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-09T08:04:28.6684322+00:00",
"date_last_job": "2025-11-09T08:04:28.6684322+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-09T08:04:28.6684322+00:00",
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00",
"is_mobile_installation": true
},
"job_type_id": "205a4334-f0b3-4b13-8207-9cc2e451417f",
"job_type_code": "sample string 7",
"job_type": {
"id": "dd025ee5-bc20-46f4-a111-654d0fab364e",
"name": "sample string 2",
"sales_organization_id": "07e22f33-e195-4822-b5d6-62a5aeeaf7b2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00",
"code": "sample string 7"
},
"job_priority_id": "89fc8193-7701-4d2e-b2b1-b328310083dc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d2a41171-1ed0-41c4-8041-94142bb8e170",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3056f5eb-752f-4a6c-97d9-a2b1fd66f9d2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
},
"job_status_id": "dc592020-ec98-4a8a-a902-665c3333e1f4",
"job_status_code": "sample string 11",
"db_address_id": "aa81478a-0557-4ab5-b712-0a991f599559",
"contact_id": "1cffee74-402f-486b-b126-2dd8cbd25ecd",
"requested_by_company_id": "5478fa3a-8313-422a-8255-af324c90b9b4",
"requested_by_contact_id": "7c57ad9f-8acb-4b75-96cb-acaf2e626c7f",
"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-09T08:04:28.6684322+00:00",
"due_date": "2025-11-09T08:04:28.6684322+00:00",
"date_create": "2025-11-09T08:04:28.6684322+00:00",
"date_update": "2025-11-09T08:04:28.6684322+00:00",
"date_closed": "2025-11-09T08:04:28.6684322+00:00",
"suggested_user_id": "2565a7f8-10d9-419a-8ee7-72c0ca66be53",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e4bdd8d1-ebd9-4ac4-9251-46b3914d12cb",
"db_language_id": "dd54a531-7b5c-4a95-aea8-db77b73151e6",
"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-09T08:04:28.6684322+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d852fb16-69b9-41a8-93d5-855153f95a8d",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3ab18eae-4067-4798-9751-dd5175eb9e22",
"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": "14895584-74a3-4f0c-8690-324f3b6a4530",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8c1f774a-38d1-4424-a34b-b89fad8a3197"
},
"suggested_date_start": "2025-11-09T08:04:28.6684322+00:00",
"skill_id": "72cc9c1d-60dc-4aaf-88e5-468ce21a2f2e",
"skill_code": "sample string 32",
"skill": {
"id": "fad047ca-9ed1-40e7-8168-c88b5a5cbabc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "877702aa-eed7-4038-b6d2-14f1fbe06e89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f91726a-5acb-470a-95ea-967a16b5d928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d820af6-198c-431d-9e98-85d063f3b213",
"db_currency_id": "e2bd0e44-a165-4e45-812d-2dc9cad6c35e",
"db_language_id": "8815c91f-a39d-42cc-b7ea-c49a8a158b89",
"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-09T08:04:28.6684322+00:00"
},
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e7163b05-bf33-4c78-9c55-180ac15be30a",
"date_reported_by_company": "2025-11-09T08:04:28.6684322+00:00",
"id2": 36,
"company_id": "a0365a54-113a-4d55-8ffe-460847032040",
"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": "f9c9f543-5857-4aaa-a580-05d20317ed5c",
"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-09T08:04:28.6684322+00:00"
},
"work_instruction_details_id": "5830dcd4-a64c-4b66-8c28-f1ce3bb7df7b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ec88a873-ddfe-4b76-ba0f-db2df8d1b280",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c5336b05-5a7b-4f02-99dc-ad6a7c749ccc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-09T08:04:28.6684322+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": "b66a7db4-e865-4753-8507-bb4cadefcce9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-09T08:04:28.6684322+00:00"
}