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": "f7bdaf2b-7ebd-4bd1-8f7f-c2aee9720843",
"jobs_id": "ac9b27ba-45b6-4e3f-b356-a796c49566e1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1538d661-e4b8-4f55-9450-2faacf84d402",
"_parent_id": "daf8574f-6667-4cd6-a1e0-eb8b4ed8ff3b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ff6c8a8f-4cc5-4704-9b69-68f9ab4a1697",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b159d4aa-ad52-4ee5-ba21-87cfbd5ca739",
"_parent_id": "28eb0a84-b0c0-4ed3-b361-0da142dcef59",
"root_parent_id": "11040d63-5902-4fbd-b4e1-cb964677f9b8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3cadb086-7590-4b7e-94dd-b325e711e026",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "286e5bc2-50a2-491c-8344-8dc7ac160fcb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8dbf2140-7661-40e7-89fa-46a99cd3e6ed",
"_parent_code": "sample string 6",
"sales_organization_id": "a568f0ef-0296-4e6a-8a48-a9598ee99354",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
},
"equipment_model_id": "c67ed60e-d997-441e-981e-f9a96e1d9603",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dbbf5621-8688-4b55-b847-4148ae38c0c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f993f736-da01-4511-a707-648ec5bd4845",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f832b677-1d25-44f7-8461-4097cf3dd679",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c31c136-303f-4936-8347-b16f37802cb3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
},
"equipment_family_id": "5b2ff0a9-d0fb-4fca-8dfe-308852cc4576",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "286e5bc2-50a2-491c-8344-8dc7ac160fcb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8dbf2140-7661-40e7-89fa-46a99cd3e6ed",
"_parent_code": "sample string 6",
"sales_organization_id": "a568f0ef-0296-4e6a-8a48-a9598ee99354",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
},
"date_in_production_since": "2026-11-09T18:44:26.6281959+00:00",
"date_out_of_production_since": "2026-11-09T18:44:26.6281959+00:00",
"date_end_support": "2026-11-09T18:44:26.6281959+00:00",
"sales_organization_id": "bd5d72e3-b38c-44bb-9558-3c83f31ec449",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+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-09T18:44:26.6281959+00:00"
},
"project_status_id": "2403c8c3-161a-4830-b829-53ed23b364ee",
"project_status_code": "sample string 10",
"project_status": {
"id": "39bc0bdc-4396-4e32-819e-1f189cbca098",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d858d097-635b-416c-8327-05578e2b6096",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
},
"company_id": "3548998e-1b3d-489e-98f9-70cfa0bfe1d3",
"company_code": "sample string 12",
"db_address_id": "d4aeecf2-38a6-4e17-a430-1b72888cf73a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c1d62102-1cf6-4280-b566-5b1f7a5475fd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "24c70a4d-c70a-4716-bed2-a53f32e97154",
"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-09T18:44:26.6281959+00:00",
"date_create": "2026-11-09T18:44:26.6281959+00:00",
"date_update": "2026-11-09T18:44:26.6281959+00:00",
"updated_by_user_id": "dd3fc1ba-d69e-4bfc-b931-77c4e7a8848c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-09T18:44:26.6281959+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-09T18:44:26.6281959+00:00",
"date_last_job": "2026-11-09T18:44:26.6281959+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-09T18:44:26.6281959+00:00",
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00",
"is_mobile_installation": true
},
"job_type_id": "44b70f14-9e36-4743-937d-63ca3438b185",
"job_type_code": "sample string 7",
"job_type": {
"id": "518a0e16-b5e1-49e2-8e26-81788d2cb173",
"name": "sample string 2",
"sales_organization_id": "79bf6294-d63d-4b40-9692-6802a131350b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00",
"code": "sample string 7"
},
"job_priority_id": "fd070456-4551-4097-94fe-f3bb6b7aff09",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f5f54c46-2e54-4a08-8726-e797903bcf52",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "426540bf-1dec-46f0-9dcd-1d8d801c1137",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
},
"job_status_id": "ed8be329-361b-4502-82d5-106b94a5a305",
"job_status_code": "sample string 11",
"db_address_id": "32229200-b52c-4649-aa7b-2fef968678fd",
"contact_id": "3917d4b6-d7e4-49cf-9999-2c92e43ffbe6",
"requested_by_company_id": "54101cc5-94a1-4cca-a0a4-59b9ea85dd1f",
"requested_by_contact_id": "be176b41-c261-42d0-88d6-2470fb673c20",
"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-09T18:44:26.6281959+00:00",
"due_date": "2026-11-09T18:44:26.6281959+00:00",
"date_create": "2026-11-09T18:44:26.6281959+00:00",
"date_update": "2026-11-09T18:44:26.6281959+00:00",
"date_closed": "2026-11-09T18:44:26.6281959+00:00",
"suggested_user_id": "c9dff4b1-defc-45e2-870f-e6409eb961aa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "33a5b7ec-454d-42ef-b472-dac1f7cf5429",
"db_language_id": "1311cf33-65e7-4f64-8b65-fe7e27d24896",
"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-09T18:44:26.6281959+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "094b26c9-2f61-418b-a1c5-d32c97d5efda",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "db86e845-2f0b-4638-9ba4-60ada6d3c955",
"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": "4856883e-d8e3-4d31-a6dd-20104a3e2f46",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "da1055d2-a702-4be9-afec-efa7c5ffec75"
},
"suggested_date_start": "2026-11-09T18:44:26.6281959+00:00",
"skill_id": "70bc683e-eb8b-40a4-8bba-7bba1d8c8041",
"skill_code": "sample string 32",
"skill": {
"id": "936025d4-4c14-47ab-a4dd-5feaadf04c10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "698d718a-6e11-4527-8fce-9f5efdd81ee4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b6c4b7c5-e591-40ed-a089-87a2ff6aaab1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f04558a4-4a37-4182-a378-81589ea2c0b2",
"db_currency_id": "b3e9d37c-7ee9-4bdc-acf1-afc2353ca8e5",
"db_language_id": "f217233f-26c7-4cdb-9b1d-56acbcb4ac6c",
"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-09T18:44:26.6281959+00:00"
},
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "316b7efc-0290-4b8f-952b-4d5a473c81ec",
"date_reported_by_company": "2026-11-09T18:44:26.6281959+00:00",
"id2": 36,
"company_id": "a3bb6434-ff63-4df2-beae-94ee7c1c277a",
"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": "80415590-20ef-4848-b800-6582ebb8169b",
"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-09T18:44:26.6281959+00:00"
},
"work_instruction_details_id": "e8c00bab-8819-4447-b28b-662a970854ae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6a383870-8646-4b73-abca-25467e1780fb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "974cc026-a02c-4331-9cd2-7d584ab324a5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-09T18:44:26.6281959+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": "3ee56aee-84ed-427e-90fc-816a7720ca59",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-09T18:44:26.6281959+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.