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": "dfa767cd-1e93-463d-990f-4af471b430b6",
"jobs_id": "5f37e353-5d17-4959-a2e5-688d53c7af61",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1738f3f6-b5a0-4b5d-8dff-ee99ec13cd6e",
"_parent_id": "1e8d2b16-0742-4263-9db4-8dcd96a396e0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bc2318cf-8330-49b1-a99c-f6c23a5fe5e4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "382350a0-2334-433e-afd5-6799010e884e",
"_parent_id": "7d591730-e1d4-4a75-b87c-786facaa99be",
"root_parent_id": "10cb7690-4d50-4fda-8bd9-b61858e5bbfd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "50950438-d129-4089-8313-ff873d343c79",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "10f7fd1f-4190-445f-82c1-a91b3d8d7953",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d6cdfa1b-28ca-45d3-acab-8a2461bc5860",
"_parent_code": "sample string 6",
"sales_organization_id": "d7bc2427-289a-4e30-af01-1240dc7f708d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
},
"equipment_model_id": "6dc0744b-8939-4fec-81d3-ba46e20a6ffb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a59d3c54-6ce1-4235-a7db-409e0c2af2a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c7c13410-78c8-4a8d-afac-9bf1d745ad08",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0c424915-757d-496e-a5c6-48537df725f8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a6c0f84d-527b-4821-a15c-f7552922fad0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
},
"equipment_family_id": "af7e5f0e-0621-4f13-8bbb-abb1c0d4095c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "10f7fd1f-4190-445f-82c1-a91b3d8d7953",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d6cdfa1b-28ca-45d3-acab-8a2461bc5860",
"_parent_code": "sample string 6",
"sales_organization_id": "d7bc2427-289a-4e30-af01-1240dc7f708d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
},
"date_in_production_since": "2026-07-18T04:39:16.1735435+00:00",
"date_out_of_production_since": "2026-07-18T04:39:16.1735435+00:00",
"date_end_support": "2026-07-18T04:39:16.1735435+00:00",
"sales_organization_id": "b4affabe-0cd4-4616-9c4e-ea2e3ba866af",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+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-07-18T04:39:16.1735435+00:00"
},
"project_status_id": "fae07ed2-90ed-481b-b490-f3177859db12",
"project_status_code": "sample string 10",
"project_status": {
"id": "02f3b427-c83a-4fee-8e35-3ff118443d56",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1f7ba8e8-fff5-4065-bea0-e0efeabe1ef3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
},
"company_id": "783ce6a2-3ca7-4b15-add9-b4b082aefa86",
"company_code": "sample string 12",
"db_address_id": "0122c5e4-329d-45b3-af5d-d05a2211b0ad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "be1232ac-58b3-41ff-8d70-2ca3d58122b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "60461a5f-69bb-43f3-a1bc-8869b0ef9a8c",
"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-07-18T04:39:16.1735435+00:00",
"date_create": "2026-07-18T04:39:16.1735435+00:00",
"date_update": "2026-07-18T04:39:16.1735435+00:00",
"updated_by_user_id": "f92a3ee4-a115-40e5-bf62-0cbdf01a435e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-18T04:39:16.1735435+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-07-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-18T04:39:16.1735435+00:00",
"date_last_job": "2026-07-18T04:39:16.1735435+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-18T04:39:16.1735435+00:00",
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00",
"is_mobile_installation": true
},
"job_type_id": "8880b08f-8f12-4e1b-b1a2-73f30dfd2688",
"job_type_code": "sample string 7",
"job_type": {
"id": "15a914a0-cacc-41dd-b285-a7d3ba14195a",
"name": "sample string 2",
"sales_organization_id": "52ec220a-5b67-4036-bae8-185cc499dd54",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00",
"code": "sample string 7"
},
"job_priority_id": "fce5840c-40d4-40ac-a152-5f0372f5f6b1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ff5e4ce9-b4a1-4b34-8376-5334cb37756c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5bb55209-ba81-48e6-b6bc-20c4ea99a36b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
},
"job_status_id": "a68850f3-c580-438e-b6f2-86f5ca48ad7d",
"job_status_code": "sample string 11",
"db_address_id": "618c7382-497c-4d7e-b721-252a683b5ccf",
"contact_id": "ff193a38-09dd-492c-bf51-bcedf099a903",
"requested_by_company_id": "e5134721-9d56-4557-b77e-2f2471eb6e6b",
"requested_by_contact_id": "6e9262ca-0813-47b6-829d-e6f7f56b4460",
"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-07-18T04:39:16.1735435+00:00",
"due_date": "2026-07-18T04:39:16.1735435+00:00",
"date_create": "2026-07-18T04:39:16.1735435+00:00",
"date_update": "2026-07-18T04:39:16.1735435+00:00",
"date_closed": "2026-07-18T04:39:16.1735435+00:00",
"suggested_user_id": "6fa6e38e-bd90-4508-b9eb-d145e2d40780",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "28e780b4-d875-4b6f-aeb1-8d46beb44a69",
"db_language_id": "de7e89c7-f802-4c8a-b9f5-7b8f9f30f84b",
"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-07-18T04:39:16.1735435+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6c788897-5999-4dc4-b78c-c218a7a06961",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "55dfcb84-459b-4fc9-a5ef-c732a6c82437",
"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": "ef58ea9a-de94-4620-93ca-75be7ee32b98",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e00b0808-312e-41c4-bd4c-8b7dc4f1c46a"
},
"suggested_date_start": "2026-07-18T04:39:16.1735435+00:00",
"skill_id": "8b8194f9-5edf-439b-8a74-2ef15a0b29a4",
"skill_code": "sample string 32",
"skill": {
"id": "b4f3e016-72af-4197-8e5b-aab428a780ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1b49485c-158f-41dd-9a1d-44a7565cd2d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00792f9d-be48-402e-8dd1-56de5c6de3c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73ce36c9-ff3f-4f17-821e-50b8f3c7873d",
"db_currency_id": "f4da598f-2b33-44c9-8c6e-eba990aa6e14",
"db_language_id": "35178d79-11f6-4802-b168-b16d47c15992",
"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-07-18T04:39:16.1735435+00:00"
},
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3c89ca03-7348-4ad9-9c6e-dffd8004fdf4",
"date_reported_by_company": "2026-07-18T04:39:16.1735435+00:00",
"id2": 36,
"company_id": "c7b89f36-56ac-4e42-82fa-fec4d1472106",
"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": "b213c1e1-12a3-4370-9b7e-96c530b9960d",
"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-07-18T04:39:16.1735435+00:00"
},
"work_instruction_details_id": "4e5c80f6-36fb-408a-8aae-5035f79dfc7c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f5ab1b19-de52-4038-ba93-9f88bc2207d3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "02b81091-de3f-4bcc-b7e7-5baa0fbc0c62",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-18T04:39:16.1735435+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": "b505326d-dd78-4ce9-8908-aeb845827b20",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-18T04:39:16.1735435+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.