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": "73f7ecde-7cf4-4204-98d2-c516da192005",
"jobs_id": "b601d402-630e-4dbf-a3c3-2c741556c54d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0a9b1d0a-c9cc-4746-8c16-68acd061e57a",
"_parent_id": "29e0a345-a8cc-4c9b-946f-3804900c00cc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "36b4403a-30d8-4293-b7d8-caae2a48872a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "35200359-29d7-4ed6-9e39-ab12c30fa15a",
"_parent_id": "c5fd69e7-ac53-4b08-af86-6ee1d55e0435",
"root_parent_id": "d359d224-bd61-4aee-baf9-c9386180cd85",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "20dd481e-f033-4076-9af0-ed984839daec",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "97a8f5a5-b3b2-4b51-8403-0dd747427839",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1382451-64f4-4d0c-bba2-d9c5aaba14eb",
"_parent_code": "sample string 6",
"sales_organization_id": "d04250f3-ec49-4626-ab6e-1a413f9c0b8b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00"
},
"equipment_model_id": "26234f40-d2f9-4478-a1c2-3cc0d7a4fced",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a81cf3d0-a39f-4630-99dd-e3a50a488ae4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8b8f6c98-7a5b-42c4-8807-ef5b91c2f804",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "057bf500-f79f-452d-99af-602f9d0f0b51",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8d4de44f-aa32-4de0-b5db-ff03eae1731f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00"
},
"equipment_family_id": "a43bc7fd-29af-49f5-a108-b5459ff89e47",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "97a8f5a5-b3b2-4b51-8403-0dd747427839",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1382451-64f4-4d0c-bba2-d9c5aaba14eb",
"_parent_code": "sample string 6",
"sales_organization_id": "d04250f3-ec49-4626-ab6e-1a413f9c0b8b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00"
},
"date_in_production_since": "2026-08-27T19:02:12.6801884+00:00",
"date_out_of_production_since": "2026-08-27T19:02:12.6801884+00:00",
"date_end_support": "2026-08-27T19:02:12.6801884+00:00",
"sales_organization_id": "f0d6c689-0eec-4345-ad2d-4345d68c089a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+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-27T19:02:12.6801884+00:00"
},
"project_status_id": "6565ccb7-1400-457a-99e9-99ddfeafe228",
"project_status_code": "sample string 10",
"project_status": {
"id": "fcc59523-b722-4e09-952f-7c455ff213ad",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f0d3d426-5878-4efb-b86d-8d797fb0974e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00"
},
"company_id": "cefc8e78-4670-47a2-8165-2c69cdfbf340",
"company_code": "sample string 12",
"db_address_id": "64310bbf-e330-4505-8fa7-faf618dff1f1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00005e26-3ad8-4304-a441-5b35a8c09f59",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "97b8f522-f8ac-4826-ae4f-0190b74c714a",
"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-27T19:02:12.6801884+00:00",
"date_create": "2026-08-27T19:02:12.6801884+00:00",
"date_update": "2026-08-27T19:02:12.6801884+00:00",
"updated_by_user_id": "75b1740d-daf2-4676-bbb5-adcca42619df",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-27T19:02:12.6801884+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-27T19:02:12.6801884+00:00",
"date_last_job": "2026-08-27T19:02:12.6801884+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-27T19:02:12.6801884+00:00",
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00",
"is_mobile_installation": true
},
"job_type_id": "b6df3168-191d-449c-9966-1599563421e3",
"job_type_code": "sample string 7",
"job_type": {
"id": "892e8ca6-5575-44aa-8f61-29c10c04ecf8",
"name": "sample string 2",
"sales_organization_id": "f6ffac7a-61d1-4672-b576-0c9a92b8afa7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00",
"code": "sample string 7"
},
"job_priority_id": "8c10ce54-de48-46c1-85b6-cab1695d51a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "075fdba8-90e2-4ee4-93f4-3fd5c905a630",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5c092561-577d-43b0-a089-0bbe409ac903",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T19:02:12.6801884+00:00"
},
"job_status_id": "3cd9f82f-9627-4987-9ba4-1e0f85099db4",
"job_status_code": "sample string 11",
"db_address_id": "057f85ad-cd74-4d6d-bc61-a1ede010160e",
"contact_id": "00524fe5-19b7-43bf-8a9c-acaadf167871",
"requested_by_company_id": "0dc5c121-e46a-482b-9921-aa26d0535d24",
"requested_by_contact_id": "5fa2668a-ee61-467c-8241-8fe5c00bb98a",
"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-27T19:02:12.6801884+00:00",
"due_date": "2026-08-27T19:02:12.6801884+00:00",
"date_create": "2026-08-27T19:02:12.6801884+00:00",
"date_update": "2026-08-27T19:02:12.6801884+00:00",
"date_closed": "2026-08-27T19:02:12.6801884+00:00",
"suggested_user_id": "9082592d-50d3-4d71-b036-ae74ba599ec7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bc792e4d-46fe-4cf2-9e77-d8525c1c33be",
"db_language_id": "85833f2a-9329-4c80-9c36-c084b4833e9f",
"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-27T19:02:12.6958526+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "62a3b970-5bf9-431b-8113-dae4427b4098",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "22c590af-084f-45b4-bd40-46164c4d7393",
"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": "53986afb-ffb8-4e37-88c6-ac0daf130080",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-27T19:02:12.6958526+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dc02dd52-0a65-4cdc-b7f9-14d1103c734e"
},
"suggested_date_start": "2026-08-27T19:02:12.6958526+00:00",
"skill_id": "d479f28f-047d-443a-a69d-f6da9141a803",
"skill_code": "sample string 32",
"skill": {
"id": "92bb5ea9-bf24-4095-90cb-7a65be496bd1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a004b1b8-7c5d-4ebd-898e-34d8a0fe87e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4fe7ea7c-bd74-47fd-8d38-f309381528fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "870f421f-2c5d-4026-9e97-a38ddb364baf",
"db_currency_id": "f26f6114-51a7-4c3e-9c92-b505f580b244",
"db_language_id": "063170a6-47e6-4702-820a-6518b1a82fac",
"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-27T19:02:12.6801884+00:00"
},
"modified_dateutc": "2026-08-27T19:02:12.6958526+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0b6bb6d1-8645-4f9c-b8a1-ca8f6cf59194",
"date_reported_by_company": "2026-08-27T19:02:12.6958526+00:00",
"id2": 36,
"company_id": "515f8d69-0be7-497a-9f48-ab430cb6c5ab",
"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": "a9299148-7d75-431b-9e36-8db47710f1fc",
"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-27T19:02:12.6958526+00:00"
},
"work_instruction_details_id": "7c6d16c4-3bf0-40d3-a3ed-061394ada5a5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "29d69a0b-3403-483b-91fe-9376d537645b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "59b94e39-4c20-422a-809f-befc681c50e2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-27T19:02:12.6958526+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": "bda40c00-eb73-4fef-bc6d-d87e111dfd53",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-27T19:02:12.6958526+00:00"
}