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": "895f42c1-ef37-41ec-8c3d-1564bb1036a7",
"jobs_id": "fa455334-64f5-4bea-80b3-7f8406c51899",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "238e4cbc-7c1b-4896-bc48-a1d54f3887a6",
"_parent_id": "16fa72f1-cd8b-452c-a2e2-f7de4b47f5ee",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5d59ef86-0e9d-462d-ad7c-9060e86bc087",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da56f0cb-3d8b-45fc-9615-4871f5c98af8",
"_parent_id": "ea086ea2-be9c-4ef2-9c07-4ce3e5ac6e41",
"root_parent_id": "0d537c8e-bf32-4084-91e5-405cdbc4daaa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2c18bee6-e189-4cd0-a346-271e970d48f6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8cf8249b-a141-4384-b075-b315fb800359",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "291d84d1-e72c-4d5f-b1fa-c4d40d90216d",
"_parent_code": "sample string 6",
"sales_organization_id": "b330ee92-849d-4a0f-9739-cbb7e8cf687f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"modified_dateutc": "2026-01-29T19:39:42.4418249+00:00"
},
"equipment_model_id": "bc22969a-7a55-44c6-a3d5-4f3b63f1f66a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a5953d1-6bc0-4fec-b949-71e5ce911920",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "14fc2b08-373f-4bb1-9241-32513a637d83",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bdf9572a-2a86-4c99-bad9-33d083b6a3ae",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "611220fb-5b85-414c-9888-493f6f86304c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"modified_dateutc": "2026-01-29T19:39:42.4418249+00:00"
},
"equipment_family_id": "a2a3ec61-3b57-4d3d-802e-fc261fbadd64",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8cf8249b-a141-4384-b075-b315fb800359",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "291d84d1-e72c-4d5f-b1fa-c4d40d90216d",
"_parent_code": "sample string 6",
"sales_organization_id": "b330ee92-849d-4a0f-9739-cbb7e8cf687f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"modified_dateutc": "2026-01-29T19:39:42.4418249+00:00"
},
"date_in_production_since": "2026-01-29T19:39:42.4418249+00:00",
"date_out_of_production_since": "2026-01-29T19:39:42.4886771+00:00",
"date_end_support": "2026-01-29T19:39:42.4886771+00:00",
"sales_organization_id": "f2713326-4945-4ec2-a41e-c8b84b7dc669",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+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-29T19:39:42.4886771+00:00"
},
"project_status_id": "05a08c46-7bbe-46d5-89f2-a94738385069",
"project_status_code": "sample string 10",
"project_status": {
"id": "81d03709-fbff-4292-a861-bccf3c816f4e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e99e371a-146b-47d2-a254-e98f56481295",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T19:39:42.4886771+00:00"
},
"company_id": "a765d00b-549d-42db-a2af-c3c35de1de3c",
"company_code": "sample string 12",
"db_address_id": "c24d2e5f-400a-4cb0-9481-a2b02957cac1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6499ec34-436d-4a06-b5aa-01916e126f67",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9a28238c-67c2-4f47-b188-dc12904b51c4",
"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-29T19:39:42.4886771+00:00",
"date_create": "2026-01-29T19:39:42.4886771+00:00",
"date_update": "2026-01-29T19:39:42.4886771+00:00",
"updated_by_user_id": "eb01d7d8-aa2a-420f-8790-7f85ac1eb524",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T19:39:42.4886771+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T19:39:42.4886771+00:00",
"date_last_job": "2026-01-29T19:39:42.4886771+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T19:39:42.4886771+00:00",
"modified_dateutc": "2026-01-29T19:39:42.4886771+00:00",
"is_mobile_installation": true
},
"job_type_id": "ed303019-eb22-4cb6-bf3e-e0a6947eb62a",
"job_type_code": "sample string 7",
"job_type": {
"id": "6950916d-3ea7-4043-bfa9-56dd7c79ecf9",
"name": "sample string 2",
"sales_organization_id": "b5b88dd1-a2d9-4a6a-9b50-e55942d68375",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T19:39:42.4886771+00:00",
"code": "sample string 7"
},
"job_priority_id": "11c99f9a-af3a-4ff9-80be-841edaf81653",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c51e644c-4299-4c3b-9d13-f614d1862e3c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "967947e3-012c-41c0-8429-a1e08e0bb9bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T19:39:42.4886771+00:00"
},
"job_status_id": "3e66f733-635c-4d49-a811-4f1eb26aba5c",
"job_status_code": "sample string 11",
"db_address_id": "53528436-9bc0-4130-87da-a78f24f21302",
"contact_id": "b1642dd6-1895-471f-8f0d-d0336c590399",
"requested_by_company_id": "55d5d5de-76ca-4fc2-bd47-1e797414f170",
"requested_by_contact_id": "89a80630-d040-4070-aba5-52f871a48fd4",
"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-29T19:39:42.4886771+00:00",
"due_date": "2026-01-29T19:39:42.4886771+00:00",
"date_create": "2026-01-29T19:39:42.4886771+00:00",
"date_update": "2026-01-29T19:39:42.4886771+00:00",
"date_closed": "2026-01-29T19:39:42.4886771+00:00",
"suggested_user_id": "7df64e82-9542-41f6-a9ff-b2103babd41b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c62fe1a0-b8c7-4026-8509-debbf78c2f14",
"db_language_id": "5f514b99-f816-4441-a99b-db3c7a3584ec",
"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-29T19:39:42.4886771+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "048b74d0-ef2f-4813-86e2-6e102fdf2af5",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aa63a38d-a903-40dc-917c-2c765e6f0e9e",
"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": "7013ca29-6393-4ba4-aaf6-1b54d8474f35",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T19:39:42.4886771+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ddaebd85-7a92-4a35-9d40-2ce207e66a83"
},
"suggested_date_start": "2026-01-29T19:39:42.4886771+00:00",
"skill_id": "1c165ba8-9dd0-4de9-a206-6ec995582599",
"skill_code": "sample string 32",
"skill": {
"id": "03f88468-e67d-476a-b290-5b615c87902e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1a6ed4c3-459f-4744-ad6c-d144cc10c558",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "859f03e8-7ff5-401b-8d37-58e2cf8c6c10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fea274dd-cab7-444b-a8ec-acc88ca04b3d",
"db_currency_id": "81c3cae2-9f4a-4a32-a61e-e99c274eb261",
"db_language_id": "5dddd2bb-b5d5-4fd3-9dd0-0ba452224a2a",
"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-29T19:39:42.4418249+00:00"
},
"modified_dateutc": "2026-01-29T19:39:42.5043019+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "89e61661-fec8-4aec-8ef6-900d1e181275",
"date_reported_by_company": "2026-01-29T19:39:42.5043019+00:00",
"id2": 36,
"company_id": "21d07f54-07f9-49a0-93e1-1d5934d5142f",
"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": "7d11ff59-768d-458e-8eb5-26ded770ed0d",
"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-29T19:39:42.5043019+00:00"
},
"work_instruction_details_id": "67514942-462e-40dc-a51b-17cda8dcce4d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a0a68672-9c25-41f2-9d3c-5d8a01d5b396",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "17384070-feaf-4e68-9439-6e2792a7d3cd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T19:39:42.5043019+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": "4d900b03-5a8b-4637-bf9e-5b21585f4f71",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T19:39:42.5043019+00:00"
}