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": "2144ff3b-1fb9-48c5-8beb-e21a72f9a5e8",
"jobs_id": "3465164a-5bbb-4692-a3b8-080477398350",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d2fe6da6-9c50-482d-9ac1-a747df805fad",
"_parent_id": "2cd6a9df-99b0-447d-858e-90048c156ecf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "21721851-4e2b-4faf-b72c-a163411d3d2e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3356739d-f2d1-42d9-8580-adf3d2dd99e2",
"_parent_id": "78f16a48-78cc-4853-9bec-b4aec2027ffe",
"root_parent_id": "975da610-d7a8-451e-8b8b-5319d1a9c1e9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "91d6e79b-3ba3-4083-835d-9e3420b33bc8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "232beaff-d2fe-471f-a515-5763e593149c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67df8c1b-1877-448f-9d6e-bfed6759411a",
"_parent_code": "sample string 6",
"sales_organization_id": "0aeab051-1f6a-4fdc-956b-ef7be578cb43",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
},
"equipment_model_id": "97908564-bb8f-46f1-a3a0-2aaafc886724",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "372064e9-9573-405d-bb02-33b6649dd6f8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e5c7a69e-be4b-45de-8340-641dc93fa648",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b359909a-b793-4c29-a97a-ec51dab2feb0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "05a03417-81b6-43a1-b5b3-e343c14cbaef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
},
"equipment_family_id": "a79d0082-8ef4-41e6-b53f-a9328f13945e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "232beaff-d2fe-471f-a515-5763e593149c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "67df8c1b-1877-448f-9d6e-bfed6759411a",
"_parent_code": "sample string 6",
"sales_organization_id": "0aeab051-1f6a-4fdc-956b-ef7be578cb43",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
},
"date_in_production_since": "2026-05-23T16:51:32.1961496+00:00",
"date_out_of_production_since": "2026-05-23T16:51:32.1961496+00:00",
"date_end_support": "2026-05-23T16:51:32.1961496+00:00",
"sales_organization_id": "fe969bbc-81ae-46d3-a31e-b3d0609f0290",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+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-05-23T16:51:32.1961496+00:00"
},
"project_status_id": "722df385-185c-4ca5-abf1-ca40b68543bf",
"project_status_code": "sample string 10",
"project_status": {
"id": "4401bb25-b6f0-473c-97c4-09c753b09c19",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b1908d18-9d09-4345-a2af-0686a115b0ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
},
"company_id": "9a6eeb60-6f38-4c4d-a1ab-9f8e957ee881",
"company_code": "sample string 12",
"db_address_id": "78532668-07cb-4590-8409-45ce6a4d1c40",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bdddc4e2-5616-4b44-bc5c-8cb0f8b896d9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "424868b2-6af0-4aaf-9fc3-8b9d960462fd",
"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-05-23T16:51:32.1961496+00:00",
"date_create": "2026-05-23T16:51:32.1961496+00:00",
"date_update": "2026-05-23T16:51:32.1961496+00:00",
"updated_by_user_id": "6bdcf833-e805-4b72-910c-708d29b96b41",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-23T16:51:32.1961496+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-05-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-23T16:51:32.1961496+00:00",
"date_last_job": "2026-05-23T16:51:32.1961496+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-23T16:51:32.1961496+00:00",
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00",
"is_mobile_installation": true
},
"job_type_id": "266294bb-3202-4671-b5d3-a0f662788999",
"job_type_code": "sample string 7",
"job_type": {
"id": "4d10fdda-9159-468d-8d07-8325932149a7",
"name": "sample string 2",
"sales_organization_id": "0e7f7b4c-71b5-4d71-8252-380b6a9babfc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b64731b-efc3-4f2a-8460-361b483ae22e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "59db3899-147d-4203-b690-60bd4c81780c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "05c2f789-586a-4d1c-92c3-e7cb99878500",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
},
"job_status_id": "00d25b97-6251-4f78-acfc-85c156850328",
"job_status_code": "sample string 11",
"db_address_id": "78c233c2-eaff-4c3c-9be0-b42fc4a1bd6b",
"contact_id": "ba35d306-1d89-48fb-a63b-71ee8b4cab92",
"requested_by_company_id": "e59a338c-53b3-48c5-9859-ba65d8d806ce",
"requested_by_contact_id": "cab2e395-984d-49e1-bb21-9c53bd90b736",
"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-05-23T16:51:32.1961496+00:00",
"due_date": "2026-05-23T16:51:32.1961496+00:00",
"date_create": "2026-05-23T16:51:32.1961496+00:00",
"date_update": "2026-05-23T16:51:32.1961496+00:00",
"date_closed": "2026-05-23T16:51:32.1961496+00:00",
"suggested_user_id": "63ebbfb4-d74b-4092-84e9-d18a581a045f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2c12b5ad-6b41-49aa-9d98-955e33920706",
"db_language_id": "42b607c9-bf50-4202-bff4-9e4385003dd3",
"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-05-23T16:51:32.1961496+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "95eb1732-8f7a-4331-bb49-b274dbc5a4de",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "96257787-109f-40a2-a1e6-306b9241730d",
"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": "39bc2220-3c99-4883-b079-14bd72c8c9f2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4dc58bad-4537-4484-959a-4800d998d8b3"
},
"suggested_date_start": "2026-05-23T16:51:32.1961496+00:00",
"skill_id": "6803fa9e-122d-417c-be7b-5158b715ddf3",
"skill_code": "sample string 32",
"skill": {
"id": "c191227f-b2b6-46a7-ac3b-e741e232296c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "37dc061a-ac92-426e-8a8f-db5c3edd7b88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9471babf-a3d3-4cc4-b2a2-16a533efb9cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "24cc6b91-8dd4-4cff-a821-4477c0e0d3eb",
"db_currency_id": "ebf3a905-ba5a-43c2-95d2-38938b0c0a19",
"db_language_id": "54895642-7cff-43f0-8ff1-b948698315f3",
"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-05-23T16:51:32.1961496+00:00"
},
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "14fc7ab3-a0df-41bd-badc-519933145a96",
"date_reported_by_company": "2026-05-23T16:51:32.1961496+00:00",
"id2": 36,
"company_id": "aeb78452-ca1f-45bf-b6dd-366414bf7479",
"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": "5b845251-cdf3-49d0-9a21-cf4dbd1870ff",
"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-05-23T16:51:32.1961496+00:00"
},
"work_instruction_details_id": "4fffb2ad-7d45-4372-8570-e116c9ffefd2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b03d9803-7d9d-4d47-b94a-05cb568d5ab9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1e91c8d7-4997-4def-aa4c-68fbf54a8472",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-23T16:51:32.1961496+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": "6e62221b-bdd8-488f-b98c-c0be12d5d029",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-23T16:51:32.1961496+00:00"
}