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": "b7d3647f-5243-4bb2-86bc-8d63b4118f2b",
"jobs_id": "b7f0bbeb-adb9-4b00-ac8d-907cea3f5430",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e785c7fd-458f-4e14-a9e2-d5d1455ee1c6",
"_parent_id": "01efc8b8-8593-4447-9538-4a446e975f32",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "328b7cb2-83dd-4c2b-a4e8-eb118dd49e81",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9f9e8691-db30-4ae4-84bd-26c4bd00225e",
"_parent_id": "31323aaa-8bf2-4d17-bbb1-c706d5b3360b",
"root_parent_id": "33ba9962-bc11-49ff-9626-bb8426fcd2f2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "747d6bcc-c05c-446f-8c55-be64dade6ce8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "98513e5c-fb49-4e39-912e-a2f3716ac198",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6c3d824c-19f9-49fd-bec2-11f54952ca70",
"_parent_code": "sample string 6",
"sales_organization_id": "74e586d4-1cca-4f92-a2ea-45c01846f5fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"modified_dateutc": "2026-01-25T01:28:53.0715952+00:00"
},
"equipment_model_id": "2fcc5dce-9e07-4f3f-99ec-725f390b4d8d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "365dce0a-93ed-4aef-b992-f0778203e40f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f16ebf21-9067-41ee-b6fc-7022328cb147",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8922b5ef-529e-4ef6-971b-5a6d039d085c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eb1fbf1c-eed1-4c15-b8be-12885f0a30d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"modified_dateutc": "2026-01-25T01:28:53.0715952+00:00"
},
"equipment_family_id": "b1887f56-aaa9-463a-b4d5-8b68fec28336",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "98513e5c-fb49-4e39-912e-a2f3716ac198",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6c3d824c-19f9-49fd-bec2-11f54952ca70",
"_parent_code": "sample string 6",
"sales_organization_id": "74e586d4-1cca-4f92-a2ea-45c01846f5fa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"modified_dateutc": "2026-01-25T01:28:53.0715952+00:00"
},
"date_in_production_since": "2026-01-25T01:28:53.0715952+00:00",
"date_out_of_production_since": "2026-01-25T01:28:53.0715952+00:00",
"date_end_support": "2026-01-25T01:28:53.0715952+00:00",
"sales_organization_id": "57527516-953c-455b-be07-0eadc5f92965",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+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-25T01:28:53.0872218+00:00"
},
"project_status_id": "2ed1c31f-7734-4e92-8058-af060a03758e",
"project_status_code": "sample string 10",
"project_status": {
"id": "dd7620b9-8bf6-4832-b115-2947d0457e11",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c5097517-e01d-4694-94b1-6ffb5ac0d77e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00"
},
"company_id": "34615dd4-7847-400b-8bc0-cd2925796226",
"company_code": "sample string 12",
"db_address_id": "77df89aa-bbbd-4498-a7aa-8ec1c061ab47",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dde4e63b-ce6e-44d5-84b5-0e0f77b62bc2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "073dad39-e348-4549-8c81-0c69796d9120",
"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-25T01:28:53.0872218+00:00",
"date_create": "2026-01-25T01:28:53.0872218+00:00",
"date_update": "2026-01-25T01:28:53.0872218+00:00",
"updated_by_user_id": "2412042f-b050-499a-bc5d-7cfdc8187274",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-25T01:28:53.0872218+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-25T01:28:53.0872218+00:00",
"date_last_job": "2026-01-25T01:28:53.0872218+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-25T01:28:53.0872218+00:00",
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00",
"is_mobile_installation": true
},
"job_type_id": "7a5a6ecb-6b8d-4bc0-aa06-08fd7c245017",
"job_type_code": "sample string 7",
"job_type": {
"id": "13421a70-bccd-43f8-9d33-914a1277de8d",
"name": "sample string 2",
"sales_organization_id": "96cf700e-eaba-40c0-8bee-17df65c40ba9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00",
"code": "sample string 7"
},
"job_priority_id": "7a567668-6338-4360-adb2-3c6402ffb7c3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d5376f0a-3d39-46bd-b45c-83614c0f1986",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "10eb09a4-b5c3-4ad3-ab91-3583228cccfa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00"
},
"job_status_id": "9472123c-77de-4e35-a4f0-74dc0cfba59b",
"job_status_code": "sample string 11",
"db_address_id": "44da4ebd-8dcd-4611-875e-e1c1c1ca6895",
"contact_id": "59bbfd21-09bb-4f88-ab48-d3d67fd05100",
"requested_by_company_id": "459668cc-3133-4041-804c-cbf738029091",
"requested_by_contact_id": "50459377-2a3a-4c37-98a0-0157412cd7fc",
"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-25T01:28:53.0872218+00:00",
"due_date": "2026-01-25T01:28:53.0872218+00:00",
"date_create": "2026-01-25T01:28:53.0872218+00:00",
"date_update": "2026-01-25T01:28:53.0872218+00:00",
"date_closed": "2026-01-25T01:28:53.0872218+00:00",
"suggested_user_id": "3ae026fa-38cf-4421-aee9-9c450b71c9d3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "73d8c431-b2c9-45ed-b86d-48a59b2affa9",
"db_language_id": "1a8210e2-b34f-48fb-ae7a-e4db950f40dc",
"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-25T01:28:53.0872218+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ed279f8c-865d-4b63-b049-4c84790219c8",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1414df20-b46d-4c84-b056-340041afa5a8",
"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": "92fbf598-1997-4722-a8ac-4ab939faacf9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9fde2cc7-bd90-4625-8ebd-7a6c49f02e31"
},
"suggested_date_start": "2026-01-25T01:28:53.0872218+00:00",
"skill_id": "d3ddd9d2-b3e3-4375-a178-7ed5671fb6e2",
"skill_code": "sample string 32",
"skill": {
"id": "6c3030a0-7469-4478-9fbb-5c20b6731be9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3286af9d-a56b-46eb-9b45-917544b2244b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "de3a6ae2-ba1e-4be0-8a6b-b43cf0921ecc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "046727ed-00fb-4d6c-97f7-3c244cf62ed3",
"db_currency_id": "483639c0-bb27-40b3-b985-1250d16c8249",
"db_language_id": "22f2db88-8e89-4a90-8dff-6cdae694b888",
"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-25T01:28:53.0715952+00:00"
},
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d90dfe1f-201f-40a1-8e3f-5cadf71684d0",
"date_reported_by_company": "2026-01-25T01:28:53.0872218+00:00",
"id2": 36,
"company_id": "65d0a4d5-04fa-41fb-b164-fbe01dd3acb3",
"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": "759c9427-8f25-4173-a07a-f5436738ef53",
"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-25T01:28:53.0872218+00:00"
},
"work_instruction_details_id": "466fad91-0ab6-4326-8f9c-c004a3b210aa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6a78e652-9976-4a1a-8ca8-d27bc461331e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c8cd3bd7-e9d9-4779-b013-96b8e2a342d1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-25T01:28:53.0872218+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": "37c54bef-0283-4a95-b305-f48fae8e26dc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-25T01:28:53.0872218+00:00"
}