Updates 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 :
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 |
Request Formats :
application/json, text/json
Sample:
{
"id": "c2f3f491-f761-40d6-9637-6d57a647f5b0",
"jobs_id": "3d2f6202-a43e-43ae-9662-7d9f5247f3de",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "67a539af-29d8-4ea3-b6ba-b4bbbdaae1d5",
"_parent_id": "fe683ee6-87a5-44fb-8214-212b3893f56b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ddda5c40-cf91-4a66-ad7d-3af3dc287d5d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3601da8f-7856-4651-a46b-ec4e8f5a49ef",
"_parent_id": "69d064f8-3947-4f99-995e-14db96721697",
"root_parent_id": "44404d53-b86f-4b3a-9a82-afd5cbdb883d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d8b0661f-0177-452e-b4e3-d43966afcee7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "322971c1-0b48-4172-b68f-e35c0210ac0e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "95203a47-4c40-4e90-b590-91216e948968",
"_parent_code": "sample string 6",
"sales_organization_id": "1a756bb6-8feb-4a75-b72b-92e80cf065bd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
},
"equipment_model_id": "11c26f4f-685a-4d28-a2a4-76b9a5682ba6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2d708b9a-03f7-4a6b-8017-94017577ea91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "57586b1d-c6c0-4fd3-9e0d-c7e574c2f9a5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d4ca40f1-bbd6-4562-9abd-691f3ba5f6aa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "21e8b089-ae1e-439b-88f3-8b3599917dcc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
},
"equipment_family_id": "da79b2f2-6cfd-4fa4-83ad-01532dbb7316",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "322971c1-0b48-4172-b68f-e35c0210ac0e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "95203a47-4c40-4e90-b590-91216e948968",
"_parent_code": "sample string 6",
"sales_organization_id": "1a756bb6-8feb-4a75-b72b-92e80cf065bd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
},
"date_in_production_since": "2026-09-03T09:13:28.538912+00:00",
"date_out_of_production_since": "2026-09-03T09:13:28.538912+00:00",
"date_end_support": "2026-09-03T09:13:28.538912+00:00",
"sales_organization_id": "cede8b80-01e6-46d6-8ef2-48919d100747",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+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-09-03T09:13:28.538912+00:00"
},
"project_status_id": "83c779ca-943e-4e1f-9a76-300a9fba1b7e",
"project_status_code": "sample string 10",
"project_status": {
"id": "067a458b-1f94-4d43-acaa-53b8d7f86043",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "53e8772c-e21e-4f5e-94a0-fe093dbdc9f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
},
"company_id": "e5a01f00-9996-4412-94e9-7aa3a961d6e1",
"company_code": "sample string 12",
"db_address_id": "372f7f9d-6d97-4251-b90f-44a3524c2b78",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9c224b08-89dd-4f2e-8481-2ead2de23788",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4544438b-b4d2-4d1e-b262-55d3b9fed251",
"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-09-03T09:13:28.538912+00:00",
"date_create": "2026-09-03T09:13:28.538912+00:00",
"date_update": "2026-09-03T09:13:28.538912+00:00",
"updated_by_user_id": "832a0bf3-2be4-40a2-bc32-ec54993dd04f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-03T09:13:28.538912+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-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-03T09:13:28.538912+00:00",
"date_last_job": "2026-09-03T09:13:28.538912+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-03T09:13:28.538912+00:00",
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00",
"is_mobile_installation": true
},
"job_type_id": "7f6723b9-1427-41b5-aab4-b8660b09d4e6",
"job_type_code": "sample string 7",
"job_type": {
"id": "6c388069-a06a-4a5f-a5ef-ae1190b99e91",
"name": "sample string 2",
"sales_organization_id": "979faf37-ab13-4703-87d3-945c7eaee863",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00",
"code": "sample string 7"
},
"job_priority_id": "4ec5aaae-24dd-45f8-8f52-ff2c34bb52e4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d2e24758-12c2-41d5-ab6b-f77a68a05b93",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "de4aad3e-f152-4c85-8b79-9eaadf3cde05",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
},
"job_status_id": "4d8e0a79-7b62-4c2b-b052-2872ae761a98",
"job_status_code": "sample string 11",
"db_address_id": "e6ed8653-fb7b-42ed-9974-4bd70822939b",
"contact_id": "02e10fc3-daf5-46f2-b6dc-95ee0b669074",
"requested_by_company_id": "5250f62c-5032-4574-bc77-cf163b63467c",
"requested_by_contact_id": "ff207449-5d67-4910-9ff5-071ce1a6b233",
"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-09-03T09:13:28.538912+00:00",
"due_date": "2026-09-03T09:13:28.538912+00:00",
"date_create": "2026-09-03T09:13:28.538912+00:00",
"date_update": "2026-09-03T09:13:28.538912+00:00",
"date_closed": "2026-09-03T09:13:28.538912+00:00",
"suggested_user_id": "975b3d68-4b49-4efb-a5bf-cfeef4116661",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68290abe-4c48-4162-8100-5cbb21c25fb8",
"db_language_id": "a6c6eceb-43af-4945-bdc9-5314de779fdf",
"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-09-03T09:13:28.538912+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1640bdd9-29e5-417f-8894-7447109209e9",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9274f186-3a17-4e0a-bada-ffd88ab8c6a7",
"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": "d98b45ca-8682-4a7a-ad19-9484b7bc4352",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1eecbcd8-0dd8-476c-9908-2045a3043f51"
},
"suggested_date_start": "2026-09-03T09:13:28.538912+00:00",
"skill_id": "cbf0f441-b23c-480e-8fef-bb4db7aee463",
"skill_code": "sample string 32",
"skill": {
"id": "04e43ecc-0413-4ae5-9158-70344453e953",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1fff9cb5-bb37-4bd8-91e3-9544cb11c1e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "08ec7f33-7c37-4ce3-934c-3c8f981355e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c317710a-af93-4e7f-9299-00e42016ba65",
"db_currency_id": "48234fbf-2ad0-4226-90a9-1132fe011cfb",
"db_language_id": "e149d387-fc46-4ea8-9307-28fbda682bab",
"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-09-03T09:13:28.538912+00:00"
},
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "17e3fe4f-939e-4956-a6c5-dc9c4cc8a398",
"date_reported_by_company": "2026-09-03T09:13:28.538912+00:00",
"id2": 36,
"company_id": "c11c0081-3423-4e07-b2dc-e08cdcfb9ff6",
"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": "6758aec5-5d00-4043-afaf-cc96fc048f35",
"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-09-03T09:13:28.538912+00:00"
},
"work_instruction_details_id": "43e327ff-252f-48b0-a380-0a9ccea2e958",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7fed684e-78be-43fb-bfb4-5c57ffe513d5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fb6a69fb-05bf-43ab-b79c-0cd14dbc7fb1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-03T09:13:28.538912+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": "a32cda45-1ff7-44e5-aaa1-ce75b1ed0e6a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-03T09:13:28.538912+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.