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": "cc153735-9253-4f6f-9f22-85e31d2d548e",
"jobs_id": "3b863d33-4f5a-44d1-9e04-65183edca747",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e5195710-8bc5-4015-8c92-2639dadb8f63",
"_parent_id": "5f233568-c150-43a8-9a2b-e1c1bb6fb36e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ffbd865c-cc1a-4684-b84e-5db5c3d1f511",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6562ceee-6a78-4e3c-b41a-3dcaca0637e7",
"_parent_id": "964a36d9-73af-45d3-bd3b-2cf213908eec",
"root_parent_id": "1b1e96d5-832b-4cf7-8aff-0b7b24a65205",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7b9495a8-c866-4b00-8478-f7ca09126236",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c11f0fb1-181d-4bf7-83fb-c177cd45cf5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "867ae085-1642-4cbb-8248-181298a3bfa9",
"_parent_code": "sample string 6",
"sales_organization_id": "0b73324d-2ca5-4e1e-88ab-5c8b6d619380",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00"
},
"equipment_model_id": "dd5d8673-8af9-4c2f-995d-1fe916a48451",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3912fe00-7f84-4f93-bd68-b78ac594c3d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2ef84242-3694-4692-876d-f4257ff1bd47",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "69e55d20-d925-4aeb-9693-b0ace0dd95ff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c767ad57-2d58-4b81-87f7-55cf8451edcd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00"
},
"equipment_family_id": "4cd71aa3-6b4d-4669-b42d-95a84a9d3908",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c11f0fb1-181d-4bf7-83fb-c177cd45cf5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "867ae085-1642-4cbb-8248-181298a3bfa9",
"_parent_code": "sample string 6",
"sales_organization_id": "0b73324d-2ca5-4e1e-88ab-5c8b6d619380",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00"
},
"date_in_production_since": "2026-01-12T11:38:57.4370161+00:00",
"date_out_of_production_since": "2026-01-12T11:38:57.4370161+00:00",
"date_end_support": "2026-01-12T11:38:57.4370161+00:00",
"sales_organization_id": "8432a7a2-2c3c-475d-b8b3-5bb20a66837a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+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-12T11:38:57.4370161+00:00"
},
"project_status_id": "d25d76ba-2a71-4cb0-a3ac-5117f41809c8",
"project_status_code": "sample string 10",
"project_status": {
"id": "ca7d0699-8bba-4f60-be53-f00c51f0ebd4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bf2be7ff-5729-4a9e-bce9-378ec159a235",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00"
},
"company_id": "0028a042-0a23-478d-8505-b3d18d271863",
"company_code": "sample string 12",
"db_address_id": "22c5808b-1beb-4a0e-8ec2-3bb18a20780c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a6024999-fe44-4627-a0f3-e8a1674fd3b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "75b4c0b9-70ba-4965-93bb-6ce19773c825",
"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-12T11:38:57.4370161+00:00",
"date_create": "2026-01-12T11:38:57.4370161+00:00",
"date_update": "2026-01-12T11:38:57.4370161+00:00",
"updated_by_user_id": "6f3d8aad-7795-4a5a-ab67-d19b17f79d2e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-12T11:38:57.4370161+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-12T11:38:57.4370161+00:00",
"date_last_job": "2026-01-12T11:38:57.4370161+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-12T11:38:57.4370161+00:00",
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00",
"is_mobile_installation": true
},
"job_type_id": "94903ae2-e34a-47d0-b06a-d9614c96be11",
"job_type_code": "sample string 7",
"job_type": {
"id": "a21ed55c-e655-4390-bdcc-9dc291428ab8",
"name": "sample string 2",
"sales_organization_id": "2158916a-aa84-4f1a-92b7-8cfbd8a31711",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00",
"code": "sample string 7"
},
"job_priority_id": "3280c957-69d9-4d27-8dac-f47c8cc0d7ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "40e3cf3d-a7ac-4aa8-a434-5c69dc87dafe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "385edf1c-cb41-4f0d-8098-ec359020b05f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00"
},
"job_status_id": "8ea62b13-44a9-49e0-9366-2fb8403529ef",
"job_status_code": "sample string 11",
"db_address_id": "1ef1804b-5694-4c6a-b3cc-330f88f6322d",
"contact_id": "8246aff2-01db-4059-8570-6ebc6a85a93b",
"requested_by_company_id": "abfd1344-9100-4a73-8977-d6f299121754",
"requested_by_contact_id": "86b128f0-2579-40f2-9ff9-88390f5b9bc1",
"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-12T11:38:57.4370161+00:00",
"due_date": "2026-01-12T11:38:57.4370161+00:00",
"date_create": "2026-01-12T11:38:57.4370161+00:00",
"date_update": "2026-01-12T11:38:57.4370161+00:00",
"date_closed": "2026-01-12T11:38:57.4370161+00:00",
"suggested_user_id": "b20e85b2-d624-4a50-8173-91bd3940a962",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7b17a2eb-8fac-432b-a616-70460e23093b",
"db_language_id": "73185cf8-7d85-4f72-a86f-ce11398b5e71",
"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-12T11:38:57.4370161+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "46e3d006-5d94-4929-8283-235f5ef86212",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fcbeb9ed-5e2d-40a0-a38e-7bcddada2254",
"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": "b7df8d81-aa2f-4aba-a9d3-5c79f905166a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "028b87d3-1db6-4455-b404-cedab3a09003"
},
"suggested_date_start": "2026-01-12T11:38:57.4370161+00:00",
"skill_id": "9b40d427-df7b-436b-8afe-68bdd5edc498",
"skill_code": "sample string 32",
"skill": {
"id": "e184bedb-d041-425d-b18c-b716fec6cef6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cba66523-4252-4bbd-8af4-c937b58631ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c950286-d640-475e-a10b-825293b5833f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "db62609d-fb59-4e0c-b380-5a8ce5ba8389",
"db_currency_id": "210f19e1-32a4-4710-8a38-c41b5d4a788c",
"db_language_id": "abe51f3b-55c4-45c0-85b8-7195d08fda25",
"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-12T11:38:57.4370161+00:00"
},
"modified_dateutc": "2026-01-12T11:38:57.4370161+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ce7f5e51-a33f-4340-abfe-65bb8d3cb1c3",
"date_reported_by_company": "2026-01-12T11:38:57.4370161+00:00",
"id2": 36,
"company_id": "897e47a2-9438-4684-9a5c-803fb6379722",
"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": "1eaf060d-3dca-4025-9bba-d7ff7e2ca5a6",
"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-12T11:38:57.4370161+00:00"
},
"work_instruction_details_id": "8c8c549e-d504-4fe8-9e74-7e1f9bf415b4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c8a9dc9c-fb56-420e-b6ef-3b7c60c9977b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2ec94a50-8675-4846-9e2f-efa55a3470dd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-12T11:38:57.4526249+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": "d964f1a5-c70d-4ad3-952a-e5a590e52f3e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-12T11:38:57.4526249+00:00"
}