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": "9a6ca772-ef1b-4cb0-937e-ae7d0447d181",
"jobs_id": "aa612ca1-8613-4f99-8f7f-fbcd3c7091a2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8a4baf27-b274-4e05-9653-053f09b889ad",
"_parent_id": "4a4e0331-d6cc-40be-9db1-9fa3f3f87264",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dcb2848e-9988-4843-bb66-a5b36ae9b54c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e935377e-d44a-4239-bccd-3b362cafc919",
"_parent_id": "09e1b2a1-56f7-497b-8385-4e29071f7115",
"root_parent_id": "f6607718-9c10-431d-8220-f0fc5af9e7ba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2c877428-8ec1-4c89-a109-ae9ec8a1f1b2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1a83a163-5c8c-4ffa-9eae-8b044eb4320c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d317a3d8-1483-4ff3-9ee6-542003eaa1d1",
"_parent_code": "sample string 6",
"sales_organization_id": "45a39004-3cc9-4ddb-b4d1-b590a519caa2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
},
"equipment_model_id": "772ceb7d-9f59-4e28-9864-fb12eaf7bd8e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9d238dda-3ba8-4a72-8ad2-ca2fc597a1b6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "98340205-69c3-4c52-b1df-b2fc13884763",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8979d26c-054b-4ab8-8984-b0b164125021",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a5110d90-b149-4e15-9158-5c17b559effb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
},
"equipment_family_id": "f122f1de-eec7-4017-aee8-d3fbb72c3a82",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1a83a163-5c8c-4ffa-9eae-8b044eb4320c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d317a3d8-1483-4ff3-9ee6-542003eaa1d1",
"_parent_code": "sample string 6",
"sales_organization_id": "45a39004-3cc9-4ddb-b4d1-b590a519caa2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
},
"date_in_production_since": "2026-08-20T21:15:02.8715577+00:00",
"date_out_of_production_since": "2026-08-20T21:15:02.8715577+00:00",
"date_end_support": "2026-08-20T21:15:02.8715577+00:00",
"sales_organization_id": "fd11e9a5-da2d-49e9-9521-b3cfa1573d0a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+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-20T21:15:02.8715577+00:00"
},
"project_status_id": "bc7b6b39-d320-4a0f-a018-1b2cbc7e5656",
"project_status_code": "sample string 10",
"project_status": {
"id": "4dae8160-15c9-4846-bdda-067e73ea8ac9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ee10a94b-b5d5-49d8-be59-3dc7d7b10587",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
},
"company_id": "fd3919c4-a0ba-4756-b5d3-b5016168e126",
"company_code": "sample string 12",
"db_address_id": "fe12a149-65d9-4306-9287-001fd18385c1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "495463ec-c143-4894-9b4e-7cd6bcb97eb1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e139bb9b-d192-46b7-bba5-b2595642a7fd",
"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-20T21:15:02.8715577+00:00",
"date_create": "2026-08-20T21:15:02.8715577+00:00",
"date_update": "2026-08-20T21:15:02.8715577+00:00",
"updated_by_user_id": "b2d73f72-0cc4-465a-a9e6-e89ada6f7fd0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-20T21:15:02.8715577+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-20T21:15:02.8715577+00:00",
"date_last_job": "2026-08-20T21:15:02.8715577+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-20T21:15:02.8715577+00:00",
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00",
"is_mobile_installation": true
},
"job_type_id": "c5de471a-8355-4c5b-9b4b-8e049172eb36",
"job_type_code": "sample string 7",
"job_type": {
"id": "bc4a04c3-5021-4e8b-8182-119260636a9f",
"name": "sample string 2",
"sales_organization_id": "3424e4fb-8716-4247-ae10-60a4012e8d6c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00",
"code": "sample string 7"
},
"job_priority_id": "6508984f-1570-4c1c-b9ba-a0a8db7be8ec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1a199fa1-2868-4f1d-9745-d2ca3a6e0617",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0567365e-1235-46c1-97dd-cacc9162ce5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
},
"job_status_id": "79751bb0-ff71-4f98-a83d-1ca266bb9d87",
"job_status_code": "sample string 11",
"db_address_id": "6824f8ce-7243-4ee1-bec7-7389ca877593",
"contact_id": "9520c24b-18a4-4110-9e15-cc87d155e3c6",
"requested_by_company_id": "a9824c00-6d4f-47f0-b1e1-0bffa9225938",
"requested_by_contact_id": "91dcc997-cdd6-4994-aa39-0e3199439441",
"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-20T21:15:02.8715577+00:00",
"due_date": "2026-08-20T21:15:02.8715577+00:00",
"date_create": "2026-08-20T21:15:02.8715577+00:00",
"date_update": "2026-08-20T21:15:02.8715577+00:00",
"date_closed": "2026-08-20T21:15:02.8715577+00:00",
"suggested_user_id": "56232562-1e1a-4374-9e97-6d93344bb139",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6a5d7df3-e3ee-4839-829d-3bd532eb30e8",
"db_language_id": "4fa7811c-ed22-4f5d-b1fa-a1da05e66fc4",
"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-20T21:15:02.8715577+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0f90c2bd-6e9d-4a90-a6a5-78365afacfc6",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6649c841-42e8-4193-b28b-0174a30c9ecc",
"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": "b072edd8-0a7c-472b-9d71-18e0e7896c30",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d0c12d56-14d5-4ecb-be2c-2a8106157de0"
},
"suggested_date_start": "2026-08-20T21:15:02.8715577+00:00",
"skill_id": "36c78565-ae9a-474e-8460-ec5fbd9a201c",
"skill_code": "sample string 32",
"skill": {
"id": "4de51cfd-551c-43c9-8da7-fbd455f9d979",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "95ee9082-5684-427d-acd2-39c46f0e56be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29bea83c-4980-4fd9-b0fa-d3ce2699eedc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "756c1950-f619-4829-a4c8-ac62145b5ca8",
"db_currency_id": "a0287ef1-4fd2-479e-a1e3-880828cca3de",
"db_language_id": "673f01d4-c538-4fe5-9024-84a31a24e0de",
"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-20T21:15:02.8715577+00:00"
},
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "046c6e72-3e3e-4879-ac77-ca319244912b",
"date_reported_by_company": "2026-08-20T21:15:02.8715577+00:00",
"id2": 36,
"company_id": "42aaa9f5-9afc-4d3b-a959-c7454d5e0a8f",
"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": "eb1e6c77-5acc-4740-93a9-fb674d54cdde",
"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-20T21:15:02.8715577+00:00"
},
"work_instruction_details_id": "be20187f-615d-4e32-ab95-2ea4c36fc7e8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2169ca7b-89ae-4766-8879-e79f54383285",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "25d0a504-bb65-490f-8f46-14ed724e0974",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-20T21:15:02.8715577+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": "e9f556a5-737f-4436-9d14-38332a9ffee4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-20T21:15:02.8715577+00:00"
}