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": "1473f001-63fc-49ea-bbfa-dc22d0cffe72",
"jobs_id": "ac10e753-56d7-42e3-8d98-4644d73885d6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "94694d66-41f0-4e57-9937-d075127de92e",
"_parent_id": "0af8a511-8dba-4617-89a3-f9aa04caa87c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3bf19051-281d-442d-97bd-8cfb75b7bbeb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "899fe539-6b5e-4420-9afa-2bdbe80d8e07",
"_parent_id": "807eb994-f54b-417e-b960-ae8f15b02bc2",
"root_parent_id": "52953a62-c313-4b2a-86d3-285b4f6270b6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "826e9780-7ba6-40b8-aa81-1667995bb4c6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "426ecbc6-430d-418b-972d-67b9d274cf27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a51f7b0a-d40e-46ae-8d38-49f13e0ea9e3",
"_parent_code": "sample string 6",
"sales_organization_id": "c726521c-8cc8-4d82-bdb3-eeeea2051b8e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
},
"equipment_model_id": "913508e0-7d86-4d91-ac2e-2ae34f5f7695",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "94e35a6e-c156-4053-ac31-d86f1b04446a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "82aa0757-8b37-44b7-a93a-274365239cd9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b421ba0d-90a2-4865-825f-054d383b7c25",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "48ff1a04-97b0-4d9e-906a-c65db90fc074",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
},
"equipment_family_id": "aa9c51af-6890-4338-bcc2-b7d449ea921b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "426ecbc6-430d-418b-972d-67b9d274cf27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a51f7b0a-d40e-46ae-8d38-49f13e0ea9e3",
"_parent_code": "sample string 6",
"sales_organization_id": "c726521c-8cc8-4d82-bdb3-eeeea2051b8e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
},
"date_in_production_since": "2025-12-07T03:49:18.1312035+00:00",
"date_out_of_production_since": "2025-12-07T03:49:18.1312035+00:00",
"date_end_support": "2025-12-07T03:49:18.1312035+00:00",
"sales_organization_id": "6e5bb1bc-2a4c-42fc-b217-209d9255aaa7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+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": "2025-12-07T03:49:18.1312035+00:00"
},
"project_status_id": "fa75150b-bd5a-4b92-a13d-c359c4287733",
"project_status_code": "sample string 10",
"project_status": {
"id": "c2f10b76-590b-41b4-95e6-9abf597daf71",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d9d0c151-3717-489e-8db0-b487172d393e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
},
"company_id": "935c02f8-8934-4c57-b3b2-bedff72cd323",
"company_code": "sample string 12",
"db_address_id": "dc974a80-acbe-4e71-9cb9-63e8c7a3e0c7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f4050f3e-7778-425c-9bff-809d8d61f3e7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a6ec06f7-f24b-4b91-b097-3ab472bf4702",
"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": "2025-12-07T03:49:18.1312035+00:00",
"date_create": "2025-12-07T03:49:18.1312035+00:00",
"date_update": "2025-12-07T03:49:18.1312035+00:00",
"updated_by_user_id": "369ccac8-9631-41e9-8848-69ba96717d2b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-07T03:49:18.1312035+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": "2025-12-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-07T03:49:18.1312035+00:00",
"date_last_job": "2025-12-07T03:49:18.1312035+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-07T03:49:18.1312035+00:00",
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00",
"is_mobile_installation": true
},
"job_type_id": "06455a11-ef7b-48bb-ad84-895a453b090b",
"job_type_code": "sample string 7",
"job_type": {
"id": "03f78a7c-631a-4d58-a9be-279d088eb6f2",
"name": "sample string 2",
"sales_organization_id": "e197cf9c-4f89-4409-8dd0-0d9cc0111a02",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00",
"code": "sample string 7"
},
"job_priority_id": "ce213fae-f5f3-4ae9-829d-455725f897de",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b810f11d-689f-4eee-afcd-221e2f213186",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d9f9fd2-5c89-47d1-ba61-1e2647c9c2f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
},
"job_status_id": "49e43c40-4f91-4ab9-89d5-34f70826ba5c",
"job_status_code": "sample string 11",
"db_address_id": "435be130-d4d5-4c84-bb5f-8e6a9f2bc704",
"contact_id": "40928811-8cf4-456e-afe8-5ab87ba6c81c",
"requested_by_company_id": "7129579b-7bd5-4d3d-a7f2-ad6c61dd844e",
"requested_by_contact_id": "6cacab0e-5043-4f9f-b06a-0de530546a9d",
"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": "2025-12-07T03:49:18.1312035+00:00",
"due_date": "2025-12-07T03:49:18.1312035+00:00",
"date_create": "2025-12-07T03:49:18.1312035+00:00",
"date_update": "2025-12-07T03:49:18.1312035+00:00",
"date_closed": "2025-12-07T03:49:18.1312035+00:00",
"suggested_user_id": "ca71fc2b-7e4f-4195-b305-4ba41d36d916",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "089d7b72-776b-40a0-8f69-137ea7a2ec70",
"db_language_id": "abd9d48b-d110-493d-9dfb-3e5d555e2bd4",
"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": "2025-12-07T03:49:18.1312035+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e0a522e5-fb9f-4c14-ad60-a0c1b098b136",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a58ebcf-311e-4768-b07a-5cca24b921e7",
"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": "f178c8c6-3fdc-4aa9-b9c2-5c275401124f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f71a3c7c-f0de-4314-94ee-1626d232f36b"
},
"suggested_date_start": "2025-12-07T03:49:18.1312035+00:00",
"skill_id": "b9856440-f174-47b4-9604-0577cde38658",
"skill_code": "sample string 32",
"skill": {
"id": "0c55a4eb-6031-45ab-b6d2-b4693b3354fa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "acc304ab-d0e2-4c8e-9da8-6d1c8d5968da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8fc7976d-61a2-4f2b-834d-81164abb1407",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1f553d2c-065b-416b-9376-83594bfcb8cb",
"db_currency_id": "8e9e36ff-f1a4-4fc8-b5f5-4d6979fef5c4",
"db_language_id": "70e31b50-fb53-4595-ab8c-ec9750be8802",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f658e2ad-b540-4d56-a23b-30509e2d4451",
"date_reported_by_company": "2025-12-07T03:49:18.1312035+00:00",
"id2": 36,
"company_id": "e99339d5-a929-4dd7-bb70-0665188f8215",
"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": "257721ba-5f19-4053-8dda-102c4bd78738",
"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": "2025-12-07T03:49:18.1312035+00:00"
},
"work_instruction_details_id": "49b718c8-7dd4-4d29-b309-3085c2db8732",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "267797be-055b-4632-99a7-ab77a4f845a4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "165c5b5f-38fe-495f-9203-522d17e4b754",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-07T03:49:18.1312035+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": "a8236312-be4d-4e25-b958-9da36154cfc1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-07T03:49:18.1312035+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.