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": "9d145574-bf49-4365-adf6-241b6e93be33",
"jobs_id": "42f6ed90-15ac-46f8-903c-19cb1c9b316f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fcd23ef7-6859-46d5-af31-42556158f00c",
"_parent_id": "31b967d1-7e25-4177-878e-39becf8e6347",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "97a32151-0e1c-4281-bac7-d07e147a1892",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0fccc167-4359-4ccc-8ece-1a6d18905129",
"_parent_id": "b5972bb3-fad5-4889-8d4a-481d3649a04c",
"root_parent_id": "70fb0d1c-628a-4fdb-81be-b50334480389",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f6e8b0aa-8843-4725-a585-b0955fb3008a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9f93f739-f05a-4112-a431-840115b0ab6d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "53083c8e-d9f4-4656-8c56-56be3854c050",
"_parent_code": "sample string 6",
"sales_organization_id": "ef8b4a7f-5266-42f1-9508-7f6ca4993655",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"modified_dateutc": "2026-06-02T00:56:17.8268608+00:00"
},
"equipment_model_id": "db8c5b93-06ea-49b7-946d-971685d746f9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "039f48c9-1f46-4622-bc0b-40e8b985934d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "571ad008-11d5-4da6-b04d-95683fa29e68",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "40ff5c16-246f-4360-b5eb-9a6cbabbba4b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aacb8324-13fa-4926-a24f-68c387673ac4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"modified_dateutc": "2026-06-02T00:56:17.8268608+00:00"
},
"equipment_family_id": "c25059c4-c94a-4394-ac6a-dc61baba1c27",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9f93f739-f05a-4112-a431-840115b0ab6d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "53083c8e-d9f4-4656-8c56-56be3854c050",
"_parent_code": "sample string 6",
"sales_organization_id": "ef8b4a7f-5266-42f1-9508-7f6ca4993655",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"modified_dateutc": "2026-06-02T00:56:17.8268608+00:00"
},
"date_in_production_since": "2026-06-02T00:56:17.8268608+00:00",
"date_out_of_production_since": "2026-06-02T00:56:17.8268608+00:00",
"date_end_support": "2026-06-02T00:56:17.8268608+00:00",
"sales_organization_id": "6439cb43-71e1-42ea-88fd-4888dcace3d0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+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-06-02T00:56:17.8424845+00:00"
},
"project_status_id": "e1863809-776c-4098-84e8-f66e9144afe6",
"project_status_code": "sample string 10",
"project_status": {
"id": "c11b1dd2-9385-4220-8f5a-8a9ca0173096",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8d9d0e9f-1827-47e1-a522-f4cae80282a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00"
},
"company_id": "474ae19d-b58a-417c-b195-fa1c5d2a60f9",
"company_code": "sample string 12",
"db_address_id": "88fd2de1-0c9a-4f29-a1f5-9ed047d5d1f7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f553b8b1-55dc-480b-9544-81865089cc51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6ad47236-114e-477d-a09a-075c9ed4fac6",
"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-06-02T00:56:17.8424845+00:00",
"date_create": "2026-06-02T00:56:17.8424845+00:00",
"date_update": "2026-06-02T00:56:17.8424845+00:00",
"updated_by_user_id": "4a46b345-c1a3-49c7-a229-d4639a5ca509",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T00:56:17.8424845+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T00:56:17.8424845+00:00",
"date_last_job": "2026-06-02T00:56:17.8424845+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T00:56:17.8424845+00:00",
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00",
"is_mobile_installation": true
},
"job_type_id": "ed487fe0-32fc-41c8-84c0-88fd083f1cce",
"job_type_code": "sample string 7",
"job_type": {
"id": "7f0ba6e4-e5a5-4904-8e10-0e08c3ed9433",
"name": "sample string 2",
"sales_organization_id": "e779f31a-fa0e-493a-8738-e5ec922adc29",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00",
"code": "sample string 7"
},
"job_priority_id": "62f712c5-e2b1-46a5-a3ba-11850994e4fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a296f1b7-b8ff-407b-b0d5-21b0897355b9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a103519e-9856-4211-8b88-d7f5bf456a58",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00"
},
"job_status_id": "029e871d-c729-4e79-9d45-15a56d9f4d08",
"job_status_code": "sample string 11",
"db_address_id": "18ae8dc6-1005-4a33-9bf3-5331ef1b1738",
"contact_id": "23a9723d-016c-41d5-97bb-2cee9a6fb6dc",
"requested_by_company_id": "a0fe2d2f-cdba-4807-b9e4-83b4c6d79216",
"requested_by_contact_id": "8d0dde1e-695a-4cc7-98a0-be62eb2a4c9b",
"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-06-02T00:56:17.8424845+00:00",
"due_date": "2026-06-02T00:56:17.8424845+00:00",
"date_create": "2026-06-02T00:56:17.8424845+00:00",
"date_update": "2026-06-02T00:56:17.8424845+00:00",
"date_closed": "2026-06-02T00:56:17.8424845+00:00",
"suggested_user_id": "fe1bd639-67e3-42cf-ae1d-841fe19a9eca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "002175c6-c918-4550-9655-fa69dc7b13f1",
"db_language_id": "41f5bb19-d7d7-4f8d-9ca3-7fcffe2eec29",
"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-06-02T00:56:17.8424845+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc469ba7-0604-432f-a725-efd447f21208",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a2eaf84c-2436-4d80-81aa-f342e0690bd3",
"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": "f9cd5f4e-8731-4102-aff1-bcff6ea6a736",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5fb9d699-5640-4f73-9d34-e1885837fb79"
},
"suggested_date_start": "2026-06-02T00:56:17.8424845+00:00",
"skill_id": "f198c12d-fd17-491a-9b54-a59e7c17e2a9",
"skill_code": "sample string 32",
"skill": {
"id": "ca99fe96-78f6-4ab6-891b-bd9cb9b712c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "856e99d3-4818-435c-b06e-f15b960ea78c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e1b25c86-e8a2-4f56-bd44-80e87331affd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff59284-1c15-403f-8441-b075ca67fdba",
"db_currency_id": "8a0ff02c-0043-4207-8d8b-b9efdf3b425d",
"db_language_id": "32845a62-ace5-4edb-8f42-a638e5b1c4ab",
"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-06-02T00:56:17.8268608+00:00"
},
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "99e2dea3-d089-4c5a-9297-b444ff6c317f",
"date_reported_by_company": "2026-06-02T00:56:17.8424845+00:00",
"id2": 36,
"company_id": "c24812fa-674b-4ebf-acf7-e1b42e113241",
"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": "0d46fb3c-8d2e-4299-985b-b78120d3f917",
"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-06-02T00:56:17.8424845+00:00"
},
"work_instruction_details_id": "4597436a-ca5c-437a-9c02-742d7baad27b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3532579f-679b-4412-b097-c56c2ff4c7fc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27a1b8ce-f8c2-4798-bec3-32a141672ea5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T00:56:17.8424845+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": "f47bfb39-004f-4878-adbb-1e033ce1225b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T00:56:17.8424845+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.