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": "75dde10d-4e09-4489-a011-859b523fa89b",
"jobs_id": "4b44a4fe-181f-467e-8e46-fc1743f38603",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "abbd7b8a-463b-4208-95a3-20cede563e50",
"_parent_id": "48e1337b-1107-4d92-93ca-af7e756c9a5d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "00b1d6b6-1f25-45d1-8581-97de34636caf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9d9f10f3-bdda-4581-8f77-d3eb94b68895",
"_parent_id": "0b1f3443-ffa5-48f9-a3bf-bb3528f73b28",
"root_parent_id": "cbae9198-3b0f-4523-b10e-9ec6f5e194df",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "728c815c-28b2-42d4-a3f7-6e2f6db87759",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9733707a-3dd7-4e4f-9b18-4da452e3e707",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "88c3b471-2aaf-43ac-9c20-93afbc83ab74",
"_parent_code": "sample string 6",
"sales_organization_id": "094d89b5-9bf2-4efe-9262-7e7213280ea9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"modified_dateutc": "2026-11-10T18:51:47.4113485+00:00"
},
"equipment_model_id": "c38191fb-f730-46b6-99ed-e7e0e93af8fb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "59317f2a-9054-4511-85fa-d2208732ba50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4496a635-2a5a-402b-bb5d-874bc1fccca7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "404ffc03-08c4-4d6a-b542-9f73985e02ca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "70fe7e3f-f622-4090-b9cb-79692af62774",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"modified_dateutc": "2026-11-10T18:51:47.4113485+00:00"
},
"equipment_family_id": "6aecd0d6-89f4-449a-88a2-424c63845437",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9733707a-3dd7-4e4f-9b18-4da452e3e707",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "88c3b471-2aaf-43ac-9c20-93afbc83ab74",
"_parent_code": "sample string 6",
"sales_organization_id": "094d89b5-9bf2-4efe-9262-7e7213280ea9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"modified_dateutc": "2026-11-10T18:51:47.4113485+00:00"
},
"date_in_production_since": "2026-11-10T18:51:47.4113485+00:00",
"date_out_of_production_since": "2026-11-10T18:51:47.4238279+00:00",
"date_end_support": "2026-11-10T18:51:47.4238279+00:00",
"sales_organization_id": "63b4059d-70f4-425a-aacd-c67207fdfec8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+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-11-10T18:51:47.4238279+00:00"
},
"project_status_id": "f99afe6d-a9a2-459f-9044-f2325a4b5232",
"project_status_code": "sample string 10",
"project_status": {
"id": "fe4c0a30-9bb7-4b18-8768-d583c47a7527",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9ad836ab-ee1f-4601-ab0e-2449255affca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T18:51:47.4238279+00:00"
},
"company_id": "80b771ad-4691-44fd-9004-8ef815eeca1c",
"company_code": "sample string 12",
"db_address_id": "84768edb-0118-4fb8-863d-8442953fac4b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f2b7024d-fa86-4cbf-9629-180e24731635",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d2f7b6d8-caff-4da8-ae61-e0da1591de23",
"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-11-10T18:51:47.4394483+00:00",
"date_create": "2026-11-10T18:51:47.4394483+00:00",
"date_update": "2026-11-10T18:51:47.4394483+00:00",
"updated_by_user_id": "7ea9df1c-a37b-461b-b2cf-cd261d4492d5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-10T18:51:47.4394483+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-11-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-10T18:51:47.4394483+00:00",
"date_last_job": "2026-11-10T18:51:47.4394483+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-10T18:51:47.4394483+00:00",
"modified_dateutc": "2026-11-10T18:51:47.4394483+00:00",
"is_mobile_installation": true
},
"job_type_id": "e56f709f-1f0f-42dd-b7cd-23db796ac51c",
"job_type_code": "sample string 7",
"job_type": {
"id": "eaf56707-8c53-46a4-84b7-99e444d0dffc",
"name": "sample string 2",
"sales_organization_id": "bb83458e-b5b4-40a4-b673-bf6bde4cd3c0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-10T18:51:47.4394483+00:00",
"code": "sample string 7"
},
"job_priority_id": "cfa64ce8-eee4-48ce-8486-e2c539869da0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aa88c632-3e0f-400b-a9eb-1d0ab8a6d583",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "96c8cd52-2a68-4f4f-aa95-a1ac82ebb703",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T18:51:47.4394483+00:00"
},
"job_status_id": "10a25675-330b-4ef9-bf3a-be47c432417e",
"job_status_code": "sample string 11",
"db_address_id": "5a535157-d745-40b1-b883-414daf7315ae",
"contact_id": "648f3c05-388b-44b8-a5e4-436d4e434be4",
"requested_by_company_id": "3a4f3cf2-da09-41e9-a9d6-2760f3e2e400",
"requested_by_contact_id": "677d654c-3fec-4506-b6a0-45d13d68f33c",
"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-11-10T18:51:47.4394483+00:00",
"due_date": "2026-11-10T18:51:47.4394483+00:00",
"date_create": "2026-11-10T18:51:47.4394483+00:00",
"date_update": "2026-11-10T18:51:47.4394483+00:00",
"date_closed": "2026-11-10T18:51:47.4394483+00:00",
"suggested_user_id": "a7b1663b-e77a-4d9d-89ff-b2e0fe30aa91",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f9cfc4df-be63-4bf8-b7f7-a38a88d8642b",
"db_language_id": "f8cc32a3-2389-45fe-b88e-e8767e3acb04",
"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-11-10T18:51:47.4394483+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "36a8185f-bbae-4941-a0ab-98c6f0752c76",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ee998197-5dc0-4a1c-9dcd-4233597767bb",
"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": "d34c3937-a886-4560-b394-2f860163d839",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-10T18:51:47.4394483+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cb2b6751-9f41-4f4a-8b76-a02240da8ba4"
},
"suggested_date_start": "2026-11-10T18:51:47.4394483+00:00",
"skill_id": "989ff277-f7ea-45c3-b254-b86f9307ff5a",
"skill_code": "sample string 32",
"skill": {
"id": "18c00458-a89e-4a4c-a6d4-cb732189c0b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1840e24d-3e3e-49a2-bcd3-ba64f4ced909",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5c917f61-34c6-4def-a348-16ecbc4da5a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ecb631a3-44a3-4442-8ce8-f51f6058f746",
"db_currency_id": "87747618-2116-4860-95d4-aecaaafa1c7c",
"db_language_id": "a9cf560c-7253-4273-afb9-6c322079c4ae",
"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-11-10T18:51:47.4113485+00:00"
},
"modified_dateutc": "2026-11-10T18:51:47.4394483+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "270c7a33-abbc-436f-bea5-a40850a3327b",
"date_reported_by_company": "2026-11-10T18:51:47.4394483+00:00",
"id2": 36,
"company_id": "ba62a7cc-7312-4e89-88bb-2d5a424d6611",
"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": "bb2cb4f1-45aa-4d94-bc89-e4e90e7aef7a",
"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-11-10T18:51:47.4394483+00:00"
},
"work_instruction_details_id": "49b450d8-eaf0-44b7-a186-1ad5b44ed528",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ec636ff8-4ac1-419f-878c-d2786791f756",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e2207b84-f0e0-4bd0-a0e0-9d3a33dd4e94",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-10T18:51:47.4394483+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": "49902d48-fad1-4085-a606-7724dbbb498d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-10T18:51:47.4394483+00:00"
}