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": "c95d5120-fc35-4d6a-b818-fede4e8ad9a1",
"jobs_id": "e740d191-41dd-4b77-8a8b-986dcb0be9a2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5e041fa3-c9c0-4986-876c-eb2ce288aeed",
"_parent_id": "9ad34e19-eba9-4f19-8a5f-f63bdc4ab162",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a939a394-738e-4ad5-bb42-f5ff30ea7e3d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "256dcae1-8be0-404b-8f28-5b25b57d9351",
"_parent_id": "b6a03269-ba26-4138-ad77-0458b1e1a753",
"root_parent_id": "1c2c5be3-3824-4e15-9658-891b39fbe09b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1e50c019-476e-40f5-8f6c-1dfdc6ee20e1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fa5ab7f7-a700-4445-ba2a-f0894e74fc2d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "35e1553e-7dd3-494c-9012-5f1ad029f48c",
"_parent_code": "sample string 6",
"sales_organization_id": "9e3d485b-6dd4-4253-ae1b-76eb8fc92e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
},
"equipment_model_id": "5707bb0e-59de-45df-a209-2831c72fbac4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7a434cb6-e95a-40ab-979e-d7e41656d4c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2e7de304-6ab5-4e15-a629-b73e171c6f6c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "13c992a2-4838-44ce-aab7-0c3e28f15475",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "434d8aa3-fd14-40c0-9358-a4e64bcee223",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
},
"equipment_family_id": "54049cca-3a3e-4144-8286-7edc28bc4ae1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fa5ab7f7-a700-4445-ba2a-f0894e74fc2d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "35e1553e-7dd3-494c-9012-5f1ad029f48c",
"_parent_code": "sample string 6",
"sales_organization_id": "9e3d485b-6dd4-4253-ae1b-76eb8fc92e77",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
},
"date_in_production_since": "2026-08-16T14:51:10.6374968+00:00",
"date_out_of_production_since": "2026-08-16T14:51:10.6374968+00:00",
"date_end_support": "2026-08-16T14:51:10.6374968+00:00",
"sales_organization_id": "31cccb15-ae83-46e7-b495-c81eb6cba9ad",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+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-16T14:51:10.6374968+00:00"
},
"project_status_id": "47abd166-eaa3-4c88-9d69-1f1cefef0ae3",
"project_status_code": "sample string 10",
"project_status": {
"id": "2f082f7d-04ce-4881-a32e-793884e26b7b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ed0d79a0-30d5-43f5-a116-71711e08b063",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
},
"company_id": "3623272c-b3c1-40af-aa6b-4729af159d59",
"company_code": "sample string 12",
"db_address_id": "ebe00dbb-42f0-49e3-b836-3f0c02f3c319",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7d9a5542-83cb-40bf-b5df-a9af3ab62b97",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c46d9b79-7804-458c-b8ca-145e473cb154",
"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-16T14:51:10.6374968+00:00",
"date_create": "2026-08-16T14:51:10.6374968+00:00",
"date_update": "2026-08-16T14:51:10.6374968+00:00",
"updated_by_user_id": "f31d3206-ea5d-4975-b1f1-f95d5447a2d5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-16T14:51:10.6374968+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-16T14:51:10.6374968+00:00",
"date_last_job": "2026-08-16T14:51:10.6374968+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-16T14:51:10.6374968+00:00",
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00",
"is_mobile_installation": true
},
"job_type_id": "cd1c9ca8-6001-4845-8530-07a4fa5df0d4",
"job_type_code": "sample string 7",
"job_type": {
"id": "5b79ca96-a655-4077-8bcb-868d29a552ea",
"name": "sample string 2",
"sales_organization_id": "e690d5b1-c1d4-404f-ac76-8ecbf6a70c54",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00",
"code": "sample string 7"
},
"job_priority_id": "a1769e8e-997d-43fc-b689-28f556b18484",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b0a112a-fa54-4709-bb6a-ac801440adc0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1aa0dd82-649f-4cc3-bfd2-faa1f1123776",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
},
"job_status_id": "d90c477c-ba83-42c2-826c-4fcd03a775dd",
"job_status_code": "sample string 11",
"db_address_id": "fa52ca18-f7a6-4c95-827d-9ca9a3cb0bd0",
"contact_id": "7359f997-d818-4d31-b7f7-b03427a9b6ee",
"requested_by_company_id": "15a96550-0431-4a9f-912e-004d077aef9b",
"requested_by_contact_id": "f96220df-1f8b-4b7c-8090-f2aa5ddaeada",
"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-16T14:51:10.6374968+00:00",
"due_date": "2026-08-16T14:51:10.6374968+00:00",
"date_create": "2026-08-16T14:51:10.6374968+00:00",
"date_update": "2026-08-16T14:51:10.6374968+00:00",
"date_closed": "2026-08-16T14:51:10.6374968+00:00",
"suggested_user_id": "5f4b7d3a-2871-4c93-abbe-23fcc0d502c7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "77a63e60-12d4-4166-b7ab-0d1e252c01e9",
"db_language_id": "4ceefb37-fe25-4015-bc5c-715999fb75f8",
"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-16T14:51:10.6374968+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "526e11b3-7ff9-4249-bbd6-b71c7d756d68",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3be9f710-1956-4ae2-a3d2-4e7d8fc2ac1b",
"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": "8c6d96bf-bea2-4d1f-a801-571a9de03263",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fb8b0970-c480-4ebc-a64f-8ee76e78a57e"
},
"suggested_date_start": "2026-08-16T14:51:10.6374968+00:00",
"skill_id": "0c95c8f9-824c-4b1b-8940-7850b3f07342",
"skill_code": "sample string 32",
"skill": {
"id": "736e88ed-6620-460a-a233-47f47aca51d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f95aae78-aa61-46f0-a29b-10a7ec2d8824",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f258e29-9300-4059-b051-d09f00dcbe1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e0419ea6-b60a-46a0-ab48-991a5c551bda",
"db_currency_id": "b59053ef-229e-4e2f-ae87-2c9135814638",
"db_language_id": "9f7b5a77-549e-4cb7-85f5-d8afee5d9b96",
"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-16T14:51:10.6374968+00:00"
},
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1a6294cb-8771-4aaf-8af4-eff19c58ea15",
"date_reported_by_company": "2026-08-16T14:51:10.6374968+00:00",
"id2": 36,
"company_id": "23ee960d-43ed-480a-829c-6c959379e4d3",
"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": "7cd0c6e5-906f-4bc5-8886-2f7217ad332c",
"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-16T14:51:10.6374968+00:00"
},
"work_instruction_details_id": "4af9f3d5-6b70-461b-b64a-cc030920099b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a96f3fc2-a7b4-4fcc-a2d0-bbf193f96f16",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "653a9601-b0f1-48d0-8872-76b5b3073aa8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-16T14:51:10.6374968+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": "65d0a775-b92a-4ac7-9f0e-825bd2c42a4d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-16T14:51:10.6374968+00:00"
}