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": "96ac9bb5-3037-469e-9bdd-06aa4e392d52",
"jobs_id": "6e814f09-4e1f-4562-8541-b403b80cea2e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ac745b1b-4300-48c0-a247-417e0f7ba29d",
"_parent_id": "2910a57c-29d7-4eaf-849c-84151032a089",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0083facd-f149-4c60-af85-28a9fc39bc9d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b6f07f32-bac0-45db-8144-62e52f768a63",
"_parent_id": "cad6edc4-65bf-4240-94ed-26ea3508b679",
"root_parent_id": "f245d1dc-0d6d-40bf-8928-5c83488105d1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cf5b619a-a974-4598-af8f-6352098ce994",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d0eb9533-ee54-4d25-9b64-4be58d30027c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2fc8cab-667d-42d6-89c1-126220301711",
"_parent_code": "sample string 6",
"sales_organization_id": "7db1de74-83c9-4cf9-ab3f-eafeed24f422",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
},
"equipment_model_id": "5bfefa15-0f61-47c0-ad17-b63d78c9bd49",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1918bd76-5209-45dd-a8b9-6df618de6d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c8d7c547-3dc0-4f50-8302-03e6c925e78e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "292f56e2-5251-4f71-b0d7-534577ea5f8d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3979fdce-27b9-4bb3-a8b4-4f2a562f7cd3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
},
"equipment_family_id": "7e1dfcdc-7b7e-4ea7-828b-276cb9711fee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d0eb9533-ee54-4d25-9b64-4be58d30027c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2fc8cab-667d-42d6-89c1-126220301711",
"_parent_code": "sample string 6",
"sales_organization_id": "7db1de74-83c9-4cf9-ab3f-eafeed24f422",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
},
"date_in_production_since": "2026-01-16T02:00:46.2840097+00:00",
"date_out_of_production_since": "2026-01-16T02:00:46.2840097+00:00",
"date_end_support": "2026-01-16T02:00:46.2840097+00:00",
"sales_organization_id": "7b039944-a117-4220-bccc-6b6ecca2c90e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+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-01-16T02:00:46.2840097+00:00"
},
"project_status_id": "c507b677-3c43-46d7-9c77-9a854c8ee24c",
"project_status_code": "sample string 10",
"project_status": {
"id": "f92d329e-b354-4a2c-a715-7d490b8b7434",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fe7496d9-a543-4c50-aa10-e7d26619326c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
},
"company_id": "19b0883d-fd1c-4dda-b573-a174e72fcee8",
"company_code": "sample string 12",
"db_address_id": "f1ae2eb5-0644-40e1-9459-a8685c92c3ff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1cedca80-d024-49f3-ac4e-8ab6fc723165",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "55258181-da33-4184-a94c-73d6025705c5",
"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-01-16T02:00:46.2840097+00:00",
"date_create": "2026-01-16T02:00:46.2840097+00:00",
"date_update": "2026-01-16T02:00:46.2840097+00:00",
"updated_by_user_id": "938a66e0-7865-47b8-9b4c-f40230da6030",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-16T02:00:46.2840097+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-01-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-16T02:00:46.2840097+00:00",
"date_last_job": "2026-01-16T02:00:46.2840097+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-16T02:00:46.2840097+00:00",
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00",
"is_mobile_installation": true
},
"job_type_id": "9a1faa46-119e-420b-b015-ae6acdc6365d",
"job_type_code": "sample string 7",
"job_type": {
"id": "033a5ba5-3445-437c-9e25-d2e1e2d3067e",
"name": "sample string 2",
"sales_organization_id": "e4f81475-d15c-4a3d-bae8-cf5216f0feb6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00",
"code": "sample string 7"
},
"job_priority_id": "3b1581ad-ab16-473b-aef1-01cc5cb98d70",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8682c5ae-e739-4a5d-8244-4df2d36cce3e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e7d22247-56ef-4489-8202-094781c716dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
},
"job_status_id": "4ae33f37-927d-40e0-967a-283057c3317d",
"job_status_code": "sample string 11",
"db_address_id": "2616c614-c17a-458c-8eee-1d07b098a329",
"contact_id": "85ef6c39-fd3b-4385-b2e3-40a0a4895917",
"requested_by_company_id": "722e402a-98d0-461b-9be5-99bdeb128943",
"requested_by_contact_id": "4fb16df3-3a42-4042-b590-1a5a2ebaec32",
"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-01-16T02:00:46.2840097+00:00",
"due_date": "2026-01-16T02:00:46.2840097+00:00",
"date_create": "2026-01-16T02:00:46.2840097+00:00",
"date_update": "2026-01-16T02:00:46.2840097+00:00",
"date_closed": "2026-01-16T02:00:46.2840097+00:00",
"suggested_user_id": "896b54e9-de1d-4f23-a660-f262475020ed",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "af6f6e31-02ea-429f-995d-59436e50d41d",
"db_language_id": "3b2510c6-ffd3-4d7a-9c37-89fda799fd0d",
"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-01-16T02:00:46.2840097+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ed60982e-e9ae-4489-873a-cfe6cdad01a4",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "50199c1b-e043-48dd-a19c-1febe11214be",
"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": "d49dc5b4-29a3-420d-a970-d0d5b3ae811f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9a548e5e-8d4b-4bb7-b02b-d8f68cd11d1d"
},
"suggested_date_start": "2026-01-16T02:00:46.2840097+00:00",
"skill_id": "ea95a846-f3e2-4637-a9da-149486d2fe1e",
"skill_code": "sample string 32",
"skill": {
"id": "96f5b0f2-82e5-4f25-b1c8-8fb1a2c09db7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0a78c992-9d82-4098-a9d0-8202fcbe2c3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb281b78-6b58-458a-88f4-f569c6383237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126c22d5-e5a8-4f91-82fe-678c85caca09",
"db_currency_id": "58cfa7d1-96c9-4545-83d6-d25dc1848b21",
"db_language_id": "f0a663cd-f9a0-4ee5-8bdd-137aa711f7f9",
"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-01-16T02:00:46.2840097+00:00"
},
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dd89cc13-e405-4115-8de2-0f371c9a0a64",
"date_reported_by_company": "2026-01-16T02:00:46.2840097+00:00",
"id2": 36,
"company_id": "3719a5ac-38fa-4127-bff5-62c3ee37c6ac",
"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": "7d9f8841-2f31-44b6-a2b7-354710025935",
"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-01-16T02:00:46.2840097+00:00"
},
"work_instruction_details_id": "85cf3335-6a13-4382-8f5e-2573984be61a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c2c6686a-284a-4a1d-8298-77ee587bf9fb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6b420658-d6a6-4204-abf3-31596c1f4deb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-16T02:00:46.2840097+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": "81194f0e-77b7-4b36-93dc-f7102b854eaf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-16T02:00:46.2840097+00:00"
}