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": "7431fb99-2e78-4aba-bb08-6fcdc2f9990e",
"jobs_id": "d4a8cff4-e7e3-49bf-aa1f-9bee6e22510c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8bf2f3cc-1cb3-4c6e-abb3-1e038715135e",
"_parent_id": "3e27823e-22cb-489e-bc3d-056831280155",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eef358a7-4fd7-4bc6-9193-1e074429ed88",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0be36f62-15c0-4890-8a39-137b58cda990",
"_parent_id": "f4c2dd0f-363b-4db8-88f4-162e988cbb5c",
"root_parent_id": "938e3cce-567e-4b11-ab9c-327ed86c6889",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6e845d92-d963-43ae-8b87-4353793d729d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ea629ce3-7145-443d-806c-02502daf4062",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d91075b-16db-458e-877b-8667855ac667",
"_parent_code": "sample string 6",
"sales_organization_id": "4afaffce-d5f5-4634-90e7-17f16bf0c9ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
},
"equipment_model_id": "12c1ae20-d5f5-4717-b1aa-72e2eb277f7a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ec8be950-35cd-4796-a2b9-eb50d2147082",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e927e57a-d6e4-40be-92d0-c33866674104",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8a47ede0-db3c-4c00-a0d0-b9ea9196fe73",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0d466f18-b73e-44fc-8430-f5a56de1775d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
},
"equipment_family_id": "2c310c79-8f12-426b-b335-e74c8a45a9ba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ea629ce3-7145-443d-806c-02502daf4062",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d91075b-16db-458e-877b-8667855ac667",
"_parent_code": "sample string 6",
"sales_organization_id": "4afaffce-d5f5-4634-90e7-17f16bf0c9ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
},
"date_in_production_since": "2026-11-12T09:55:50.3752583+00:00",
"date_out_of_production_since": "2026-11-12T09:55:50.3752583+00:00",
"date_end_support": "2026-11-12T09:55:50.3752583+00:00",
"sales_organization_id": "a05e67f1-ee4a-4a83-b18a-c8575d55c749",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+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-11-12T09:55:50.3752583+00:00"
},
"project_status_id": "487c4741-e67e-414b-a3cd-bb565bbba817",
"project_status_code": "sample string 10",
"project_status": {
"id": "60be373a-abfc-462a-aff0-498064c1691a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "24eb0e4e-a3d7-4fa2-bf76-e3f1da22f30e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
},
"company_id": "80d21b35-4c53-4615-a13d-9b8e29ffc118",
"company_code": "sample string 12",
"db_address_id": "a2c7f0a4-6063-44a6-a9c4-00acc6f424a1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb3f8a40-fb59-43df-b6f2-c9a73a2c0e56",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94d3806f-b602-4722-9705-cdb6508f056b",
"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-11-12T09:55:50.3752583+00:00",
"date_create": "2026-11-12T09:55:50.3752583+00:00",
"date_update": "2026-11-12T09:55:50.3752583+00:00",
"updated_by_user_id": "b54d4b5a-f7c4-471d-86c2-939401cb8083",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-12T09:55:50.3752583+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-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-12T09:55:50.3752583+00:00",
"date_last_job": "2026-11-12T09:55:50.3752583+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-12T09:55:50.3752583+00:00",
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00",
"is_mobile_installation": true
},
"job_type_id": "e2eace1e-dfde-4012-88e4-821f527c1f71",
"job_type_code": "sample string 7",
"job_type": {
"id": "f3bafa07-f39e-428e-a67d-14b45ca70529",
"name": "sample string 2",
"sales_organization_id": "85659f0c-8d84-4f5d-9584-28f45991f99a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00",
"code": "sample string 7"
},
"job_priority_id": "6e81d4e0-d2e1-4e2e-9214-358e351e5c8d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c7af8ae0-9517-474a-9944-4af4676e2171",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fce52a83-ecd7-4122-9977-cc95680843d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
},
"job_status_id": "9c965874-548c-48eb-b057-2344e734b617",
"job_status_code": "sample string 11",
"db_address_id": "e23142cc-0d1f-480f-badf-1b5c6517415f",
"contact_id": "a20e1138-63e7-4c04-83b1-5093faa4ae87",
"requested_by_company_id": "75480f56-251f-4e32-8e52-d6dbfea138fc",
"requested_by_contact_id": "9911193a-6f5b-47a1-b8c2-23d0e4a490f8",
"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-11-12T09:55:50.3752583+00:00",
"due_date": "2026-11-12T09:55:50.3752583+00:00",
"date_create": "2026-11-12T09:55:50.3752583+00:00",
"date_update": "2026-11-12T09:55:50.3752583+00:00",
"date_closed": "2026-11-12T09:55:50.3752583+00:00",
"suggested_user_id": "8fe57765-901a-4e2e-8563-17020a69680b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "96c67c6e-f065-4463-85f0-24366dc5e96f",
"db_language_id": "e8173976-7bfa-4293-81e4-9836dde47a1b",
"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-11-12T09:55:50.3752583+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1bccd645-4105-42c4-9dc8-4e756aae805a",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "47d9bbe4-df05-419c-902a-b3bdfd20eaf3",
"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": "04e36b50-7ff9-42c3-aa23-7c9c1db421fa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "81cba36a-1fd5-469c-85d1-507c5b36e179"
},
"suggested_date_start": "2026-11-12T09:55:50.3752583+00:00",
"skill_id": "38262513-578e-4bc1-9a47-0921e4081f4e",
"skill_code": "sample string 32",
"skill": {
"id": "fdd33728-380a-4641-af76-728d3f4add2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5f828107-2fc3-45ac-84d0-0e186bfda6ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42ccf1aa-a5c9-48f8-868f-c0e196ff06b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a18de0d1-d706-4943-8ab0-8a35e8db651f",
"db_currency_id": "0ce228e8-bb7d-4c52-85e0-f849a7aba3cf",
"db_language_id": "30f16cbe-ddca-4cbd-b119-310154edb432",
"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-11-12T09:55:50.3752583+00:00"
},
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "54f2c513-dfee-4ae5-9d02-952d4f1326ed",
"date_reported_by_company": "2026-11-12T09:55:50.3752583+00:00",
"id2": 36,
"company_id": "c360c7db-3675-4d19-8499-a8a5cf905588",
"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": "f9b88aba-03bb-4309-b1db-162d5ad22ba7",
"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-11-12T09:55:50.3752583+00:00"
},
"work_instruction_details_id": "e0062d70-0f8a-49ea-afa2-b7fb9ea70f43",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "978a424a-2829-4c3b-95f3-257652c8d83e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5a92becb-fa54-48ba-9c79-ebdeb11274b6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-12T09:55:50.3752583+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": "05d006e2-eb55-428b-8e22-fc672a527e7b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-12T09:55:50.3752583+00:00"
}