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": "2b45d229-2af3-467c-a950-7572039db8bb",
"jobs_id": "1d33f77b-f224-43b6-baec-9fcb88fcd90d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c74f105d-ab75-48e4-9c71-fea8aaebed12",
"_parent_id": "4c203b96-df0a-4efa-a140-1f4262f27693",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "263a3b8e-4eb6-4451-a375-5487ba777bf7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "43e19d48-800e-47a7-87fd-86518698f674",
"_parent_id": "94342b49-b2aa-4891-bc5f-8bc5c086da41",
"root_parent_id": "8bebc1e8-6800-4dcf-ada5-294e64028fdb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "06209fb3-78a2-4961-a0c8-17ca0334ff90",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dfc51971-7d0d-49f4-9d1b-b7aff35e38c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "45f0e34f-769d-4a6e-bec3-b766a7191d2b",
"_parent_code": "sample string 6",
"sales_organization_id": "24280da9-ac61-4781-88f5-de1eea32778a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
},
"equipment_model_id": "ab29f3d4-88e9-4bda-8694-d83efe3150b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "01bb2bad-1eb5-4da3-bce9-23d9bfd8b1a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c17c735c-5f3f-44bd-a407-6996812c823d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "44e5809b-fdc9-4588-98d4-97eb1ef9363f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "696f5fdb-842b-417a-985c-670931a853b4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
},
"equipment_family_id": "d5941282-eee5-4a37-ab7b-83ddd431d123",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dfc51971-7d0d-49f4-9d1b-b7aff35e38c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "45f0e34f-769d-4a6e-bec3-b766a7191d2b",
"_parent_code": "sample string 6",
"sales_organization_id": "24280da9-ac61-4781-88f5-de1eea32778a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
},
"date_in_production_since": "2026-05-17T19:43:48.0429734+00:00",
"date_out_of_production_since": "2026-05-17T19:43:48.0429734+00:00",
"date_end_support": "2026-05-17T19:43:48.0429734+00:00",
"sales_organization_id": "41a64be9-fc9f-47f2-8494-fcf0c4b7ffda",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+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-17T19:43:48.0429734+00:00"
},
"project_status_id": "9372d770-c132-47ee-892c-16f689599197",
"project_status_code": "sample string 10",
"project_status": {
"id": "c669a080-fdeb-4457-80db-4f5e9f189db0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "64cf401c-db65-4376-a594-1af74804cd31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
},
"company_id": "3bd5dbe0-2dce-45b7-8259-1d9173724a6b",
"company_code": "sample string 12",
"db_address_id": "3708a318-0ca3-4dab-a814-a1eaee9247a5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cdeb26a0-1b09-4974-bcba-c7f733010a1d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "096b1715-c8c1-4ea0-b399-3476e68cee7a",
"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-17T19:43:48.0429734+00:00",
"date_create": "2026-05-17T19:43:48.0429734+00:00",
"date_update": "2026-05-17T19:43:48.0429734+00:00",
"updated_by_user_id": "c17330b0-0cf4-436a-8009-7eaf0a94e0cc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-17T19:43:48.0429734+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-17T19:43:48.0429734+00:00",
"date_last_job": "2026-05-17T19:43:48.0429734+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-17T19:43:48.0429734+00:00",
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00",
"is_mobile_installation": true
},
"job_type_id": "61e0264f-512e-4a93-be0d-b8312f07a322",
"job_type_code": "sample string 7",
"job_type": {
"id": "568a754c-bc82-4a5f-8b72-2e1364454eea",
"name": "sample string 2",
"sales_organization_id": "3a1fc0a1-8b32-40b5-979e-2e74d7d4c14a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00",
"code": "sample string 7"
},
"job_priority_id": "aa418c01-d73c-4408-bbb9-14420929254c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d28817ad-2b48-4783-a01d-917de5c73d57",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "17878193-cce7-43e0-91ea-5da67c24734e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
},
"job_status_id": "f1454572-eab0-4ad9-bf9c-45064565e7b6",
"job_status_code": "sample string 11",
"db_address_id": "b520d6a4-dd23-4465-a600-8632679ee1a8",
"contact_id": "3211eff2-e0bc-4730-973a-ab45294d4c1e",
"requested_by_company_id": "8dd562af-82d3-4a4f-a489-9b995dbe1fac",
"requested_by_contact_id": "e9a47518-78aa-4a2b-bc11-1090e32e73b7",
"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-17T19:43:48.0429734+00:00",
"due_date": "2026-05-17T19:43:48.0429734+00:00",
"date_create": "2026-05-17T19:43:48.0429734+00:00",
"date_update": "2026-05-17T19:43:48.0429734+00:00",
"date_closed": "2026-05-17T19:43:48.0429734+00:00",
"suggested_user_id": "acafe4b4-d1e0-44de-ac52-7797cd50747b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fceb7354-ce32-494e-95a8-42ddec51d9be",
"db_language_id": "3ff303c6-6e94-467e-a7b5-3e432da5507f",
"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-17T19:43:48.0429734+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4121a44f-42a7-4ea5-ad3f-029379cf9387",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fe2dd638-f9ba-4b51-b451-a73c0fddbeba",
"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": "a2526b48-f4c9-4a2b-a650-3506ca147c37",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e624a343-c23a-4512-852d-ad61d690f0d2"
},
"suggested_date_start": "2026-05-17T19:43:48.0429734+00:00",
"skill_id": "70b1b384-30af-4687-8607-6466983c1c19",
"skill_code": "sample string 32",
"skill": {
"id": "753769f7-8939-4595-9347-5747b5dd284b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "65bc091c-1626-47a3-8cc4-c75e75ae9315",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18fba90c-b7f3-4cdc-8921-e49449f7a1aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "10f7403c-3b64-4386-bc62-fab7543fb194",
"db_currency_id": "559e464d-d3c0-4734-af71-6e2e4c2f257a",
"db_language_id": "52bdbf3b-ac60-46d2-bd20-699b46ee0905",
"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-17T19:43:48.0429734+00:00"
},
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ac42808e-2c40-4f7b-a4a6-cb482578928d",
"date_reported_by_company": "2026-05-17T19:43:48.0429734+00:00",
"id2": 36,
"company_id": "091bd7e7-9946-44b4-a749-5fc47746f5b3",
"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": "4bfbfcee-5ddf-4994-9a9d-825b8cbfcf21",
"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-17T19:43:48.0429734+00:00"
},
"work_instruction_details_id": "1daac963-df95-41c7-bdfd-53694a179d4f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1e802830-cdda-4c99-bd6f-3715e0ec57cf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0ad037b2-d979-4281-952b-a4cc36c106cd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-17T19:43:48.0429734+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": "75426aef-2b5b-439d-9c57-44d17cec9f54",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-17T19:43:48.0429734+00:00"
}