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": "4bc6d434-6f69-4610-a1af-3c1fc8e8d8d3",
"jobs_id": "916cadf0-3903-4c9f-b9cd-809d08a87c64",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "72abc079-1c05-45e6-ac94-5c5fcbe9b9b8",
"_parent_id": "5737cd11-55ca-48c7-9502-ca0b5c3226db",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2895018-c16f-493a-a876-7caa7078b5ce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a54f62ab-6e3b-45fb-8461-154260a8eea0",
"_parent_id": "5afa95f9-d16d-4374-a765-8d04b834c238",
"root_parent_id": "b8015d13-7bb3-4f82-8799-f9199d5ec424",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e7bbc334-959d-4e93-be57-2a74e8c32a08",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6779169c-28b2-4de4-9b6b-4f771b4a4359",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b60b05d5-215c-49a2-8cdd-66409b2d2aa5",
"_parent_code": "sample string 6",
"sales_organization_id": "fc3f79e1-81dd-45cb-9d77-fcac3a486e3a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
},
"equipment_model_id": "9e079763-9b1c-40e5-8195-3c0fb20b5fef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e6712632-fd60-44c0-8542-da206b4d4dc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dee4165e-6afa-4db5-a191-896b0433e9be",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "735198bc-0e30-4f4e-abe3-8e1ef3364c2d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ad518b9f-479b-4718-85c5-de0ea3131ad8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
},
"equipment_family_id": "4ba8bd48-25b4-4f7c-a796-9d349e59a4fb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6779169c-28b2-4de4-9b6b-4f771b4a4359",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b60b05d5-215c-49a2-8cdd-66409b2d2aa5",
"_parent_code": "sample string 6",
"sales_organization_id": "fc3f79e1-81dd-45cb-9d77-fcac3a486e3a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
},
"date_in_production_since": "2026-08-14T04:29:17.5994913+00:00",
"date_out_of_production_since": "2026-08-14T04:29:17.5994913+00:00",
"date_end_support": "2026-08-14T04:29:17.5994913+00:00",
"sales_organization_id": "3e56f47d-8253-4bf6-b5ce-5a187c8db44e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+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-14T04:29:17.5994913+00:00"
},
"project_status_id": "10c32d9f-6654-4375-b710-76ac8ce64519",
"project_status_code": "sample string 10",
"project_status": {
"id": "db2b64cf-c09e-422c-8975-810516802fd7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "119abc1f-fa40-4f06-94d9-0b8a18e19124",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
},
"company_id": "e467d34e-a0f7-40de-8995-6641831c2e29",
"company_code": "sample string 12",
"db_address_id": "def0dcbd-e5b9-4a9e-9d95-6d62e3651d99",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7778f6f3-22bd-466f-ad54-7ff869c0ef7a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "52356573-ee8b-4891-a02e-f75705b5c592",
"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-14T04:29:17.5994913+00:00",
"date_create": "2026-08-14T04:29:17.5994913+00:00",
"date_update": "2026-08-14T04:29:17.5994913+00:00",
"updated_by_user_id": "2e7d10ae-18a9-4897-8b4c-16a4d8ee965a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T04:29:17.5994913+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T04:29:17.5994913+00:00",
"date_last_job": "2026-08-14T04:29:17.5994913+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T04:29:17.5994913+00:00",
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00",
"is_mobile_installation": true
},
"job_type_id": "85c8bcdf-9a02-4261-9cde-622cff916e7c",
"job_type_code": "sample string 7",
"job_type": {
"id": "6e52c6a5-b51a-4337-a86f-b5daebefdab3",
"name": "sample string 2",
"sales_organization_id": "70aa98d1-bc82-4963-b182-a574d05a1b04",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00",
"code": "sample string 7"
},
"job_priority_id": "cbb4ba79-c9f0-4f75-9a6e-489038dd6edd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bd1d2fff-46c1-416c-bc30-58c67485ebc1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "52698e32-213f-4431-a3fc-1b4c421278f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
},
"job_status_id": "f63eeccf-1fd7-4d76-b020-478a289242a7",
"job_status_code": "sample string 11",
"db_address_id": "dc71c115-ddbe-4638-ba05-ce1c1df6221d",
"contact_id": "4e8e5626-3fd3-4606-abc2-63b081db5e83",
"requested_by_company_id": "a974ea23-51d7-4e0e-a5a5-a9aabd9c9b6e",
"requested_by_contact_id": "1d5daf0b-6c05-41d2-8193-b3cd648b0b81",
"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-14T04:29:17.5994913+00:00",
"due_date": "2026-08-14T04:29:17.5994913+00:00",
"date_create": "2026-08-14T04:29:17.5994913+00:00",
"date_update": "2026-08-14T04:29:17.5994913+00:00",
"date_closed": "2026-08-14T04:29:17.5994913+00:00",
"suggested_user_id": "3e7f421b-1c14-416b-b7ac-47c27267e91f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "45c62509-818b-4135-a9fd-54316ac4ea6b",
"db_language_id": "8079e416-4cc6-4a4d-91fc-da476b96d126",
"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-14T04:29:17.5994913+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6eb06382-6617-4360-9234-4db29e7d282a",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9efdebc9-763a-4a01-8910-081d22ebfe81",
"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": "546fbf61-ade8-469e-ad3f-ba143252c789",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6b70b0cf-6ddb-405a-bf9e-0a3edc0f7b8d"
},
"suggested_date_start": "2026-08-14T04:29:17.5994913+00:00",
"skill_id": "021664d7-e941-4737-b6d0-cdae5b28002c",
"skill_code": "sample string 32",
"skill": {
"id": "eaa18bc7-da69-4a1e-8c4b-4c7b8308d2bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e9109164-b99e-4afe-982d-5d91b7fc4b17",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86f09368-748c-4f0f-9537-0356505fc224",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c1618b2-ff5e-4399-97d6-74cdc95715bf",
"db_currency_id": "379b855a-693f-42ec-8c38-018e66cbe136",
"db_language_id": "52c2308f-4ecb-4f64-a733-5c21b2f1812c",
"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-14T04:29:17.5994913+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ba3ab7b8-e222-4b69-b450-6f4ee2857724",
"date_reported_by_company": "2026-08-14T04:29:17.5994913+00:00",
"id2": 36,
"company_id": "1c869d67-5f64-4f81-864c-275175933909",
"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": "06eb397e-155e-420f-bac0-c402a80c34be",
"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-14T04:29:17.5994913+00:00"
},
"work_instruction_details_id": "6586cec3-02b1-4492-96f9-00372f1ddc78",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6c464947-d90f-48c4-8fa1-c93e32b4d867",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f07215f3-c8a7-4f81-a4ab-673f1547c4df",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T04:29:17.5994913+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": "cbeb7e41-4f1a-4d6b-8025-438f0b736ea6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T04:29:17.5994913+00:00"
}