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": "1040f131-074e-439f-ab4d-61f85abc58a0",
"jobs_id": "8e6d448f-5bf0-408a-8994-45c721ba4b68",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1c21bbac-95dc-4977-9211-4540cbd5ec18",
"_parent_id": "9c91478f-4d89-4135-bd0a-25df28893045",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "02c065f8-2293-4d02-9416-5e37ae6e519d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2592cd6a-fbf9-48de-9731-6a7584bdd186",
"_parent_id": "912c21c1-acc2-4246-ac5a-5278d9cc92ca",
"root_parent_id": "4624730e-3c8a-4bc9-97ff-338830043d2b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fae1d182-af1d-4404-b148-8eee36cd15d6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "051b302b-e88a-4759-a5da-e3285f2ff775",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "08744c64-af06-42cc-a681-2f9dca07a0d6",
"_parent_code": "sample string 6",
"sales_organization_id": "713b84cf-74e6-404b-839a-fcd7615a8010",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"modified_dateutc": "2026-11-03T15:47:57.5114688+00:00"
},
"equipment_model_id": "33994a4b-2d4c-41c5-94c4-45b54a361219",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "92622f76-5fb0-40db-9dd2-cb1a0a3460f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bf04d780-a5a1-4ece-8f26-e60039021adb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "df5fe697-f417-445e-b09f-b42d33216b17",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2390bdb1-e3dd-46f9-b838-afd7f651b4c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"modified_dateutc": "2026-11-03T15:47:57.5114688+00:00"
},
"equipment_family_id": "733a5f7e-8956-4ecd-a19e-fd6babe3704e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "051b302b-e88a-4759-a5da-e3285f2ff775",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "08744c64-af06-42cc-a681-2f9dca07a0d6",
"_parent_code": "sample string 6",
"sales_organization_id": "713b84cf-74e6-404b-839a-fcd7615a8010",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"modified_dateutc": "2026-11-03T15:47:57.5114688+00:00"
},
"date_in_production_since": "2026-11-03T15:47:57.5114688+00:00",
"date_out_of_production_since": "2026-11-03T15:47:57.5114688+00:00",
"date_end_support": "2026-11-03T15:47:57.5114688+00:00",
"sales_organization_id": "f19e8459-dd99-4b43-ad97-696d07a1c0d4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+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-11-03T15:47:57.5114688+00:00"
},
"project_status_id": "12d97a47-270f-4365-b9e7-adbabf2f4098",
"project_status_code": "sample string 10",
"project_status": {
"id": "a12539b0-6b34-4299-b974-b4b1829cbeb6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "220407b6-b010-49ce-a2e8-4c379196e3dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-03T15:47:57.5114688+00:00"
},
"company_id": "0060b1fa-f66e-4d6c-a3a6-2040c224e705",
"company_code": "sample string 12",
"db_address_id": "6523dda0-1307-4b6f-aa09-74f25936053a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e7d9f1af-bb17-4120-a56b-fed5704b1f3c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f071e011-1d2e-456b-a50d-b6e6f006a4b4",
"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-11-03T15:47:57.5298112+00:00",
"date_create": "2026-11-03T15:47:57.5298112+00:00",
"date_update": "2026-11-03T15:47:57.5298112+00:00",
"updated_by_user_id": "fca6bf39-3caa-4b74-9547-ee8c2bb4cfef",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-03T15:47:57.5298112+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-11-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-03T15:47:57.5298112+00:00",
"date_last_job": "2026-11-03T15:47:57.5298112+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-03T15:47:57.5298112+00:00",
"modified_dateutc": "2026-11-03T15:47:57.5298112+00:00",
"is_mobile_installation": true
},
"job_type_id": "1555b9f3-2f17-485c-83b1-6ea2f8b25c41",
"job_type_code": "sample string 7",
"job_type": {
"id": "2243799a-b4de-42b8-abcd-f0f6fcb7cfa7",
"name": "sample string 2",
"sales_organization_id": "7edfcc72-c3aa-4012-bb05-c38a3fa8caf0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-03T15:47:57.5298112+00:00",
"code": "sample string 7"
},
"job_priority_id": "842f6ad8-9045-4131-b25e-0e47e6c691b8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a93609de-79d9-4be1-b185-fe2be3e63900",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "013ef69a-c5e5-4a08-bcf8-8b1344d131e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-03T15:47:57.5298112+00:00"
},
"job_status_id": "c5d4923c-9e9d-4657-987f-368c7c6dcf8e",
"job_status_code": "sample string 11",
"db_address_id": "41f2317f-667e-4784-bea0-6f9373bdbbd7",
"contact_id": "a9518f35-7882-4e65-a24c-2823c4837231",
"requested_by_company_id": "71407597-9911-4709-b52e-c9c5bea131cc",
"requested_by_contact_id": "42f225ef-7a1c-4ef6-82f7-6b44ae15b9f8",
"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-11-03T15:47:57.5298112+00:00",
"due_date": "2026-11-03T15:47:57.5298112+00:00",
"date_create": "2026-11-03T15:47:57.5298112+00:00",
"date_update": "2026-11-03T15:47:57.5298112+00:00",
"date_closed": "2026-11-03T15:47:57.5298112+00:00",
"suggested_user_id": "fd0fffe6-73e8-4d27-aa79-174a79725252",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e14791a9-3493-4076-b62e-7a2ee5c879bd",
"db_language_id": "7f7927a3-6ebe-40c9-bebd-691691da1f5f",
"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-11-03T15:47:57.5298112+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d8bc3bfe-c32b-4ee5-9103-ac4904202c7d",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e58f2b19-8047-43b1-b1ce-62a827c1381e",
"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": "f44bd112-c6a9-4e8d-aa01-f64060a0c48f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-03T15:47:57.5298112+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e4ac532a-7a74-434d-b988-9c5ed5aa6bd7"
},
"suggested_date_start": "2026-11-03T15:47:57.5427201+00:00",
"skill_id": "a0518a92-8f47-4607-8772-6f81536980c1",
"skill_code": "sample string 32",
"skill": {
"id": "276e12e9-94ed-4993-9d0a-28d390a60ff9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e7054573-10fb-4652-aca1-e32a657e4f98",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5576ed1-32f7-45cc-abc1-0d7f862c6366",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ed4016e-812b-4e2c-a33c-7c0586bf56ba",
"db_currency_id": "50f82b82-8b67-430d-ab17-e6ae6cda747c",
"db_language_id": "11221d07-0856-4355-856a-d75ae25757e9",
"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-11-03T15:47:57.5114688+00:00"
},
"modified_dateutc": "2026-11-03T15:47:57.5427201+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "09e064b3-03b8-4902-bba0-99cb4b59d3de",
"date_reported_by_company": "2026-11-03T15:47:57.5427201+00:00",
"id2": 36,
"company_id": "e18f230c-ebad-40c4-baaa-3b57433fcd09",
"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": "ee3c9d39-df44-431f-b60e-3aec0a96e643",
"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-11-03T15:47:57.5427201+00:00"
},
"work_instruction_details_id": "6f3b3690-c710-4ce2-a3e8-1d190920c016",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2fb79732-fc8e-47ba-940c-bd1220f532ae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8df99bfc-d067-4983-89ab-f6c6d5d7a6c1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-03T15:47:57.5427201+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": "ddd27767-3843-4b93-ac86-d889e5470ba0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-03T15:47:57.5427201+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.