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": "7adcf3f5-a44e-4787-a287-0971c0a58808",
"jobs_id": "5e6dbcec-0f9b-4562-9057-b312e2446fe0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "117e6638-8dbe-4605-b498-127c296f5e4a",
"_parent_id": "a0240d20-a0f2-424b-b166-c4fa61f59974",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "17a3ee17-1851-4a1d-a698-a2d7035b3aa5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "82a521a9-a82f-4573-b099-8b15bd8321ed",
"_parent_id": "645c26db-2651-4d12-90e2-6129effb71d4",
"root_parent_id": "d5a7ed3f-e526-4591-a934-a38894febb94",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fb0aded8-7d70-4c13-bad4-f581c3558eb7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6c32ed77-ab85-415b-b2e6-b91cbf347eb4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1e6fa91-8ffc-4dd8-89c3-380d086f9e24",
"_parent_code": "sample string 6",
"sales_organization_id": "e26b515f-4084-4c5d-8c82-90e69c103372",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"modified_dateutc": "2026-02-15T14:20:42.9385971+00:00"
},
"equipment_model_id": "0c5b6ff7-fef8-413d-bd42-04443aa8cf4f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "edb580af-019a-4f1a-a516-0c633dc2fe52",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2dd924a7-d113-4532-91d0-67c6f95c4145",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9bd4d361-6ea2-4b1e-95fd-c21802db3d97",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "43f5c455-c649-4550-8670-df5a9fa21168",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"modified_dateutc": "2026-02-15T14:20:42.9385971+00:00"
},
"equipment_family_id": "540b704e-d2ae-4bb0-a68f-ae960b4e5ff1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6c32ed77-ab85-415b-b2e6-b91cbf347eb4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1e6fa91-8ffc-4dd8-89c3-380d086f9e24",
"_parent_code": "sample string 6",
"sales_organization_id": "e26b515f-4084-4c5d-8c82-90e69c103372",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"modified_dateutc": "2026-02-15T14:20:42.9385971+00:00"
},
"date_in_production_since": "2026-02-15T14:20:42.9385971+00:00",
"date_out_of_production_since": "2026-02-15T14:20:42.9385971+00:00",
"date_end_support": "2026-02-15T14:20:42.9385971+00:00",
"sales_organization_id": "f3914b14-cd82-4572-b5ee-d96b86ed7d77",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+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-02-15T14:20:42.9542231+00:00"
},
"project_status_id": "1b177c38-ea00-42b3-8f47-923b9b7a9d54",
"project_status_code": "sample string 10",
"project_status": {
"id": "5371c6ea-d25c-4712-8e13-92a87cc2fd99",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "87a7a286-74b5-44e2-94df-c64f242e1034",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00"
},
"company_id": "cbd70434-61d9-443d-8ac6-294291a7f5cb",
"company_code": "sample string 12",
"db_address_id": "cc1876ac-03c5-4eb8-8155-947b1a87eaf1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5fe49283-829b-4157-8b4c-f6fc6888c4eb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "039fad01-cb77-4dc4-bdee-1f8b9c389dc3",
"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-02-15T14:20:42.9542231+00:00",
"date_create": "2026-02-15T14:20:42.9542231+00:00",
"date_update": "2026-02-15T14:20:42.9542231+00:00",
"updated_by_user_id": "5ea9a8d2-a71c-4bba-b520-82139fe067c9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-15T14:20:42.9542231+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-02-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-15T14:20:42.9542231+00:00",
"date_last_job": "2026-02-15T14:20:42.9542231+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-15T14:20:42.9542231+00:00",
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00",
"is_mobile_installation": true
},
"job_type_id": "1887e8fd-af46-4019-8748-5118e45ab8f7",
"job_type_code": "sample string 7",
"job_type": {
"id": "bad3019f-6a4e-4871-a7dd-5122f3b55d69",
"name": "sample string 2",
"sales_organization_id": "34f019b0-ab44-4f29-9b7b-3c2c8e6226b9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00",
"code": "sample string 7"
},
"job_priority_id": "1de94302-779d-42b7-8f77-02555762ee1c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "75d15f03-016e-4d06-8f31-dfb2edb16da3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4f5b69d5-d189-410a-91f2-3157cbae140a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00"
},
"job_status_id": "357b85a7-7fce-42f4-841c-d365e19b452b",
"job_status_code": "sample string 11",
"db_address_id": "cea61c05-953c-420a-9961-59fe8b994d5b",
"contact_id": "c4f0d491-355f-43fc-a285-d9515e85086e",
"requested_by_company_id": "7f681240-e1dd-44b3-9e0e-03fe038e4ac6",
"requested_by_contact_id": "9a7ac62e-0ca1-4b84-981b-78ac15f5b97e",
"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-02-15T14:20:42.9542231+00:00",
"due_date": "2026-02-15T14:20:42.9542231+00:00",
"date_create": "2026-02-15T14:20:42.9542231+00:00",
"date_update": "2026-02-15T14:20:42.9542231+00:00",
"date_closed": "2026-02-15T14:20:42.9542231+00:00",
"suggested_user_id": "b0435f28-f09d-4f4d-999e-3f1e547e46dc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cc528650-037e-4ac0-ad57-60f21f7dc3d8",
"db_language_id": "894d3750-ec39-4950-bfcb-68679000dc2f",
"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-02-15T14:20:42.9542231+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "df8f0e8d-dee1-4cea-acde-c3d8cd635ef7",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "66c642d7-9cc2-4006-91ea-2798ff1ec6ca",
"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": "10b9d319-270e-4eec-a7ee-915af1ee0d6a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "83d5c0cb-32c3-4fe4-bdc5-83a8f2d06b77"
},
"suggested_date_start": "2026-02-15T14:20:42.9542231+00:00",
"skill_id": "91353ee5-4820-41ee-9393-cac5db5616c9",
"skill_code": "sample string 32",
"skill": {
"id": "48c8ca64-83b2-4f9e-bb80-acf7c52cf623",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "36440fb8-a491-4e6a-b87d-a6312a6f5a06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd721cfa-f941-4f35-8cb2-43ad11a1d4ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "536d8472-a10b-4004-a8a7-5581e645c1c7",
"db_currency_id": "bc5d0f6d-acd5-436d-8977-edade9039609",
"db_language_id": "9f8e572d-0c1d-420c-8e01-886b2160eca1",
"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-02-15T14:20:42.9385971+00:00"
},
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "62cb18e8-acb0-44ca-bfc9-aec16b6032a2",
"date_reported_by_company": "2026-02-15T14:20:42.9542231+00:00",
"id2": 36,
"company_id": "2db7cd10-477a-4ea0-9376-e333782bacbd",
"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": "e15f7e09-bf6f-4fee-b56e-d2e331bb424a",
"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-02-15T14:20:42.9542231+00:00"
},
"work_instruction_details_id": "fd623aee-347e-4587-8eda-ae37737e6952",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "66d54931-e51b-4d5a-b080-2a57260e096d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9bb11d42-a038-45bc-a341-add59bc0127a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-15T14:20:42.9542231+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": "19a7f271-d5ad-43b3-aa16-e66e6563b41d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-15T14:20:42.9542231+00:00"
}