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": "25e7a232-1be6-403c-a27a-2c2c1a9a82cd",
"jobs_id": "2aa75816-bb46-42ea-87d2-d5614616f316",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5aad1ff4-73c3-4a1a-9bd3-8e6f08382553",
"_parent_id": "6c977f1c-fe5b-4573-a7c7-c2f9e45a7b53",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2582d21b-99d5-4ca0-a6c3-1a842b0c83cb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "69c530c8-fab2-491b-9559-a8efc2807c5e",
"_parent_id": "faebdf10-2af4-4cf1-a994-491ad5c23624",
"root_parent_id": "312af240-bd9a-41d2-bd02-8552bf7adfb2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "24d0fc7f-7643-426a-b07b-111392a66740",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b319f6d7-4e78-4e55-9712-71cbc4e3c0a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe86e46e-be1e-4ee9-9a5c-46c05f680484",
"_parent_code": "sample string 6",
"sales_organization_id": "10f7cf32-53d8-404a-9bce-7e9342562ccb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
},
"equipment_model_id": "804ff35a-ad45-4e44-90db-b00b27b56434",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c393a7d7-2815-4626-9dc4-ac9ebfd16693",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "14731ac4-74dc-40aa-8240-3e849e5566eb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f897f909-b3c7-4cbd-87fa-96075130eb2f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7faa1b10-f505-4cca-80ca-404d2bc7d875",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
},
"equipment_family_id": "88da0af7-daa4-4a12-bc36-207168d8851e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b319f6d7-4e78-4e55-9712-71cbc4e3c0a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe86e46e-be1e-4ee9-9a5c-46c05f680484",
"_parent_code": "sample string 6",
"sales_organization_id": "10f7cf32-53d8-404a-9bce-7e9342562ccb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
},
"date_in_production_since": "2026-08-15T08:10:27.2360579+00:00",
"date_out_of_production_since": "2026-08-15T08:10:27.2360579+00:00",
"date_end_support": "2026-08-15T08:10:27.2360579+00:00",
"sales_organization_id": "909f9e95-5f10-4960-951a-eaab15d01d99",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+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-08-15T08:10:27.2360579+00:00"
},
"project_status_id": "f69f2c90-7f59-42c0-9f86-d788aa548133",
"project_status_code": "sample string 10",
"project_status": {
"id": "197a1981-ae4d-4b5a-829e-9ac1d8ab66fc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "89da9996-14b1-479a-93d9-5f90f0764294",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
},
"company_id": "08770148-4ec7-4fc7-9d22-3da00a17ee40",
"company_code": "sample string 12",
"db_address_id": "82201004-cee3-44b7-8a8c-414f863ebbd7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a97b4778-51fe-4769-afc7-9038b5339dc3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d48aaa2-509e-4165-864e-e1a7151ff257",
"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-08-15T08:10:27.2360579+00:00",
"date_create": "2026-08-15T08:10:27.2360579+00:00",
"date_update": "2026-08-15T08:10:27.2360579+00:00",
"updated_by_user_id": "69386b34-2361-44c9-95a8-bb0099f8b4d3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-15T08:10:27.2360579+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-08-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-15T08:10:27.2360579+00:00",
"date_last_job": "2026-08-15T08:10:27.2360579+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-15T08:10:27.2360579+00:00",
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00",
"is_mobile_installation": true
},
"job_type_id": "e5084673-ed6f-4c7b-b5ff-c4eabca6dc2e",
"job_type_code": "sample string 7",
"job_type": {
"id": "606f90de-dff3-4bbd-812c-befcfc7e7179",
"name": "sample string 2",
"sales_organization_id": "e6a14e4f-f6cd-455f-b4a3-f993d6465396",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00",
"code": "sample string 7"
},
"job_priority_id": "96339ccf-12f5-4421-b588-01c54eaa4e85",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c960f03b-77e3-450e-b195-b8516a2a6132",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b23290ad-0c05-4f78-b1c1-865133e32671",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
},
"job_status_id": "263adb18-1a14-4725-b2c7-2c9ce780fc94",
"job_status_code": "sample string 11",
"db_address_id": "468a7232-dfe2-4409-aea3-98176de85a47",
"contact_id": "7d2bde85-6511-4341-b58b-4e04ca5d41c3",
"requested_by_company_id": "a7cb1e4a-9987-4e52-8946-89bb3d7f989f",
"requested_by_contact_id": "98479134-af92-4ba4-aef1-d25948e0f943",
"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-08-15T08:10:27.2360579+00:00",
"due_date": "2026-08-15T08:10:27.2360579+00:00",
"date_create": "2026-08-15T08:10:27.2360579+00:00",
"date_update": "2026-08-15T08:10:27.2360579+00:00",
"date_closed": "2026-08-15T08:10:27.2360579+00:00",
"suggested_user_id": "32eb305a-0487-4ea1-9c30-1e0a745c6a0d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1c7dd93b-9390-4c1f-a4d9-eee8bd702450",
"db_language_id": "e987318d-2020-4692-83e3-44bdfd6e95bc",
"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-08-15T08:10:27.2360579+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3b6909e3-dd25-44fd-81ca-4c9cff97b75d",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9c88af5f-6e2d-476a-b1c9-c7afdd007a63",
"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": "6a0e6b11-642a-4781-8a82-f147d776b201",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dde11474-8f69-4f2d-b92b-36d618e4a724"
},
"suggested_date_start": "2026-08-15T08:10:27.2360579+00:00",
"skill_id": "7e88d3fc-271f-4b31-b00b-ceec26302e92",
"skill_code": "sample string 32",
"skill": {
"id": "d302dcff-d333-49cc-944c-5eb977270219",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "482794ab-40b9-457f-8a57-f0dbd7ad939b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4143ea98-b6c1-461f-b156-b560f2307c98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5858959b-b727-4748-9022-0ff88fed063d",
"db_currency_id": "6f13a4c0-dbac-41ad-aba3-95c211e10da8",
"db_language_id": "2d0949ce-d24f-4f1b-8d85-f48627bbfbcd",
"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-08-15T08:10:27.2360579+00:00"
},
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "69dd7249-2505-4415-951c-f16424a6d0c2",
"date_reported_by_company": "2026-08-15T08:10:27.2360579+00:00",
"id2": 36,
"company_id": "16a654be-af07-445b-a356-03afc46f39b8",
"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": "20084891-d8c5-446f-a1e0-31101153bd52",
"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-08-15T08:10:27.2360579+00:00"
},
"work_instruction_details_id": "c06e0b78-658b-4b5e-b721-b77078f1e58a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a7d01f4f-1595-4fa0-bb67-2c7d830ebeb3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9c36cad8-43b0-40e9-9c8e-158478a514ae",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-15T08:10:27.2360579+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": "30f73db8-7c4d-4d51-b6a3-662733fa535e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-15T08:10:27.2360579+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.