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": "859028ff-6203-4415-8b5e-a790e6a0922d",
"jobs_id": "7883657d-81dc-4e16-af7e-7e1d6302868f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e6e7c972-ea1b-4b41-a5f2-495e6cd751a6",
"_parent_id": "13932a75-498b-470d-abb6-cacda528f717",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d41304f8-c533-4354-afac-9ddd7383f304",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5ce34ed8-07ac-43de-9195-9d680085297f",
"_parent_id": "10e42626-7ed4-4cd9-81a6-e966e86195db",
"root_parent_id": "254de32b-c1a2-4641-9a7f-4699264889e6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a4dfd253-5411-4c4c-8dfe-fe6261c02868",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7f73665c-7d02-4b1b-ab4c-4ebaccc4691e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dcbb2dda-ee6d-4720-a159-63f0eb077fdf",
"_parent_code": "sample string 6",
"sales_organization_id": "f81cd9e2-5607-430e-a88c-12db4a11a216",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
},
"equipment_model_id": "99a50fa8-fc38-4c4a-ad97-cd402f373013",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0d3a61f0-af4e-4cef-b9cf-e6b1d69cc96b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "88ec3dbb-b7ea-4011-a19b-e0c995c7b552",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "460c8b5f-59e0-4027-8741-401f8d4e65b9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a4c0e84f-bd8d-4a7f-9f1b-747d991a2fc4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
},
"equipment_family_id": "f1a0be11-a849-4e21-a8a3-3acf93bb6298",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7f73665c-7d02-4b1b-ab4c-4ebaccc4691e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dcbb2dda-ee6d-4720-a159-63f0eb077fdf",
"_parent_code": "sample string 6",
"sales_organization_id": "f81cd9e2-5607-430e-a88c-12db4a11a216",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
},
"date_in_production_since": "2026-09-17T13:26:01.2602624+00:00",
"date_out_of_production_since": "2026-09-17T13:26:01.2602624+00:00",
"date_end_support": "2026-09-17T13:26:01.2602624+00:00",
"sales_organization_id": "7e10b625-8b3f-4dd9-bfbd-0be07e9a8d96",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+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-09-17T13:26:01.2602624+00:00"
},
"project_status_id": "44f07df4-836b-4400-8319-e78ffaf1900d",
"project_status_code": "sample string 10",
"project_status": {
"id": "3f17e2aa-1688-405e-9ed2-693edc9b2db6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fdde90c7-9f27-4c15-b406-b40a3b9528da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
},
"company_id": "78096636-3c82-47f6-9be3-5d3b88c76b41",
"company_code": "sample string 12",
"db_address_id": "89d3abd6-04ef-4b44-8c2b-e4f8c760a28d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "848d1281-7832-493b-bbbd-4ad9b3cd1675",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3facb0ef-991b-4d0b-9c06-8f7cc888ca47",
"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-09-17T13:26:01.2602624+00:00",
"date_create": "2026-09-17T13:26:01.2602624+00:00",
"date_update": "2026-09-17T13:26:01.2602624+00:00",
"updated_by_user_id": "5acd25a6-dfae-4daf-83e3-afa5287f4f95",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-17T13:26:01.2602624+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-09-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-17T13:26:01.2602624+00:00",
"date_last_job": "2026-09-17T13:26:01.2602624+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-17T13:26:01.2602624+00:00",
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00",
"is_mobile_installation": true
},
"job_type_id": "f30ab3a9-07e9-4b64-8bb1-3de03843e93a",
"job_type_code": "sample string 7",
"job_type": {
"id": "01d5cf4b-af8b-4c0f-a0e8-6fceb867dcc6",
"name": "sample string 2",
"sales_organization_id": "f9e95d89-e4b0-43d6-b317-72e658403cfe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00",
"code": "sample string 7"
},
"job_priority_id": "038dc3be-c558-4014-8b1a-4da1b24ea284",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1d396467-04c6-41af-8d50-1189d2390a7a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "052fb137-f4d2-440e-bf59-c4738795a6e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
},
"job_status_id": "efb231d1-c4c3-4cc8-a1b5-2e4e0fbc992e",
"job_status_code": "sample string 11",
"db_address_id": "49edf2bf-a935-4823-a2e8-f62f1b6ff4bd",
"contact_id": "2eb90e5f-3a17-48c3-adf5-8e55373a298c",
"requested_by_company_id": "541d79ae-93d3-49b0-888f-28ac4becbd7e",
"requested_by_contact_id": "7625c842-5131-4eb9-94b0-fc02d1c0898b",
"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-09-17T13:26:01.2602624+00:00",
"due_date": "2026-09-17T13:26:01.2602624+00:00",
"date_create": "2026-09-17T13:26:01.2602624+00:00",
"date_update": "2026-09-17T13:26:01.2602624+00:00",
"date_closed": "2026-09-17T13:26:01.2602624+00:00",
"suggested_user_id": "a6230493-1883-4327-b64e-8b17a28b7a4d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c1bee234-d103-4046-9c7c-1c5cbbc87b6b",
"db_language_id": "4ebefb6a-1c87-4388-a1f3-f86e628597af",
"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-09-17T13:26:01.2602624+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7e3e4bdb-7e72-40e5-b4c7-787c6b0b80ab",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8ccaa223-e91c-444e-bd51-1be9c7c9e94e",
"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": "6dd31c6f-b73a-4412-9725-81665afb4ee1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "00921453-bb2b-4c37-b6c5-24d7c567bf38"
},
"suggested_date_start": "2026-09-17T13:26:01.2602624+00:00",
"skill_id": "d3d28d61-a08c-45a7-b685-12e904973a6a",
"skill_code": "sample string 32",
"skill": {
"id": "fa8d254a-2d89-4373-9f06-dfcfd14fef49",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "417fa882-2335-4a06-9ed9-796ece52bc9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5113c3e-c66f-4f72-b362-70a872f73a67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "78465b2b-a180-42a2-95cd-af942ab39ece",
"db_currency_id": "9a3fb741-cb74-4e51-8b58-11c4369bfe56",
"db_language_id": "3f6ae9b7-147f-4596-b4dd-c05d01816097",
"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-09-17T13:26:01.2602624+00:00"
},
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6eec1f1e-801b-4f35-a3be-d9dd82922ac0",
"date_reported_by_company": "2026-09-17T13:26:01.2602624+00:00",
"id2": 36,
"company_id": "2c19a866-3264-4cbe-8c75-f0c7ad8944e1",
"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": "93b4c669-55bd-4016-b8eb-223f1985ba5a",
"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-09-17T13:26:01.2602624+00:00"
},
"work_instruction_details_id": "429bcf5b-a029-455a-a60a-9a1330df815f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e9818e31-deeb-4530-a293-2f2a9aa21bbb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c0a20e5e-7015-4bb6-958a-92dd75161e2f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-17T13:26:01.2602624+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": "c8b64860-cc6e-4f57-85f8-1f481b02d21b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-17T13:26:01.2602624+00:00"
}