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": "898ac046-8488-4d38-89b6-23c1ff07b21c",
"jobs_id": "676dac61-1b23-4898-a871-b8e082b3aab5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1ae6742f-da32-4380-8155-135371639db9",
"_parent_id": "2467d40e-d71a-4b46-a372-81bbf55b64f8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "67bec1f6-f4f4-4927-83b2-e46b9fc43d57",
"project_reference_back_office": "sample string 5",
"project": {
"id": "30912c9e-46b3-41dc-84ed-d5abedccd8f3",
"_parent_id": "ea12199f-b57d-41ab-a516-dbb6839943a9",
"root_parent_id": "deab38f9-066a-4d20-b0b2-577090077200",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "686a3ef8-38b2-49af-aa89-bd9a731a7da2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8ce3ab57-dcba-4014-8753-da91c94ab5f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4e32293-da71-4c36-8a7a-5553cdea9fb9",
"_parent_code": "sample string 6",
"sales_organization_id": "bd278e2b-78e9-4774-89c5-6889491c1ce3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
},
"equipment_model_id": "1ddf9fdc-e346-4a10-80a8-d1cb0db02348",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1f1d020a-c7ed-437d-90de-f917d0072db7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2366da8a-79d1-47fe-ac7c-b886d9ad79f3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0a34189f-d0e5-4acb-86c2-4680baf78896",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d92cd4c-122d-4bfa-a218-774cd70073fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
},
"equipment_family_id": "76d3c9c2-44f9-4ad4-bb4b-c0139817b86b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8ce3ab57-dcba-4014-8753-da91c94ab5f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4e32293-da71-4c36-8a7a-5553cdea9fb9",
"_parent_code": "sample string 6",
"sales_organization_id": "bd278e2b-78e9-4774-89c5-6889491c1ce3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
},
"date_in_production_since": "2026-03-12T10:14:24.2302947+00:00",
"date_out_of_production_since": "2026-03-12T10:14:24.2302947+00:00",
"date_end_support": "2026-03-12T10:14:24.2302947+00:00",
"sales_organization_id": "03fc9fad-fb18-43b9-b36d-883bb4c11851",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+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-03-12T10:14:24.2302947+00:00"
},
"project_status_id": "273b07c5-dc45-4698-87db-fe94f07e8346",
"project_status_code": "sample string 10",
"project_status": {
"id": "b7e5d81f-53da-4f98-a61e-701d4ea8cdb0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b646fe2-672c-4ca1-9c79-ff403b7b6e48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
},
"company_id": "2f96055a-87e6-4306-ab35-70e9fd602a89",
"company_code": "sample string 12",
"db_address_id": "b69d3a29-c49b-4292-a6cc-1a08a685ec1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1512f579-e685-4ffb-829e-cb276326efff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "85c31fe8-0ec5-4979-a0bf-afe03c07b0a1",
"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-03-12T10:14:24.2302947+00:00",
"date_create": "2026-03-12T10:14:24.2302947+00:00",
"date_update": "2026-03-12T10:14:24.2302947+00:00",
"updated_by_user_id": "0005d287-fe39-4b7c-928c-a36a4061d9d6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T10:14:24.2302947+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T10:14:24.2302947+00:00",
"date_last_job": "2026-03-12T10:14:24.2302947+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T10:14:24.2302947+00:00",
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00",
"is_mobile_installation": true
},
"job_type_id": "b947466f-4d67-4033-a2c9-deca8fb5adb4",
"job_type_code": "sample string 7",
"job_type": {
"id": "397fe4a7-1571-429b-9a50-15473eb46680",
"name": "sample string 2",
"sales_organization_id": "a98d615d-b815-417d-bea9-9065a9fed64a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00",
"code": "sample string 7"
},
"job_priority_id": "8ac52f92-0ee0-4b33-8795-eddd54f4a9ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "44f88fc8-d956-417f-b4c4-084377ecb5af",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6c4f602a-3f36-4261-a624-05f66ff585ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
},
"job_status_id": "b9b15413-28c6-44a5-9904-ae2161c15230",
"job_status_code": "sample string 11",
"db_address_id": "52470d9c-c966-42e1-b04a-f064c270fcdd",
"contact_id": "db05f710-a9c1-420b-a327-9d4d5cd30242",
"requested_by_company_id": "c78a6861-95c5-4eab-b0dc-1c5536034a7d",
"requested_by_contact_id": "3c7c6f09-5e6e-492c-a218-63ff21b7ea72",
"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-03-12T10:14:24.2302947+00:00",
"due_date": "2026-03-12T10:14:24.2302947+00:00",
"date_create": "2026-03-12T10:14:24.2302947+00:00",
"date_update": "2026-03-12T10:14:24.2302947+00:00",
"date_closed": "2026-03-12T10:14:24.2302947+00:00",
"suggested_user_id": "d6984429-f44a-48dc-a372-7957a70b4619",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "719f754c-b454-4f8c-be97-ac2b25294963",
"db_language_id": "5b1c2dbc-3e44-49e3-8812-3f1c363d8da9",
"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-03-12T10:14:24.2302947+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "75e759dc-a6ec-4d8b-9ae5-bb517e856b36",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4f4337f3-ae34-4cba-aa6d-36cc8c281613",
"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": "f730c5a3-3e06-4b35-8c44-716a1d742193",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "af675dcd-53dc-4d19-98e0-fca15acfafe1"
},
"suggested_date_start": "2026-03-12T10:14:24.2302947+00:00",
"skill_id": "1db973b7-7123-43ee-a38a-bd3d865fda86",
"skill_code": "sample string 32",
"skill": {
"id": "393154bd-b5b8-49ac-a525-10750ff16720",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f1c0d876-af45-494e-8186-0d2d69d31eb0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8ecdb8b-46da-4bf5-9804-ad5a7fbd7842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcdb4746-c156-48a6-accd-dff37895469a",
"db_currency_id": "85e1f855-c728-4f10-ab37-89629105edf0",
"db_language_id": "8b323a2c-d502-47a6-a67a-363cc685fce6",
"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-03-12T10:14:24.2302947+00:00"
},
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d3c832a6-18c4-4ba0-9cb5-213367223629",
"date_reported_by_company": "2026-03-12T10:14:24.2302947+00:00",
"id2": 36,
"company_id": "36a943d4-974a-4e6f-abbf-d6b37145a206",
"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": "8c32fbdb-b71a-4f7e-8de2-8c5461583547",
"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-03-12T10:14:24.2302947+00:00"
},
"work_instruction_details_id": "815e8456-fc1f-402d-bd25-f5da65fb246e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "399fd11e-e36e-49ea-be69-a525995cd1e3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "001cb88e-fafd-433d-99e3-738a1c8a73bb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T10:14:24.2302947+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": "54acffd0-5a29-4b4b-9818-0468a07fa627",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T10:14:24.2302947+00:00"
}