Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "c591634c-80a6-4174-9ea2-c88c594e904d",
"jobs_id": "80f06b66-b8ba-4e1b-972b-4ea886a35ec9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "76456959-fbb1-4622-ac99-162cf8793e6c",
"_parent_id": "9000a930-d59f-4329-bd3b-9ca3adb530b7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "62023a3d-c63f-43f7-8288-7fc43e81cf47",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b76580aa-d990-4e42-bcfc-5ff0ac799905",
"_parent_id": "5275b570-cdae-4ec5-a815-879a37248580",
"root_parent_id": "b9f428b2-679b-4983-9434-91cd2d3f24eb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6c76be29-6409-4df0-b576-32370256c101",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "123f8914-603a-47c6-9400-f6f38855f8fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12f92b57-6021-4b75-a764-624644b8b9db",
"_parent_code": "sample string 6",
"sales_organization_id": "bc0687ee-6b41-4054-ad60-ecafbaba8fae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
},
"equipment_model_id": "840770c1-db6a-40b9-989e-1bf13e1eafaa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64ea96c7-476d-4187-817c-fe95b7a9283a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "125a4823-ee2c-4090-b72a-b44b79a82260",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0a007fdb-d21c-4407-989e-bab2bbd2c7b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "58ccab99-5e4d-4956-9655-b79689a1e5be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
},
"equipment_family_id": "eab42ee4-bf48-4b60-85a0-1b1dd057697a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "123f8914-603a-47c6-9400-f6f38855f8fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12f92b57-6021-4b75-a764-624644b8b9db",
"_parent_code": "sample string 6",
"sales_organization_id": "bc0687ee-6b41-4054-ad60-ecafbaba8fae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
},
"date_in_production_since": "2026-08-10T14:04:46.4826931+00:00",
"date_out_of_production_since": "2026-08-10T14:04:46.4826931+00:00",
"date_end_support": "2026-08-10T14:04:46.4826931+00:00",
"sales_organization_id": "7b81b48b-1cbc-42bd-a9b0-3e38633e7f70",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+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-10T14:04:46.4826931+00:00"
},
"project_status_id": "f678dfeb-d516-4a2d-88f5-d5fd551bf0cd",
"project_status_code": "sample string 10",
"project_status": {
"id": "083336c3-342d-47a2-838c-cb0bd60c2c93",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "273dd943-2f7d-4d40-a183-167b34382882",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
},
"company_id": "5e6fb3f4-06e1-4d88-97af-3e63e6c8828c",
"company_code": "sample string 12",
"db_address_id": "24f5f745-817f-45b9-b3c2-a87230ca110f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3c7b72ae-a1d9-4da7-b5d0-c65dc113b239",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "887254e3-c5d5-45ff-8413-3b7528c71c92",
"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-10T14:04:46.4826931+00:00",
"date_create": "2026-08-10T14:04:46.4826931+00:00",
"date_update": "2026-08-10T14:04:46.4826931+00:00",
"updated_by_user_id": "0ece2279-50d3-4050-b6ce-4074ef851839",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-10T14:04:46.4826931+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-10T14:04:46.4826931+00:00",
"date_last_job": "2026-08-10T14:04:46.4826931+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-10T14:04:46.4826931+00:00",
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00",
"is_mobile_installation": true
},
"job_type_id": "969efe98-655a-4e10-a234-bed442435947",
"job_type_code": "sample string 7",
"job_type": {
"id": "303951ba-a88e-47ee-b6ca-5f5924bf64fc",
"name": "sample string 2",
"sales_organization_id": "f2a87532-4141-4cd2-815c-2b6ab2e88497",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00",
"code": "sample string 7"
},
"job_priority_id": "305603b3-63ff-4537-befb-ba6dda23ee64",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "821d9c74-86d8-44e2-9424-f5eadb424269",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d91d5ea-2537-42da-89a1-095b24586f05",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
},
"job_status_id": "eb05faa7-d755-44aa-ab2b-b1994b2c817a",
"job_status_code": "sample string 11",
"db_address_id": "ef38b708-4426-456f-bacd-9ddb5ce85dfb",
"contact_id": "68ce0656-bb59-4ab4-8a1b-45c501b8a83f",
"requested_by_company_id": "bdf6c090-5b01-4860-90e5-80ceb88719e9",
"requested_by_contact_id": "e2c8a0ed-3ea4-4c74-9c0d-bb45c248cc70",
"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-10T14:04:46.4826931+00:00",
"due_date": "2026-08-10T14:04:46.4826931+00:00",
"date_create": "2026-08-10T14:04:46.4826931+00:00",
"date_update": "2026-08-10T14:04:46.4826931+00:00",
"date_closed": "2026-08-10T14:04:46.4826931+00:00",
"suggested_user_id": "3bbf0833-31d1-488d-8c64-f61bccb0f3ca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9b438f22-73dc-4310-9ae1-c07a8aec6583",
"db_language_id": "ea0b4596-67fe-4b02-9228-966bb3daff63",
"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-10T14:04:46.4826931+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "83a0e418-6f81-45c7-a020-f68f507d4b24",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1a1743c9-7060-4172-8dba-98c22d7aaeda",
"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": "98e2e7b5-c6f3-4931-a923-89fa077e7875",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4d3a7fd7-f991-4c12-a525-d8bd7c9af27d"
},
"suggested_date_start": "2026-08-10T14:04:46.4826931+00:00",
"skill_id": "72746f97-6646-4685-957c-990b3bd64327",
"skill_code": "sample string 32",
"skill": {
"id": "84130bf0-fa8a-4d97-9023-232b6118ce3e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e47c5408-aedd-4bdd-b1e8-2712cd2292f9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11ac91c4-ea7d-446b-b682-f22eb80318d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6734225-4bb1-48c5-9924-206d329b9baf",
"db_currency_id": "eadbf839-812e-4e21-bb4d-ccf0fdf18346",
"db_language_id": "c2d091bf-0e2a-4499-a9f2-88b79ef4b92b",
"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-10T14:04:46.4826931+00:00"
},
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d030a15e-0d42-4479-86ac-a6bfa847f024",
"date_reported_by_company": "2026-08-10T14:04:46.4826931+00:00",
"id2": 36,
"company_id": "fc2a776c-cb15-432e-8b91-446e831be225",
"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": "d1eb650e-51a0-47fe-b371-c0819d35e05c",
"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-10T14:04:46.4826931+00:00"
},
"work_instruction_details_id": "7ece39a5-fe84-4ef2-b8a4-f7184fe1268a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dfa77bec-ec10-4e5e-8edb-b898e926b199",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6deb64b5-8998-47ab-b491-cb86241cc5fd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-10T14:04:46.4826931+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": "c41184b8-674e-4b29-a990-e5456fd6afa2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-10T14:04:46.4826931+00:00"
}