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": "8f0b9928-b6c7-4c54-aa64-c810accfe7a7",
"jobs_id": "198284c0-273d-4651-8717-bdb2bd1b0c03",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3e9d0e38-c8ad-4eae-a778-d7f1f18a40c7",
"_parent_id": "f8a2e9f6-54d4-4a17-9762-f47505b3a466",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "683da282-942b-4dd7-b251-6b86ad9aa172",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a72ac3d8-45b6-436f-8afb-926d835722a0",
"_parent_id": "13cf252d-172a-46dc-9d3e-a9ad49172e10",
"root_parent_id": "12ad06f4-7ff0-49b5-a855-2390fba8a4bd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "24009c3d-356f-4909-ae44-922c8f4e2e7b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "114896d7-7958-4c22-ae97-01dff661b2a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d5a685e9-938f-43d2-9eef-c531acaf2cdb",
"_parent_code": "sample string 6",
"sales_organization_id": "91a748cc-2177-4670-9ee4-38f521b125b0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"modified_dateutc": "2026-06-24T01:52:19.9610173+00:00"
},
"equipment_model_id": "d0bcda02-f526-4d14-99f2-4c257953eedc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d5ab92f-ceab-4ef8-a9dd-80998f493053",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d4a3586f-a60f-40e7-af07-4b86dd0ae89b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "97be5371-9094-41f4-8c05-815e49a4f613",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "db81b3c1-15fd-4856-a32c-2715d09ff02e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"modified_dateutc": "2026-06-24T01:52:19.9610173+00:00"
},
"equipment_family_id": "af55e9a3-a1ea-4e43-b6ee-48f475e1c857",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "114896d7-7958-4c22-ae97-01dff661b2a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d5a685e9-938f-43d2-9eef-c531acaf2cdb",
"_parent_code": "sample string 6",
"sales_organization_id": "91a748cc-2177-4670-9ee4-38f521b125b0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"modified_dateutc": "2026-06-24T01:52:19.9610173+00:00"
},
"date_in_production_since": "2026-06-24T01:52:19.9610173+00:00",
"date_out_of_production_since": "2026-06-24T01:52:19.9610173+00:00",
"date_end_support": "2026-06-24T01:52:19.9610173+00:00",
"sales_organization_id": "cba8365d-7a5a-4328-b0e4-490f2dc8b50e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+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-06-24T01:52:19.9766352+00:00"
},
"project_status_id": "48b0bda7-97d4-41d7-8998-4a1e8c0e563b",
"project_status_code": "sample string 10",
"project_status": {
"id": "e937862e-7302-4a42-ba50-fe9aafc84ab6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cca9f9be-f7e4-4cb6-a0bc-c445fff831a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00"
},
"company_id": "376aa0fc-a5a2-4ee7-be8d-7c8feb5dcbd8",
"company_code": "sample string 12",
"db_address_id": "1a7fa715-6785-45fa-b728-b06e4728f875",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4bd5be16-8c94-4a3a-ba28-4f202daea80a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e835a5f1-d07a-4f2d-9efd-c0378cd92ef5",
"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-06-24T01:52:19.9766352+00:00",
"date_create": "2026-06-24T01:52:19.9766352+00:00",
"date_update": "2026-06-24T01:52:19.9766352+00:00",
"updated_by_user_id": "7a8ad130-7b5c-46fc-a442-7e28d05e0c95",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-24T01:52:19.9766352+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-06-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-24T01:52:19.9766352+00:00",
"date_last_job": "2026-06-24T01:52:19.9766352+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-24T01:52:19.9766352+00:00",
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00",
"is_mobile_installation": true
},
"job_type_id": "266fe1ba-53e3-43f8-b55c-c48ef6b5f01e",
"job_type_code": "sample string 7",
"job_type": {
"id": "aa8d4d90-96c9-486f-a042-255194891852",
"name": "sample string 2",
"sales_organization_id": "29bc3544-632f-45c3-a1e9-9f398de45ebd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00",
"code": "sample string 7"
},
"job_priority_id": "23dde459-9bf0-47d3-81dc-cf9add4c4ba5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "62ec63a0-951f-41a1-b519-d3660421c99a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c3c47587-f5ca-4197-92e8-f5b051a36c48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00"
},
"job_status_id": "a56465b4-bcdd-45cf-b18c-351f72f7983f",
"job_status_code": "sample string 11",
"db_address_id": "3bf36a83-b03d-471b-b12f-7da23e4aa215",
"contact_id": "ffc3c341-9878-4e3c-9c49-39d132d62b94",
"requested_by_company_id": "f5e46498-9772-4774-b0c1-c6d6f3653495",
"requested_by_contact_id": "3cbd3a43-8e56-458d-aef5-eda2a0656735",
"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-06-24T01:52:19.9766352+00:00",
"due_date": "2026-06-24T01:52:19.9766352+00:00",
"date_create": "2026-06-24T01:52:19.9766352+00:00",
"date_update": "2026-06-24T01:52:19.9766352+00:00",
"date_closed": "2026-06-24T01:52:19.9766352+00:00",
"suggested_user_id": "3ee5c77b-7e38-4918-ad97-e295fa9ba4b5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "88ed40b9-dfe9-49aa-8404-f3f3f60c044b",
"db_language_id": "7ccbeacc-2d19-4434-b406-e6c94f21958b",
"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-06-24T01:52:19.9766352+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b81764e4-2fc7-4dbd-9016-49922bd5ac86",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "402ffc31-e1d2-40a3-bd5d-59dda0746e1d",
"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": "540f9069-3cf2-4ba0-9388-e13291fffd33",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "02a3bfe5-af79-4a8f-bce2-d5584d052e44"
},
"suggested_date_start": "2026-06-24T01:52:19.9766352+00:00",
"skill_id": "ca665148-416a-41ad-8b67-803e4fd887ae",
"skill_code": "sample string 32",
"skill": {
"id": "828bbecb-fb2e-419e-b931-03e125db85ab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "565fb88e-effe-45e1-8666-013f7b74e326",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8b467d6-7f24-47d8-89f6-c292376d61c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5185a703-3666-49a3-ad54-01f61e169bc1",
"db_currency_id": "d1fb4797-90f9-4bed-8b02-a9c6dde194fe",
"db_language_id": "2120f072-c2e4-403d-9911-a9cbf1138cca",
"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-06-24T01:52:19.9610173+00:00"
},
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fefa96ee-c570-4a30-a2c0-12c2d2699c81",
"date_reported_by_company": "2026-06-24T01:52:19.9766352+00:00",
"id2": 36,
"company_id": "b7ccd5cb-d3ac-444c-b504-a2d01ff43c37",
"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": "aca5d8ea-d2dd-4238-846e-f8e90daae43d",
"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-06-24T01:52:19.9766352+00:00"
},
"work_instruction_details_id": "f3710543-24ae-44ff-83f2-5edaa35b2467",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "17b7c4c3-dd68-4234-bce4-6b1152042dd8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0c15a245-f72a-4989-a50d-367c3c47be32",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-24T01:52:19.9766352+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": "5824d139-14f2-4b58-a690-adaf4ac7f76a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-24T01:52:19.9766352+00:00"
}