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": "822f9e51-6b41-4c05-a334-54280575e700",
"jobs_id": "5145b59f-25ca-420f-a40b-6342ca24a011",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dba94bf3-f187-4069-b058-e8a0382c2c31",
"_parent_id": "d9b66363-1449-45dc-9454-b4020071d9fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "46e61316-6a59-4b96-938d-a8081ee8820d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "437d9cd7-2966-4a41-a053-d03118b7d96d",
"_parent_id": "6abd6dc9-a464-4342-a2f3-220bffe6ec61",
"root_parent_id": "86a29078-d292-47d6-9986-db2e9b1492f0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "aafd1925-544c-45f4-b280-4baef0037aa1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fbbd80d2-50ba-41cd-8998-bfb8cfb1b826",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66b84a7d-6857-488e-99f8-e55989e8207e",
"_parent_code": "sample string 6",
"sales_organization_id": "fe90bfbf-c849-4f19-8874-137e0bfe8668",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
},
"equipment_model_id": "f332889a-9951-46f1-9fad-4589383ee653",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a6f36239-6b9f-427a-973f-19ad5eab5bef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "54c3758f-1150-4e51-9401-81b2c3ed2517",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0f2ae1ef-f544-44d3-98ed-c8fa7a2ca710",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ad58e3d5-a3c5-4544-8795-bdbbec26e9d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
},
"equipment_family_id": "3a87ad4d-d24f-4b14-be84-f247c7a75fdb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fbbd80d2-50ba-41cd-8998-bfb8cfb1b826",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66b84a7d-6857-488e-99f8-e55989e8207e",
"_parent_code": "sample string 6",
"sales_organization_id": "fe90bfbf-c849-4f19-8874-137e0bfe8668",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
},
"date_in_production_since": "2026-10-08T09:09:08.7088398+00:00",
"date_out_of_production_since": "2026-10-08T09:09:08.7088398+00:00",
"date_end_support": "2026-10-08T09:09:08.7088398+00:00",
"sales_organization_id": "f20d2247-9ca2-46e9-b8d3-e23d3321e9da",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+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-10-08T09:09:08.7088398+00:00"
},
"project_status_id": "e120da6d-7730-4456-9553-666738bdea66",
"project_status_code": "sample string 10",
"project_status": {
"id": "dd5e42ec-b93f-43e1-8b4b-77a1a79a8577",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c0346542-37bd-4ded-b7c2-f11ce5d04a95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
},
"company_id": "117b5daf-5b91-47fa-9a65-78616724ee64",
"company_code": "sample string 12",
"db_address_id": "a0d696be-806a-4ef8-8a0c-521f1b88a1e4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "312fb2b3-c535-4117-97db-c98b370e45e7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a526c0fe-a332-47e3-bcb0-7aae6fdf9860",
"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-10-08T09:09:08.7088398+00:00",
"date_create": "2026-10-08T09:09:08.7088398+00:00",
"date_update": "2026-10-08T09:09:08.7088398+00:00",
"updated_by_user_id": "54aefd23-3b38-4f15-97b6-4ed19f261a4c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T09:09:08.7088398+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T09:09:08.7088398+00:00",
"date_last_job": "2026-10-08T09:09:08.7088398+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T09:09:08.7088398+00:00",
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00",
"is_mobile_installation": true
},
"job_type_id": "8989a5f3-7a9d-49df-879c-ac99d0727065",
"job_type_code": "sample string 7",
"job_type": {
"id": "42a7f0d6-1e9f-4e4b-bad5-dfad3d619541",
"name": "sample string 2",
"sales_organization_id": "a66f12a1-e6c7-4813-b27b-d66b7161a529",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00",
"code": "sample string 7"
},
"job_priority_id": "90fcc19e-e357-4353-ad85-d8217a5ee1c3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7fd46935-9d32-41e4-940a-10bfd5e43c42",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "38bd85b2-84a4-4cb8-a2f6-7019e3134186",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
},
"job_status_id": "12ec4af1-32be-4122-bd19-7107679ae546",
"job_status_code": "sample string 11",
"db_address_id": "427990db-0fe6-4ecd-8e36-ac9e81327bb9",
"contact_id": "a6696f99-04bf-4ac2-87d6-446850aeb965",
"requested_by_company_id": "3e81a3c5-509e-4373-a1ab-aa96caf0c029",
"requested_by_contact_id": "67c801bc-2be6-4d1f-a7de-30ab6b1e4998",
"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-10-08T09:09:08.7088398+00:00",
"due_date": "2026-10-08T09:09:08.7088398+00:00",
"date_create": "2026-10-08T09:09:08.7088398+00:00",
"date_update": "2026-10-08T09:09:08.7088398+00:00",
"date_closed": "2026-10-08T09:09:08.7088398+00:00",
"suggested_user_id": "93886300-5db5-4e14-b4f9-05d6e0da764f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d4764e40-149a-42ab-9075-bb1993c17780",
"db_language_id": "770ad259-eecd-44e6-9258-8cce874eda5c",
"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-10-08T09:09:08.7088398+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c2b06888-d964-487e-bfa0-790224e0a2da",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "75d0d086-2222-4440-bd5e-1aab1635ae48",
"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": "90d26c32-8dd2-4984-ab4d-f90d0389fc4a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "28c4c697-e785-4150-8d34-1de6b835eede"
},
"suggested_date_start": "2026-10-08T09:09:08.7088398+00:00",
"skill_id": "29a6419f-2df0-4622-a476-4421b5e4d17c",
"skill_code": "sample string 32",
"skill": {
"id": "4fb1b1fc-798f-475c-a01b-c33e06642e7e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "53deabfd-06a1-491b-9be3-02a9f248acaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc933d38-9be5-41d0-b7f5-56478b61f6d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4840572-1219-43b7-ac19-4ec78aa238c2",
"db_currency_id": "6d21fbe8-8a69-4ea9-b117-206fc7fe9018",
"db_language_id": "88019563-f6e2-4d04-bcd9-4b4d11c4b81a",
"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-10-08T09:09:08.6898896+00:00"
},
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0a3876d8-bb96-49fa-b8d1-86d4395f3c61",
"date_reported_by_company": "2026-10-08T09:09:08.7088398+00:00",
"id2": 36,
"company_id": "b76d093c-c5ef-4a9a-9c3b-95d9447831d0",
"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": "700daeab-651f-42e3-8055-ddf042f374f9",
"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-10-08T09:09:08.7088398+00:00"
},
"work_instruction_details_id": "84635295-f45b-46a6-bfc0-dfa7e0ccf826",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4a19c7bd-5d22-4078-b890-8fe4bec55ef3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cac1630a-e229-4149-a2a4-6fc01efda97d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T09:09:08.7088398+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": "38ad0cf8-7d17-48aa-8a1d-f52c78f1cf36",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T09:09:08.7088398+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.