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": "189a9f67-5548-4160-97e1-1f95e1c21bf6",
"jobs_id": "68354442-a1f3-4db8-9537-46b9c64c8632",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "73ef8405-59bc-46d5-9e20-abd10da8746f",
"_parent_id": "27ed3095-483f-4827-a629-d05f95af6239",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0da7e26d-b23e-4e2b-8b4e-9186e8a355d3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f04ab5b2-a2ba-4792-a54c-b78617b15193",
"_parent_id": "4eb51276-6560-4a4f-a735-947b5d972fa2",
"root_parent_id": "10633520-9b41-46fd-9ccc-187f7ea55c69",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f11e4a43-2a75-49d1-80b9-8816fa30a2cc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e1aa851b-a3bf-4980-86ed-57a79eddc35e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e4ba702-8be7-4276-8757-ef4fd484fcf9",
"_parent_code": "sample string 6",
"sales_organization_id": "eb2dd256-42e6-4ce4-9f3f-2976d72f1910",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
},
"equipment_model_id": "457d8404-60b7-4d16-9117-61831e9567da",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "622bf836-ea55-4471-be2f-110827507351",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ded28007-4484-4394-a010-cde30b7fde0d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7e5b6205-37d8-4aff-ab20-1943910501d4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "15a81e12-314e-4f65-b9ed-909407f610ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
},
"equipment_family_id": "0d0483d7-c286-4d17-b2ca-1c9b8ea258ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e1aa851b-a3bf-4980-86ed-57a79eddc35e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e4ba702-8be7-4276-8757-ef4fd484fcf9",
"_parent_code": "sample string 6",
"sales_organization_id": "eb2dd256-42e6-4ce4-9f3f-2976d72f1910",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
},
"date_in_production_since": "2026-09-08T11:17:39.2178571+00:00",
"date_out_of_production_since": "2026-09-08T11:17:39.2178571+00:00",
"date_end_support": "2026-09-08T11:17:39.2178571+00:00",
"sales_organization_id": "534bb06f-f806-4e28-9a5d-8cd24be8422d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+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-08T11:17:39.2178571+00:00"
},
"project_status_id": "670029fd-4168-403b-83d6-0d9e13fd37b3",
"project_status_code": "sample string 10",
"project_status": {
"id": "7e96e18d-73a1-4314-82d9-f5c322c426b2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "15e5554b-7c79-4ad4-9262-07045c8947ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
},
"company_id": "cc0a3c45-c5ba-4b39-a0a6-131acb086702",
"company_code": "sample string 12",
"db_address_id": "660fc4b3-8e50-401c-9ef1-149aaad1bc88",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9f070b3b-345d-4ed8-bad2-b150bb3ac24c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "668a5c0b-e9d1-449f-9c35-5aa63f76b892",
"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-08T11:17:39.2178571+00:00",
"date_create": "2026-09-08T11:17:39.2178571+00:00",
"date_update": "2026-09-08T11:17:39.2178571+00:00",
"updated_by_user_id": "460a9ebe-7b16-4289-a93c-f4b4b5f083ef",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-08T11:17:39.2178571+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-08T11:17:39.2178571+00:00",
"date_last_job": "2026-09-08T11:17:39.2178571+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-08T11:17:39.2178571+00:00",
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00",
"is_mobile_installation": true
},
"job_type_id": "390d1f72-d1b8-4bbd-95af-1f60b38ffef8",
"job_type_code": "sample string 7",
"job_type": {
"id": "e276e4fc-eeb5-4d8c-a92c-417265f475a7",
"name": "sample string 2",
"sales_organization_id": "07da0450-eaa8-454e-92ab-e0cbd1d4cb9f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00",
"code": "sample string 7"
},
"job_priority_id": "31d92388-63ca-4dcf-af79-54788e866d3c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "47d0784f-9300-4c32-8736-3a4b78a02ac1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "68a5367c-621f-4e84-8579-7b4d47c292c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
},
"job_status_id": "a49a2844-9c6f-41c1-be29-397a115cb9be",
"job_status_code": "sample string 11",
"db_address_id": "476a39f8-c975-4891-82a6-6eccebd4f269",
"contact_id": "ad4c9cbc-2bef-4c35-b0b9-138990ece132",
"requested_by_company_id": "c4907082-35b4-46d0-8985-22c077cba1e5",
"requested_by_contact_id": "adfaf459-71d2-4216-8392-73a6ed9f3ebe",
"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-08T11:17:39.2178571+00:00",
"due_date": "2026-09-08T11:17:39.2178571+00:00",
"date_create": "2026-09-08T11:17:39.2178571+00:00",
"date_update": "2026-09-08T11:17:39.2178571+00:00",
"date_closed": "2026-09-08T11:17:39.2178571+00:00",
"suggested_user_id": "383c1fa2-3858-458f-aab9-1aa51ce21f35",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "34d0a9ac-3b50-45d6-a014-0e9af4ffa156",
"db_language_id": "e0c2323b-d1dc-40c1-b17f-bbbde56bd4dd",
"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-08T11:17:39.2178571+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f58d2e48-e91a-4235-84f8-7a35132691ad",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5a793187-4ca4-4cac-8651-20870f4815a3",
"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": "f984ffa7-8bd7-42e8-92b5-3127d2d83ddd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "35ec61ce-0534-4c2b-8ae8-85a114407deb"
},
"suggested_date_start": "2026-09-08T11:17:39.2178571+00:00",
"skill_id": "c6667cd0-2635-40b1-b899-dcb63afa26f8",
"skill_code": "sample string 32",
"skill": {
"id": "ccc0113f-e0f7-4450-b9c8-afa5b0eeb53c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f23a6eb-11e5-48a3-b6ac-992a359ce545",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "feb819b2-e68f-4507-9f40-9020738297e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee871990-0fbb-43f1-9344-5900cac157bb",
"db_currency_id": "913ca6fd-8b42-4b6d-b41a-8d65e9b38591",
"db_language_id": "e69f0097-1664-4a42-b2b6-debb36ae4a45",
"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-08T11:17:39.2178571+00:00"
},
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "937ba417-0432-4a06-8870-f74a7957ecb8",
"date_reported_by_company": "2026-09-08T11:17:39.2178571+00:00",
"id2": 36,
"company_id": "6cdbe357-f145-41c5-85ee-afe4c2a7ea08",
"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": "aa1a68a5-9409-4687-9a2f-59b58d90d0e5",
"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-08T11:17:39.2178571+00:00"
},
"work_instruction_details_id": "9787043a-ab17-428e-afc9-073088a46f59",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f6a5473f-328d-454b-badc-5395fd4bf78d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6cfa04a0-ac72-4e5f-ba40-0a7442cf2abe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-08T11:17:39.2178571+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": "bf305302-9c2f-402e-9aec-79c2262e3f60",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-08T11:17:39.2178571+00:00"
}