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": "50fd9817-1f47-4091-945e-2024e60f38d8",
"jobs_id": "0eabbaa2-1090-43b3-9ae6-750e10c9f853",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "faa4b3df-f962-40ec-b3fd-ceb796e57b8b",
"_parent_id": "e151a966-0af1-4071-8b12-fdf2634dcf77",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e1f5daf2-c419-449b-ba7f-1de8a3900f84",
"project_reference_back_office": "sample string 5",
"project": {
"id": "010a4516-b83b-4fc9-a661-84d60f09315e",
"_parent_id": "4a5acb58-21aa-4e3e-9574-b2328c4f117a",
"root_parent_id": "3902cbf2-9416-4886-8b4a-e7c041b254ab",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d9ca1316-d011-4a6a-9215-1a2f8d947baa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0faaa568-4fef-4330-bf47-86dacaafbd4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13f09c94-aab3-48ac-a85c-45a50523009f",
"_parent_code": "sample string 6",
"sales_organization_id": "7769ae05-9d2c-4694-ae92-911ecae138b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
},
"equipment_model_id": "0f629982-e877-43af-a64b-e764b3193f6f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c05962c-589a-43b8-9968-6eff60b41495",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1190cce7-92e1-4969-ad2b-0d86ba225052",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "94d6e730-ab06-4884-b31d-10b065282838",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f1513c1-0114-4895-b8b4-c4452eb968c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
},
"equipment_family_id": "9f152c23-a123-42e1-b084-879f81ea8f0f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0faaa568-4fef-4330-bf47-86dacaafbd4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "13f09c94-aab3-48ac-a85c-45a50523009f",
"_parent_code": "sample string 6",
"sales_organization_id": "7769ae05-9d2c-4694-ae92-911ecae138b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
},
"date_in_production_since": "2026-03-09T05:38:38.4352719+00:00",
"date_out_of_production_since": "2026-03-09T05:38:38.4352719+00:00",
"date_end_support": "2026-03-09T05:38:38.4352719+00:00",
"sales_organization_id": "22e639e0-64fa-4ad9-9bc5-6cd791161229",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+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-03-09T05:38:38.4352719+00:00"
},
"project_status_id": "88d44ec7-c2c3-4381-9d89-f9fee0d5d7fb",
"project_status_code": "sample string 10",
"project_status": {
"id": "7c6b8fbe-c6fd-49e3-aff5-fd04be66da4f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "007e2844-9b07-4444-a10c-951971f5c402",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
},
"company_id": "3aff68b0-d781-468b-b41d-9d3ace131f10",
"company_code": "sample string 12",
"db_address_id": "ebaf98e1-33ff-4303-b027-142f38bdaeaa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7c2f4dc9-c74e-48f9-b6ce-72b613a6a798",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5c397351-11cb-4690-96d5-686d1b8cd12d",
"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-03-09T05:38:38.4352719+00:00",
"date_create": "2026-03-09T05:38:38.4352719+00:00",
"date_update": "2026-03-09T05:38:38.4352719+00:00",
"updated_by_user_id": "5d245fb2-3c46-4276-a89b-57e529c1da6b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-09T05:38:38.4352719+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-03-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-09T05:38:38.4352719+00:00",
"date_last_job": "2026-03-09T05:38:38.4352719+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-09T05:38:38.4352719+00:00",
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00",
"is_mobile_installation": true
},
"job_type_id": "0969589b-a096-441c-9d15-08fd3fac09a7",
"job_type_code": "sample string 7",
"job_type": {
"id": "851302c7-47b3-4b4f-a3e3-215e7724122c",
"name": "sample string 2",
"sales_organization_id": "e8fa4dc9-ef8d-4ee8-becc-233c1226a8aa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00",
"code": "sample string 7"
},
"job_priority_id": "b2e50234-3f91-4f7c-8629-0bbbc01e7951",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "70bbe39c-c3e7-467e-b393-7e46e4ff5aae",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1c84b46a-2c41-4d89-819f-8894e7047b36",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
},
"job_status_id": "b6ae7337-e591-4727-b56f-b380e2947764",
"job_status_code": "sample string 11",
"db_address_id": "5e290138-c8a4-40d8-8e8e-510d6f715668",
"contact_id": "abf2cfa9-de1c-4026-91ef-0ddfdab7f7c1",
"requested_by_company_id": "549d9c93-065a-4d71-861b-38135285e916",
"requested_by_contact_id": "7c2a834c-0634-4108-9724-ed5bd15d5dec",
"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-03-09T05:38:38.4352719+00:00",
"due_date": "2026-03-09T05:38:38.4352719+00:00",
"date_create": "2026-03-09T05:38:38.4352719+00:00",
"date_update": "2026-03-09T05:38:38.4352719+00:00",
"date_closed": "2026-03-09T05:38:38.4352719+00:00",
"suggested_user_id": "141ee544-fe6f-4e92-98de-bb9e5299414f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f70949df-0153-4ab6-b0d8-937275c7af6e",
"db_language_id": "cd54a491-ff13-413e-9eef-f90a89817a5e",
"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-03-09T05:38:38.4352719+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "725e5de4-f392-4889-bb0d-131f19c84b5d",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2aca6e9d-11db-4cba-8cf4-c214915577e2",
"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": "5bfeb572-676c-4b51-aacc-a94dde812c70",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9847306d-c5dd-44ce-96e7-80584d7381d6"
},
"suggested_date_start": "2026-03-09T05:38:38.4352719+00:00",
"skill_id": "143b11cc-518a-4fd1-93ff-777b3f29ea56",
"skill_code": "sample string 32",
"skill": {
"id": "243eb583-332f-48cb-9f24-36ee5527c31f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aba5a223-d663-4e16-8f3f-fe8fad3c90fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7a32eca7-9ee9-4714-b45e-7e3fe7185087",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a33a392-1fd1-43bc-b9c5-af49dc7d423a",
"db_currency_id": "762c72dc-1762-4d8a-b78f-32ab278343ed",
"db_language_id": "306da170-daeb-4e3f-b093-ea80bec4082c",
"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-03-09T05:38:38.4352719+00:00"
},
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f1654856-0c79-4062-8355-1fa188aa3282",
"date_reported_by_company": "2026-03-09T05:38:38.4352719+00:00",
"id2": 36,
"company_id": "2257f79c-02db-404a-ba84-f82caf877e26",
"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": "2e3ecdb0-905f-4ecf-8d36-bec8d482187c",
"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-03-09T05:38:38.4352719+00:00"
},
"work_instruction_details_id": "13438e30-7695-47c4-8e58-0449c18e5809",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55efac7a-9ea7-46bc-89d1-a68818093f1d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f58cf998-1965-433f-90f0-68fc6783030c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-09T05:38:38.4352719+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": "65c0ee32-b5cd-482f-82d6-ed45639a6273",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-09T05:38:38.4352719+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.