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": "57e5fffd-7d25-4898-9ba9-06ce76d2b378",
"jobs_id": "4373009f-090e-4b9b-ace5-fc0601085afa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "893df639-a73c-4b49-bf9e-ad5bbf4f225e",
"_parent_id": "ca8e97c2-485c-4a71-9e7b-6bc21bf42ce9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d14fb7e8-0f20-412d-8b88-7b27aa0d0271",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e52935fa-6dd8-4b67-bc06-2bd7713b0ac0",
"_parent_id": "f0871107-73b2-40b7-a51b-b28bfff3f076",
"root_parent_id": "2c2858db-d2bd-4c65-94d0-cf9b4a516529",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c7311825-2ab5-4df2-9eed-429112f47e33",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a66fe0bc-be4b-4a56-a44c-189baea029ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24c381b1-f245-4216-b648-3f1ec4cd322b",
"_parent_code": "sample string 6",
"sales_organization_id": "9c98a8ff-e5f7-4c0d-963c-b53be3d4566e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
},
"equipment_model_id": "3a813547-27cf-451a-acfd-6c62125edf17",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "19776ffb-6d46-4762-bbf0-644f0aa94c0f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f3eb6b3-641b-4275-bb7a-02ffb1706994",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "31ee4b5f-9719-47e5-917a-5b05c88d711a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5e447c63-b12b-4fb5-a0de-fbed221e25d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
},
"equipment_family_id": "e325c71a-cd57-4fed-aa6f-fcd95d741470",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a66fe0bc-be4b-4a56-a44c-189baea029ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24c381b1-f245-4216-b648-3f1ec4cd322b",
"_parent_code": "sample string 6",
"sales_organization_id": "9c98a8ff-e5f7-4c0d-963c-b53be3d4566e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
},
"date_in_production_since": "2026-08-22T15:02:08.1116449+00:00",
"date_out_of_production_since": "2026-08-22T15:02:08.1116449+00:00",
"date_end_support": "2026-08-22T15:02:08.1116449+00:00",
"sales_organization_id": "1acf88cb-54d2-4fcf-9502-253baa1306b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+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-08-22T15:02:08.1116449+00:00"
},
"project_status_id": "05732f2d-b4a6-4e20-87c5-920041466cf4",
"project_status_code": "sample string 10",
"project_status": {
"id": "e78db01f-0d73-4035-ac98-cad80e4ff39d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5a40128e-9e45-4bcd-8a98-f1aac609050e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
},
"company_id": "1933aba5-4032-488b-813f-441e0259886c",
"company_code": "sample string 12",
"db_address_id": "0def4337-6914-42e4-92d3-b20cd0b9d590",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5c59029a-90f4-41e3-8b3b-e4358b74faa9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3322818c-0b2a-488e-8325-5bb9adecd3c7",
"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-08-22T15:02:08.1116449+00:00",
"date_create": "2026-08-22T15:02:08.1116449+00:00",
"date_update": "2026-08-22T15:02:08.1116449+00:00",
"updated_by_user_id": "e4c747a5-7a34-4158-afc3-4dad8d1a8ec8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-22T15:02:08.1116449+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-08-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-22T15:02:08.1116449+00:00",
"date_last_job": "2026-08-22T15:02:08.1116449+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-22T15:02:08.1116449+00:00",
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00",
"is_mobile_installation": true
},
"job_type_id": "6442af04-f3df-46e9-9042-5aed77da38f4",
"job_type_code": "sample string 7",
"job_type": {
"id": "ae86c495-ee1d-474b-8d6d-f78390489ede",
"name": "sample string 2",
"sales_organization_id": "5cb4504e-6891-4d7f-a41e-67b007a7c2bb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00",
"code": "sample string 7"
},
"job_priority_id": "0c57619f-fc05-4c51-89d4-b03f9e3a5563",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "073072b0-3f83-47fb-be76-23544fd877f4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "097a631d-1bd3-4567-a833-db40994af088",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
},
"job_status_id": "d5fafe90-8967-4d21-bfbe-223e96ca1cc8",
"job_status_code": "sample string 11",
"db_address_id": "7233e1bb-aa2f-4dce-9998-9443c59e595a",
"contact_id": "4a4573f6-fd17-464e-81d8-8458ed4175a3",
"requested_by_company_id": "acc8d60a-07b5-4bef-a48d-ca4efbddd005",
"requested_by_contact_id": "ce9f4b80-0756-4d2e-8288-122f7f1f16cb",
"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-08-22T15:02:08.1116449+00:00",
"due_date": "2026-08-22T15:02:08.1116449+00:00",
"date_create": "2026-08-22T15:02:08.1116449+00:00",
"date_update": "2026-08-22T15:02:08.1116449+00:00",
"date_closed": "2026-08-22T15:02:08.1116449+00:00",
"suggested_user_id": "9f8dde16-55a9-4754-b939-0bc089c66ee9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f193b96a-1b3b-4a46-a6db-3648807ca29d",
"db_language_id": "fba6a6aa-0f60-4004-9af4-43ea2c41f8a8",
"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-08-22T15:02:08.1116449+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fef8765c-67d6-4a2f-8658-9d5b8430c62e",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "61973e8b-bae7-4362-b73f-f7f4b91b2717",
"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": "17a6ccf1-d790-4ca0-a685-19f5f745a59f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "de2a6fc1-3a0b-49b0-ab85-506abb8c6ef9"
},
"suggested_date_start": "2026-08-22T15:02:08.1116449+00:00",
"skill_id": "4ca1cce3-561e-4801-836a-f329e42ed3d3",
"skill_code": "sample string 32",
"skill": {
"id": "b802a080-2e98-46f2-b0b6-3c976a02ce90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5a482b10-9223-4000-8eb6-140d4c1c9a37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b1387d88-4af5-47c3-bd38-6a18222a7159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5c16a0b-26d4-4784-9fad-83cc533eff6c",
"db_currency_id": "03ba97e9-9e2c-4900-967a-72ef59c81e40",
"db_language_id": "5ef498a7-299e-4638-aa9d-8580fe8a6338",
"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-08-22T15:02:08.1116449+00:00"
},
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d4fbaaae-7694-4d0e-915e-c384b2f78419",
"date_reported_by_company": "2026-08-22T15:02:08.1116449+00:00",
"id2": 36,
"company_id": "b900f2ab-770d-4ef3-903f-7d8b4a069196",
"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": "c0b69301-53b4-4e2a-8564-f4ae0c075167",
"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-08-22T15:02:08.1116449+00:00"
},
"work_instruction_details_id": "fe5825ae-8c64-48f5-ad6e-dda1dc9ee0cf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e5b1877-eaa8-440d-94e6-70b10ec42a67",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ae0bd564-e651-4d92-91a3-abbd746b31fa",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-22T15:02:08.1116449+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": "ba5f5ea2-76b1-4d7b-ac05-5b7343a3fab4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-22T15:02:08.1116449+00:00"
}