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": "2204423a-a257-4210-8568-0a17e8959438",
"jobs_id": "e884e68c-e260-40ea-b058-a052f7307156",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6fc45287-bc46-411a-8e44-5134744e4470",
"_parent_id": "e78d7cdf-fa28-4ce9-b389-8c38b271300f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5896203a-11f0-4d1f-936b-8cb4f3f52fc2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "efef59d0-6222-4eee-93eb-0c0399a56a4a",
"_parent_id": "71446009-c843-4feb-bb50-fc0183f751c3",
"root_parent_id": "45be8ec9-1244-47bd-ba9e-c0edc0d090a9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7f44a6e8-7a74-4529-8f90-c61d55e21050",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "84bdb185-9966-49db-b25a-8be74a8ace46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9a2935b-84c4-471f-a4ad-c49a8783b287",
"_parent_code": "sample string 6",
"sales_organization_id": "3de26449-c713-4ff2-bbf8-deae360471fb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
},
"equipment_model_id": "07507f8e-bfe3-4320-b800-1ce1013420c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "031bd572-74b3-4c80-9f3b-f7b82b63cf58",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "56ec48db-3c63-41b5-bd51-11de6e2df6cb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "66e36af7-f78e-4671-811c-7cfc17cba77f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "19c58d33-ae4c-48ba-b4fb-803947e513b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
},
"equipment_family_id": "38e7d58c-33fc-429f-864e-adc8906e0712",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "84bdb185-9966-49db-b25a-8be74a8ace46",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9a2935b-84c4-471f-a4ad-c49a8783b287",
"_parent_code": "sample string 6",
"sales_organization_id": "3de26449-c713-4ff2-bbf8-deae360471fb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
},
"date_in_production_since": "2026-08-04T21:19:33.2848377+00:00",
"date_out_of_production_since": "2026-08-04T21:19:33.2848377+00:00",
"date_end_support": "2026-08-04T21:19:33.2848377+00:00",
"sales_organization_id": "05b8fc86-374c-4e4c-b28a-a8361d69ac8a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+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-04T21:19:33.2848377+00:00"
},
"project_status_id": "82f6d6a1-6f54-4b44-a0b6-2b282ce214c4",
"project_status_code": "sample string 10",
"project_status": {
"id": "126901ad-df5e-4ed1-b1bc-14f7f72ea08b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "85fae1c6-cdb4-4e6e-9537-6d20d62b0ad9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
},
"company_id": "42ee9ef0-fd98-4d1c-8b42-e4af1c48f7bd",
"company_code": "sample string 12",
"db_address_id": "e9e662b3-6664-48be-abac-c9ee18d0bb20",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4484a91f-d038-4918-8562-a1e38af8d74f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a12c9e1e-4903-41f1-ac6c-1bb6b8d39b42",
"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-04T21:19:33.2848377+00:00",
"date_create": "2026-08-04T21:19:33.2848377+00:00",
"date_update": "2026-08-04T21:19:33.2848377+00:00",
"updated_by_user_id": "48233c1b-2188-4bbb-9353-18b980d0f528",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-04T21:19:33.2848377+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-04T21:19:33.2848377+00:00",
"date_last_job": "2026-08-04T21:19:33.2848377+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-04T21:19:33.2848377+00:00",
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00",
"is_mobile_installation": true
},
"job_type_id": "cf25e6a6-5735-44e3-bc1d-7a65c15f9acd",
"job_type_code": "sample string 7",
"job_type": {
"id": "ce79135c-fb43-41c9-bb73-2b5b27bf644f",
"name": "sample string 2",
"sales_organization_id": "153e8ae2-18d3-4aec-a993-f86d22d0e6e3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00",
"code": "sample string 7"
},
"job_priority_id": "d6e92083-0779-40a6-923e-94a221582cab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3d8404db-4e10-4a12-9acb-45349cdbe250",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "355a9bfc-2fa3-431d-8323-3761996dd8d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
},
"job_status_id": "72cfd308-3472-44e6-b966-4b06492620de",
"job_status_code": "sample string 11",
"db_address_id": "d6a4e521-27be-4f8a-9b6e-78404d531b33",
"contact_id": "84d2609f-f120-4002-89ff-e9292627a5e2",
"requested_by_company_id": "efdc1ba2-666b-4699-8518-1088ef6a7aab",
"requested_by_contact_id": "a38710d9-20f2-433f-82b4-dacdf048f89d",
"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-04T21:19:33.2848377+00:00",
"due_date": "2026-08-04T21:19:33.2848377+00:00",
"date_create": "2026-08-04T21:19:33.2848377+00:00",
"date_update": "2026-08-04T21:19:33.2848377+00:00",
"date_closed": "2026-08-04T21:19:33.2848377+00:00",
"suggested_user_id": "3b128bdb-a8e3-4c95-8288-2cc58be3e804",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "73781ea5-b432-41a9-8e18-fb5feafb1d79",
"db_language_id": "276b21db-8c4f-4856-91f4-3a08956ff177",
"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-04T21:19:33.2848377+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9feb2fb8-6e5c-4e37-a8df-1b5d1fb32dec",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e005d49b-9293-400b-9267-3cd3d1d26903",
"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": "087b4a0b-cf13-49af-a537-735a2eb54dc6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7152e4f3-0322-47c3-ba44-e5a8d5bc57c7"
},
"suggested_date_start": "2026-08-04T21:19:33.2848377+00:00",
"skill_id": "05f45498-2705-4245-b102-896225a24cf5",
"skill_code": "sample string 32",
"skill": {
"id": "ac7d9aa2-570a-4554-a3d5-39f9c46e0249",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eb19c824-33fc-49ac-aa29-6fa120d86cb3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "06a17ea0-b938-4107-b4ee-72965283d78a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "471be473-e5e5-4eff-b834-260f6a4ace88",
"db_currency_id": "d4b7610e-77b2-45c5-aafd-b30efdd467e2",
"db_language_id": "ea3f97ef-40de-4cd4-8c3b-059180a5db05",
"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-04T21:19:33.2848377+00:00"
},
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6cdcaa58-ecb5-4225-b8ab-53fd0f3dda07",
"date_reported_by_company": "2026-08-04T21:19:33.2848377+00:00",
"id2": 36,
"company_id": "2baa548a-f9e0-499c-a3c6-309a659b0b7c",
"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": "70adcf26-f3b8-4b24-b45e-97be061b7094",
"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-04T21:19:33.2848377+00:00"
},
"work_instruction_details_id": "6db6d4e1-d647-4399-9a9b-fb01c1e38076",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ee0cb31d-43f4-425e-987a-0244f64d85df",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5068c8ec-9533-411b-aaf6-c801ae11fd28",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-04T21:19:33.2848377+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": "211d069d-6a5c-418b-bb3b-4ce7bb8294c4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-04T21:19:33.2848377+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.