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": "2f9ff5fa-1ee7-4a4c-b889-8da2f80266fe",
"jobs_id": "87374160-fe89-411b-ae1d-15bf7af94265",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7feabbe4-5e65-4abf-92f0-36dc5d57c45b",
"_parent_id": "b0d7f867-280c-4fd1-b798-8bb9b4a83f3f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a1032500-2d58-499d-bf07-c1f53a5f9115",
"project_reference_back_office": "sample string 5",
"project": {
"id": "633f281e-fa83-4f34-881a-e64f9a5ecb72",
"_parent_id": "348583f8-5448-4ee9-a9cf-95b4d6c9b2e2",
"root_parent_id": "e556d186-bf05-4d19-99d7-cbc6c5d64451",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "156faed8-2667-4dfc-8979-d685f8eab555",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b09ccbd7-6540-4db5-8fa7-2b082306086b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "137c82b6-9e6a-43ee-ab7e-424e90222de0",
"_parent_code": "sample string 6",
"sales_organization_id": "7838be40-7c5a-4404-b42a-390660c61d15",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
},
"equipment_model_id": "f6ebfb69-b8e7-4ada-9f29-daf8324ded82",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "362d676b-e16d-4bbb-bf0e-7fdf6beb025a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "db8bcb78-0e66-4c44-88f0-12bdf6d3d322",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eb6ac5f1-e1fa-4844-863a-649e67d2c431",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2a37bf1c-2642-4c51-ab52-74390987d24d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
},
"equipment_family_id": "c8b3089d-8f4e-4557-817f-59b3e0e78e11",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b09ccbd7-6540-4db5-8fa7-2b082306086b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "137c82b6-9e6a-43ee-ab7e-424e90222de0",
"_parent_code": "sample string 6",
"sales_organization_id": "7838be40-7c5a-4404-b42a-390660c61d15",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
},
"date_in_production_since": "2026-07-28T22:03:22.59197+00:00",
"date_out_of_production_since": "2026-07-28T22:03:22.59197+00:00",
"date_end_support": "2026-07-28T22:03:22.59197+00:00",
"sales_organization_id": "8cefa563-4631-4340-9613-e1118a36556c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+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-07-28T22:03:22.59197+00:00"
},
"project_status_id": "7ffe61fd-ccd0-4b28-a81c-c2d36f0781a5",
"project_status_code": "sample string 10",
"project_status": {
"id": "0087e3c2-2dd8-4a87-80a4-07dba59a8afb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2e508808-8b5d-4048-b637-f6f23c58f68d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
},
"company_id": "97180fd9-3b08-4194-8bc3-69bc61874a7e",
"company_code": "sample string 12",
"db_address_id": "8159c97b-db0a-4696-8b64-48732e6d24a2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "459f2ec0-7812-4fbd-b603-73cbd2338000",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e3eb7356-8755-4c59-980d-6a01ea4cb9de",
"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-07-28T22:03:22.59197+00:00",
"date_create": "2026-07-28T22:03:22.59197+00:00",
"date_update": "2026-07-28T22:03:22.59197+00:00",
"updated_by_user_id": "a3d1a462-5fd8-47b7-bcb5-c0ffea3f8592",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T22:03:22.59197+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-07-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T22:03:22.59197+00:00",
"date_last_job": "2026-07-28T22:03:22.59197+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T22:03:22.59197+00:00",
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00",
"is_mobile_installation": true
},
"job_type_id": "5ab0bab0-1adb-4fd3-8d39-6ac63f8290b8",
"job_type_code": "sample string 7",
"job_type": {
"id": "1c636b24-7f6e-4cf8-bf6c-8965c196561b",
"name": "sample string 2",
"sales_organization_id": "5920c501-73d1-4e92-ba19-b26ecf3c2ab5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00",
"code": "sample string 7"
},
"job_priority_id": "9a996a1d-c93d-4d5a-b40e-3f33c405d1c0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d4f7b4f2-73c5-4c12-a712-d2ef544434db",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "45dc78d5-6e09-45ff-9f49-23068e67c3f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
},
"job_status_id": "24430098-03f6-48d7-b700-2153b26b1543",
"job_status_code": "sample string 11",
"db_address_id": "bbf4126a-0dc8-4012-b3da-054e9b12822d",
"contact_id": "56e00a24-8f2e-4d57-8540-d85265dca1ae",
"requested_by_company_id": "4f6deb3c-eb6a-4a95-9d73-a2419143db1d",
"requested_by_contact_id": "da2ed19c-af9d-4ebc-a1ac-d1f2f9e1d8cb",
"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-07-28T22:03:22.59197+00:00",
"due_date": "2026-07-28T22:03:22.59197+00:00",
"date_create": "2026-07-28T22:03:22.59197+00:00",
"date_update": "2026-07-28T22:03:22.59197+00:00",
"date_closed": "2026-07-28T22:03:22.59197+00:00",
"suggested_user_id": "e98ef83a-6f2f-448d-b9d7-d332c0596f5d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bbca22a5-20e7-4d69-9e16-7be3fba7bf93",
"db_language_id": "8558c03d-14cc-48ca-8264-f6f196dde5ac",
"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-07-28T22:03:22.59197+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "074a56d8-dd06-40cf-a21d-2af586c082e6",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "baaba950-6063-42b4-9429-952e27412fc7",
"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": "55083f4f-26d3-471f-aa6b-f3fd18574ad9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "40c6899a-e3ec-4c79-8295-8cc1b969ee10"
},
"suggested_date_start": "2026-07-28T22:03:22.59197+00:00",
"skill_id": "b8708f66-0684-4eba-a4be-1776313bce8b",
"skill_code": "sample string 32",
"skill": {
"id": "d643f4df-f180-498a-a12e-27e50300852b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "05cc3aa7-b544-4925-be21-2abb4e293b3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b15d4f52-a600-407b-8fb2-f5042245b3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "58ace8a8-567d-456a-b487-00e98e18d7cf",
"db_currency_id": "da2aa995-52fa-4a3f-be10-7e9b18beed3b",
"db_language_id": "9fbad4cd-e367-4679-8fc7-778d5a72382b",
"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-07-28T22:03:22.59197+00:00"
},
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7e1f5e5c-452f-463a-b92e-c4059ac7b1ff",
"date_reported_by_company": "2026-07-28T22:03:22.59197+00:00",
"id2": 36,
"company_id": "214a4d04-bda2-4b5e-ba9e-1306136ca27f",
"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": "80831523-42d1-4310-a937-33b407aca773",
"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-07-28T22:03:22.59197+00:00"
},
"work_instruction_details_id": "05dde2ee-925e-456e-90d8-f33ece2335ba",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "171befac-9827-483b-b65a-00a5a00faef4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dbdeb7a8-9469-4124-8073-c1536642e5ca",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T22:03:22.59197+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": "fe87b9e0-0341-4d80-abd0-e9170dd923e2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T22:03:22.59197+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.