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": "9164964e-7f1f-4069-9c31-e512e6fecf18",
"jobs_id": "ea68a481-30a7-4c4f-9b05-17f0f8e3b973",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "28a3bac1-0587-4465-8a49-0417558149ce",
"_parent_id": "f6a07220-9a4e-4fa6-8258-1df0927132dd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4548f78-2f48-4700-a2a3-57968d207534",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b9b5273c-13f8-4872-a835-e13278a02249",
"_parent_id": "bf94ceeb-9386-4db4-879c-1215163fc279",
"root_parent_id": "12ef90da-c9e3-48f1-bc17-c271c0d87a1a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a9632fe4-b346-4535-8769-905f4dbb254f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a43d1ee4-7cd3-4d4f-84cd-3ad44f3698fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "903c662d-8aba-413b-845e-0524a94a6bcb",
"_parent_code": "sample string 6",
"sales_organization_id": "17550a71-e1fe-471d-bff0-585ee43317d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"modified_dateutc": "2026-01-05T06:27:17.1293053+00:00"
},
"equipment_model_id": "b6e24f8b-d9c5-4ef0-9a5b-ceb384c1fd05",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "19c7b7a7-56b4-4a71-ae56-c322907328f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9a1047a7-a866-424b-981e-3e1c5450b1c4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0f8ae91c-d051-489b-b59b-104cbea33709",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d5888732-45d5-4c16-8267-e1822810ef7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"modified_dateutc": "2026-01-05T06:27:17.1293053+00:00"
},
"equipment_family_id": "e48f9982-32a5-4e39-a8b4-e1ad0c106987",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a43d1ee4-7cd3-4d4f-84cd-3ad44f3698fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "903c662d-8aba-413b-845e-0524a94a6bcb",
"_parent_code": "sample string 6",
"sales_organization_id": "17550a71-e1fe-471d-bff0-585ee43317d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"modified_dateutc": "2026-01-05T06:27:17.1293053+00:00"
},
"date_in_production_since": "2026-01-05T06:27:17.1449298+00:00",
"date_out_of_production_since": "2026-01-05T06:27:17.1449298+00:00",
"date_end_support": "2026-01-05T06:27:17.1449298+00:00",
"sales_organization_id": "248e3973-e48c-494b-80b8-dc88442ff4df",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+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-05T06:27:17.1449298+00:00"
},
"project_status_id": "c953531e-f092-40ea-a34e-383d569b69bb",
"project_status_code": "sample string 10",
"project_status": {
"id": "939fd4f9-38fa-4abf-954e-465edd7ddc3f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ae7644c6-3f68-4f6f-ae11-61f3053bef60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00"
},
"company_id": "c7311de9-35c1-4932-92d2-33606c47e82a",
"company_code": "sample string 12",
"db_address_id": "b296fdff-686f-4e03-b0ed-409bd3f45ade",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c30e1b5c-a162-4c55-a519-d8ab27f0fa88",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7f621b00-364e-4520-aefd-f1375cdf2a0a",
"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-05T06:27:17.1449298+00:00",
"date_create": "2026-01-05T06:27:17.1449298+00:00",
"date_update": "2026-01-05T06:27:17.1449298+00:00",
"updated_by_user_id": "a583806d-047d-49c3-b0d9-9ef06ef4bd01",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-05T06:27:17.1449298+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-05T06:27:17.1449298+00:00",
"date_last_job": "2026-01-05T06:27:17.1449298+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-05T06:27:17.1449298+00:00",
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00",
"is_mobile_installation": true
},
"job_type_id": "3305732e-8d63-4cc5-a66c-9825c13dda88",
"job_type_code": "sample string 7",
"job_type": {
"id": "b727ec89-2247-482a-8d62-978711aa801b",
"name": "sample string 2",
"sales_organization_id": "a4146654-ffc1-4a61-b53f-88975a4d88a6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e30153d-dafe-4851-a777-4e232ab7b38b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ecfae6d3-0570-4659-8820-0511da8bbfe6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "498c448a-dc0c-43b7-afe6-91a90bc43ace",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00"
},
"job_status_id": "9a6c9b7b-9450-46af-b4e9-fb2f2a098274",
"job_status_code": "sample string 11",
"db_address_id": "a493080e-995a-41a3-9c98-21e0ce861b5e",
"contact_id": "15494766-6062-4a42-b4b5-23f20cb8ba3d",
"requested_by_company_id": "8a13f3f4-59c3-443d-8152-b431a2ba339c",
"requested_by_contact_id": "867467e5-656d-4877-8048-81b0634d0b42",
"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-05T06:27:17.1449298+00:00",
"due_date": "2026-01-05T06:27:17.1449298+00:00",
"date_create": "2026-01-05T06:27:17.1449298+00:00",
"date_update": "2026-01-05T06:27:17.1449298+00:00",
"date_closed": "2026-01-05T06:27:17.1449298+00:00",
"suggested_user_id": "9f0c2ccf-3f60-429b-bf0c-3293b7e1ffd7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "67b2104b-f977-4617-9aa8-2e873e80be67",
"db_language_id": "c5c4d984-c5fa-4398-97c8-f0e1f3c72733",
"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-05T06:27:17.1449298+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "819fff92-861f-41d0-b444-71bbe455a564",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "076215ae-462a-4f48-88e8-246321ada258",
"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": "2dc35285-bf27-441d-8647-dbcb25dc7971",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e54f27d9-3244-4861-a9a7-3ee09b2351e8"
},
"suggested_date_start": "2026-01-05T06:27:17.1449298+00:00",
"skill_id": "cdc9a96a-6f77-405c-b741-f105d14ad25c",
"skill_code": "sample string 32",
"skill": {
"id": "2ff2b4d7-a0ec-4938-bbbf-3cad091062c9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bc66102b-2135-4c2c-975a-a87626a2967a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eaaad317-2a71-4624-8a60-bc67be68b30e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d15017ba-2eb2-4681-9006-96a3234f6acb",
"db_currency_id": "ce91eb72-0aa7-4969-b752-0bc1c008b2e6",
"db_language_id": "75e16aaf-66a1-438d-924b-a89f72e65702",
"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-05T06:27:17.1293053+00:00"
},
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a01bf733-bb01-4111-9fc2-c6215c6b0e1a",
"date_reported_by_company": "2026-01-05T06:27:17.1449298+00:00",
"id2": 36,
"company_id": "09381b2b-2282-4caf-b5dc-3a18c91fa62b",
"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": "f637b274-feb0-48fd-a210-45fc3d34b537",
"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-05T06:27:17.1449298+00:00"
},
"work_instruction_details_id": "d0e73218-10ba-497c-9aec-0425b01325a3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "15de28e2-3060-4433-835a-da6299bcfabd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1ce7c9b4-fc80-4064-bae7-43d4ced31d6d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-05T06:27:17.1449298+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": "9020d5bc-b38a-47c8-b135-125b264872d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-05T06:27:17.1449298+00:00"
}