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": "4075ce02-f39f-4c20-a7b3-a79653812cee",
"jobs_id": "8df4ed1a-9db0-4efe-9548-835000e440e1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "982cbf1e-a5d9-46a8-8415-5688642046ff",
"_parent_id": "e64bd228-6099-40cd-9cef-3221e3be16f9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "654e2ed3-91de-47cd-a1ef-8c0b6c95aeec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bfb19c45-3a22-47ae-850b-8cbb130a540f",
"_parent_id": "d29a353c-5dbe-4910-be30-1f9fec9a7915",
"root_parent_id": "864a3b4e-4946-4521-a42d-2465768ef102",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3dafba42-6538-4aa4-a616-16c2f6fec4de",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3daebc59-167a-47a5-917c-a949c3327674",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "05cef2f1-393d-42bd-af9b-7f89b7dfbb5a",
"_parent_code": "sample string 6",
"sales_organization_id": "7a86ff1b-b373-4a18-bef4-462958b0ba52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"modified_dateutc": "2025-11-14T11:14:24.2143377+00:00"
},
"equipment_model_id": "06f5b907-becf-471f-bb40-e5dfadbf6a05",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "51b9794b-7d39-4e57-8f91-8ece738564e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cf4ca7ba-d119-4ee5-a846-63f9d991e0a3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8cd3a257-e8a5-487d-a637-a51559352248",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dbbf489c-6be0-4a02-94da-4d48da6e7948",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"modified_dateutc": "2025-11-14T11:14:24.2143377+00:00"
},
"equipment_family_id": "75633648-c41f-460b-9f7d-3a6a95ebd401",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3daebc59-167a-47a5-917c-a949c3327674",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "05cef2f1-393d-42bd-af9b-7f89b7dfbb5a",
"_parent_code": "sample string 6",
"sales_organization_id": "7a86ff1b-b373-4a18-bef4-462958b0ba52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"modified_dateutc": "2025-11-14T11:14:24.2143377+00:00"
},
"date_in_production_since": "2025-11-14T11:14:24.2143377+00:00",
"date_out_of_production_since": "2025-11-14T11:14:24.2143377+00:00",
"date_end_support": "2025-11-14T11:14:24.2143377+00:00",
"sales_organization_id": "96e898fa-f29e-41d2-9ed4-24e8804a10dc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+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": "2025-11-14T11:14:24.2143377+00:00"
},
"project_status_id": "7821e126-142d-4164-a248-e5d7cebe5cd5",
"project_status_code": "sample string 10",
"project_status": {
"id": "e98fc2e8-7967-403e-bd0d-f12e6f612c29",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6622eaa4-f8f6-432e-b565-6fd00431022b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-14T11:14:24.2143377+00:00"
},
"company_id": "4def9c85-6ee6-4313-abbe-d20bda045a3d",
"company_code": "sample string 12",
"db_address_id": "ec24b536-7b80-4d06-9d3f-60d498da210e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "008ffc8e-0267-4493-842b-0be3e93604b6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7b937e6f-6e14-4fbc-824b-122a2eb4e2b2",
"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": "2025-11-14T11:14:24.2143377+00:00",
"date_create": "2025-11-14T11:14:24.2143377+00:00",
"date_update": "2025-11-14T11:14:24.2143377+00:00",
"updated_by_user_id": "07f82d9a-e814-4d26-b667-9d72eda6b4aa",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-14T11:14:24.2143377+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": "2025-11-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-14T11:14:24.2143377+00:00",
"date_last_job": "2025-11-14T11:14:24.2299632+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-14T11:14:24.2299632+00:00",
"modified_dateutc": "2025-11-14T11:14:24.2299632+00:00",
"is_mobile_installation": true
},
"job_type_id": "d1e31fe2-70d6-4fc5-a5ff-27cb8b825bb0",
"job_type_code": "sample string 7",
"job_type": {
"id": "0081c34b-fb5b-4843-ab4a-4e3131070445",
"name": "sample string 2",
"sales_organization_id": "f5b81399-1b49-4edb-82db-797e1a3a23bb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-14T11:14:24.2299632+00:00",
"code": "sample string 7"
},
"job_priority_id": "099cc09c-1cdd-43f2-9414-352016c424e6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4ea98051-d391-4805-99da-d91bc503105b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "36198cd5-7bd5-412e-910a-a888e5199847",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-14T11:14:24.2299632+00:00"
},
"job_status_id": "7591ca56-28f0-4588-8214-9f38d99e39ef",
"job_status_code": "sample string 11",
"db_address_id": "eb0e7e1a-1ce4-4eaf-b6eb-86ac88f0d487",
"contact_id": "b0f7b56f-0b4b-4b89-aaad-3e9ffabc02bf",
"requested_by_company_id": "91634d0e-7c6b-4a28-9543-0f48e7745214",
"requested_by_contact_id": "283529a4-a5aa-43c6-aee4-76db717fba31",
"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": "2025-11-14T11:14:24.2299632+00:00",
"due_date": "2025-11-14T11:14:24.2299632+00:00",
"date_create": "2025-11-14T11:14:24.2299632+00:00",
"date_update": "2025-11-14T11:14:24.2299632+00:00",
"date_closed": "2025-11-14T11:14:24.2299632+00:00",
"suggested_user_id": "236536a6-1621-43e8-a46c-44b254ba6571",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f5e182ce-16b7-47e1-a56e-384d418985f8",
"db_language_id": "ffdd4395-4154-46f0-91ad-4780a11f8c1b",
"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": "2025-11-14T11:14:24.2299632+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e8708670-90db-42ce-96cb-9432021b29c6",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ded8e373-b4cc-4e33-aca9-0ee50dc6a1ba",
"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": "2ea77ae3-720b-496f-adbb-b7a65273554c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-14T11:14:24.2299632+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f305ae09-333d-48c3-8f3a-dc6b55d4f38a"
},
"suggested_date_start": "2025-11-14T11:14:24.2299632+00:00",
"skill_id": "a41df582-0cdf-457a-8d5b-36d4660b83cf",
"skill_code": "sample string 32",
"skill": {
"id": "ce68a8b4-bb22-4542-b3ce-2b81b10eb10e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bbb64553-51af-4ace-aa16-15ea5114beff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74afe80e-5df2-4ee6-8fb0-87411b4aaff9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb0f4e17-bdef-4129-a950-b5a2e51f1ed7",
"db_currency_id": "d466f7a2-54ab-4a2c-8d97-658fff4d88bd",
"db_language_id": "979d054b-6739-4f9c-8478-c46bab7d2fa5",
"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": "2025-11-14T11:14:24.2143377+00:00"
},
"modified_dateutc": "2025-11-14T11:14:24.2299632+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2336e5a5-7791-47d8-a7fe-ae23ad2cc18b",
"date_reported_by_company": "2025-11-14T11:14:24.2299632+00:00",
"id2": 36,
"company_id": "b32a36b6-80cf-4a68-8fa5-bfc8bb09be48",
"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": "72a50390-a222-4422-9469-52390f9ad2a7",
"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": "2025-11-14T11:14:24.2299632+00:00"
},
"work_instruction_details_id": "8553b2ed-45cc-40a1-a1a1-3494f94e30fb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3fe5aa39-fded-43cf-aa0c-71dec049bb7b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "52d56553-32c2-44b8-96bd-2b4d802aa576",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-14T11:14:24.2299632+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": "fd36b8fb-5d7f-480a-90b4-25f8422923e3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-14T11:14:24.2299632+00:00"
}