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": "2a51f41d-c181-4385-9bdd-3bdd1e1e5cc6",
"jobs_id": "91a07a5a-a0c7-4018-a05c-5232af217c5d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "79a962e8-799d-4286-b2f8-781180f08a4e",
"_parent_id": "ed974a7e-708b-40b0-91a3-ad17a0268433",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "10f3513e-0850-4caf-b229-0956d3ecf819",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f3b6466f-2a60-4f15-9f9e-ac1ece0430e2",
"_parent_id": "502806f1-a142-48ed-938d-2c53d64aceb7",
"root_parent_id": "ca0840b9-9fab-4a35-89e2-bebadbe248ad",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1e934969-5d74-4ed1-b76f-5a3e60b33b96",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fea769c4-b6a7-42e9-a036-17a20e5b79bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "115d4dee-92e9-448f-890c-4d78b388db18",
"_parent_code": "sample string 6",
"sales_organization_id": "af36ac48-0263-4946-a419-3ad846b9dcc6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
},
"equipment_model_id": "af2b92c6-2b1e-44af-a7ce-272878364f4b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9219d39f-0633-47c6-ad82-0ed75aab02e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "18931a35-ed8a-4fae-9617-42ed10f3a3bd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "59ffd425-3f90-4e57-b33d-cd8b285f0976",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "290489f6-e4af-4be2-8c54-ac751bc53e06",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
},
"equipment_family_id": "9495baac-3830-4fa8-b74b-abcd970e5b1c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fea769c4-b6a7-42e9-a036-17a20e5b79bb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "115d4dee-92e9-448f-890c-4d78b388db18",
"_parent_code": "sample string 6",
"sales_organization_id": "af36ac48-0263-4946-a419-3ad846b9dcc6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
},
"date_in_production_since": "2026-06-22T03:03:43.8225103+00:00",
"date_out_of_production_since": "2026-06-22T03:03:43.8225103+00:00",
"date_end_support": "2026-06-22T03:03:43.8225103+00:00",
"sales_organization_id": "9855c563-f380-4f05-8897-c3553832655b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+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-22T03:03:43.8225103+00:00"
},
"project_status_id": "61197196-5939-4142-999a-d8a16e290130",
"project_status_code": "sample string 10",
"project_status": {
"id": "d3031708-c2c3-4e11-bd99-49845171fbce",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "94480830-9a93-4b9e-b579-2a5e37526d37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
},
"company_id": "ff57ccb9-14be-4d7e-88d7-17c5208351b1",
"company_code": "sample string 12",
"db_address_id": "c2bf491f-2784-4839-b8fd-52a6a29dc271",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6aa40569-8c69-4e5b-abe3-c3bef7eed56f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d38dd2b7-4400-4587-9b28-ff433f0a457f",
"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-22T03:03:43.8225103+00:00",
"date_create": "2026-06-22T03:03:43.8225103+00:00",
"date_update": "2026-06-22T03:03:43.8225103+00:00",
"updated_by_user_id": "3bc43eba-736e-4ef0-bdbb-76b50282cfdc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-22T03:03:43.8225103+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-22T03:03:43.8225103+00:00",
"date_last_job": "2026-06-22T03:03:43.8225103+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-22T03:03:43.8225103+00:00",
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00",
"is_mobile_installation": true
},
"job_type_id": "fb00a49d-fc7d-4e06-b9d3-5a2aa6fe32a4",
"job_type_code": "sample string 7",
"job_type": {
"id": "fd3f7600-e748-4c01-b300-4d0b6a4f2090",
"name": "sample string 2",
"sales_organization_id": "a180de52-bfb0-4d8d-9ba6-1ce77ef0f1da",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00",
"code": "sample string 7"
},
"job_priority_id": "1f2f1ce3-8ecd-4e48-bcda-b03201350c31",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "36d43a70-689d-4230-9757-bba5909ebfaa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c4cf2a57-1816-47e7-bc31-b3675f940820",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
},
"job_status_id": "0e838e71-b30e-4eeb-8194-05a40cb3ed8f",
"job_status_code": "sample string 11",
"db_address_id": "9f778298-7c9c-4c06-a6c9-72dd5905e0d4",
"contact_id": "99e96dd6-c43a-43ab-b07f-3e4e0d66340a",
"requested_by_company_id": "3fc43ba7-d37f-46f5-85d8-7b51aacfbbf5",
"requested_by_contact_id": "81d3377d-d684-4a24-859d-eaec60e1bea8",
"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-22T03:03:43.8225103+00:00",
"due_date": "2026-06-22T03:03:43.8225103+00:00",
"date_create": "2026-06-22T03:03:43.8225103+00:00",
"date_update": "2026-06-22T03:03:43.8225103+00:00",
"date_closed": "2026-06-22T03:03:43.8225103+00:00",
"suggested_user_id": "d0d3d19f-3dd0-427f-ae0a-c2c7ff6e524e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7299f63f-649b-4646-9d62-5754c636cfd0",
"db_language_id": "80ede78e-7d9d-4475-8592-ae006ee2e330",
"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-22T03:03:43.8225103+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "67fd79e1-a621-4b83-9fca-c8e074163cfe",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fdf26948-9e92-4e60-9f7c-3f45baf51f66",
"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": "cd6393b9-eb3f-4029-a1c5-9fbaee0415a1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f19480d2-1322-4ac5-834c-2f8326510ddd"
},
"suggested_date_start": "2026-06-22T03:03:43.8225103+00:00",
"skill_id": "badd78da-361b-4a09-803a-6249323228e0",
"skill_code": "sample string 32",
"skill": {
"id": "28c41680-b0cd-43b2-a8b1-4a9c84cb7b34",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c8509154-f9b0-4fda-8af8-772a4f763f41",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0225fc89-88f4-4354-a49a-c962bd384897",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e438d3e8-8b25-4167-84e6-fc97373f9d2a",
"db_currency_id": "f52df223-3c47-4599-b9aa-68dfba29af21",
"db_language_id": "e65b2b2c-b82f-456d-82a1-36762e6dc720",
"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-22T03:03:43.8225103+00:00"
},
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e54c3e44-038d-4050-ba66-c9d1acec114f",
"date_reported_by_company": "2026-06-22T03:03:43.8225103+00:00",
"id2": 36,
"company_id": "a64e0481-1b87-4288-a696-8bb24cf10b3d",
"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": "70a4723c-9e90-4535-91f2-ced950ce9d02",
"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-22T03:03:43.8225103+00:00"
},
"work_instruction_details_id": "b77d99b0-a915-467b-ad2c-681629cb1327",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5b2930ca-e5f4-40cc-9ddd-f9601ecf2d82",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bc3e7573-e959-4062-bf70-133474c9962c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-22T03:03:43.8225103+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": "d372bb33-4c93-4888-8733-d3c026bedcef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-22T03:03:43.8225103+00:00"
}