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": "19fb9d34-7ba0-4fab-a0a5-8e0b75192e95",
"jobs_id": "fc7041b3-7700-4f42-99a2-18ad64489d8d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "46862b57-55e9-49c1-af9d-3b890b7f85a8",
"_parent_id": "db18b0ea-a125-4430-9040-20caca7ddb24",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fc191bc0-b0fc-4c91-946f-18c49db0763a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d35b337b-ac6e-4efe-b99b-e51415401085",
"_parent_id": "5ebd140c-2b6a-47a5-9093-5a257c1f46f2",
"root_parent_id": "e367dc0c-b9fa-4db1-b1d9-dc561d460284",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "028a6c92-a709-4497-ba29-b823b57bb131",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "950943d9-3ab1-409f-b7d8-c3c429e86eed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "961a403d-e2f5-482d-b5ac-231ed3be2652",
"_parent_code": "sample string 6",
"sales_organization_id": "b452d576-2dac-4cbc-9638-d6554efd978a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"modified_dateutc": "2026-05-07T00:30:20.1265052+00:00"
},
"equipment_model_id": "d6a958e0-3dce-4198-94c0-63fc4bfb1b4e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db04307f-3cf7-4246-988b-0d67cd13fcdd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e9f58481-8e06-4322-8ab9-f600790e3e7f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8d728bd1-6d85-424f-a2df-718233de8f41",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "19edf208-9b2b-4189-8263-2927eb34fbec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"modified_dateutc": "2026-05-07T00:30:20.1265052+00:00"
},
"equipment_family_id": "126088bc-603a-4fc3-9c57-1deade1f23ea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "950943d9-3ab1-409f-b7d8-c3c429e86eed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "961a403d-e2f5-482d-b5ac-231ed3be2652",
"_parent_code": "sample string 6",
"sales_organization_id": "b452d576-2dac-4cbc-9638-d6554efd978a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"modified_dateutc": "2026-05-07T00:30:20.1265052+00:00"
},
"date_in_production_since": "2026-05-07T00:30:20.1265052+00:00",
"date_out_of_production_since": "2026-05-07T00:30:20.1265052+00:00",
"date_end_support": "2026-05-07T00:30:20.1265052+00:00",
"sales_organization_id": "b685f1e8-7d1c-4b43-8e78-87a4f69aa4d5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+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-05-07T00:30:20.1421315+00:00"
},
"project_status_id": "dd0e242e-e3af-4730-9fc9-4f45c6ea2339",
"project_status_code": "sample string 10",
"project_status": {
"id": "030a5e4a-3337-466e-b75f-36269ea73828",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b1cc55f4-31bc-426e-8ef2-e22a9139243a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00"
},
"company_id": "6b8800ac-5339-460a-902b-3af671a8000b",
"company_code": "sample string 12",
"db_address_id": "eb6a4056-a6b3-49b9-87ac-8a5b72c55da0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00ca7ac5-99d5-4c87-ac56-1c5397b1eb76",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ea4fb6c8-ffd5-4ac1-b1e3-c703233cef4d",
"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-05-07T00:30:20.1421315+00:00",
"date_create": "2026-05-07T00:30:20.1421315+00:00",
"date_update": "2026-05-07T00:30:20.1421315+00:00",
"updated_by_user_id": "4abbeca7-69db-443d-a485-b3d728e5b87f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T00:30:20.1421315+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-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T00:30:20.1421315+00:00",
"date_last_job": "2026-05-07T00:30:20.1421315+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T00:30:20.1421315+00:00",
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00",
"is_mobile_installation": true
},
"job_type_id": "e5d47597-d186-40ae-98af-5ee608f99484",
"job_type_code": "sample string 7",
"job_type": {
"id": "6dd0ef67-0b22-49c5-886f-43f37e608fa3",
"name": "sample string 2",
"sales_organization_id": "b027422d-90ab-4564-b354-2f42095fe64f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00",
"code": "sample string 7"
},
"job_priority_id": "316c1a05-afb5-4ebc-8234-f27041744ada",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "00ec64c4-f63b-4457-b6b8-bee0cefe2445",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7c0e6480-472e-4f21-8f32-1810fb843703",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00"
},
"job_status_id": "98e127cc-89d6-4990-9635-16678ab91614",
"job_status_code": "sample string 11",
"db_address_id": "29c0d266-8ced-4c27-871f-04660769a287",
"contact_id": "0f5def75-3f15-49e4-ab54-4e35c4e488e0",
"requested_by_company_id": "78a4d2eb-1f4b-473f-91d3-4a8444c39832",
"requested_by_contact_id": "06db41ca-2473-4454-a51d-8135a557021d",
"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-05-07T00:30:20.1421315+00:00",
"due_date": "2026-05-07T00:30:20.1421315+00:00",
"date_create": "2026-05-07T00:30:20.1421315+00:00",
"date_update": "2026-05-07T00:30:20.1421315+00:00",
"date_closed": "2026-05-07T00:30:20.1421315+00:00",
"suggested_user_id": "59188c12-6af6-4222-be51-995c0b595fc6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7e397ac9-d065-4c3f-b4f1-2c1bf61bc10f",
"db_language_id": "8661e161-7be8-4004-ad0d-a019bff913f6",
"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-05-07T00:30:20.1421315+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2848fbf8-d396-4995-aca6-ff2d52a724b8",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "88cb7493-edcf-4c76-9744-22037165cd71",
"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": "278f1ce8-fd36-4c2d-963e-34a02daf407b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b2367396-1447-4a66-b76f-759d2b229190"
},
"suggested_date_start": "2026-05-07T00:30:20.1421315+00:00",
"skill_id": "fac5b143-e8c2-4813-a275-b415dd81e957",
"skill_code": "sample string 32",
"skill": {
"id": "2942b1a8-1b17-4f99-b662-3df229a4c930",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "38657486-6503-42af-948b-d078109ef57a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2405e1b3-5d34-4a2f-a8cf-4e8f78828100",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a12a3707-cc25-4340-85a9-6beedcb6741f",
"db_currency_id": "677c171c-a54e-4619-a822-7cc5b04c3092",
"db_language_id": "924a8c39-8f93-44e4-9276-36be5ba1eb72",
"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-05-07T00:30:20.1265052+00:00"
},
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c25dc07c-bd13-4b09-9048-a22f3da03171",
"date_reported_by_company": "2026-05-07T00:30:20.1421315+00:00",
"id2": 36,
"company_id": "7612a202-47d7-414a-af73-aa5be85276cd",
"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": "2230c168-0174-43cf-98e0-a58e44d8c7f2",
"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-05-07T00:30:20.1421315+00:00"
},
"work_instruction_details_id": "b92c4d8e-c798-4d4d-93c8-61f04f34d005",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95e7a80f-9683-491a-9e50-dbf4614131a5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e4d39b7d-d044-4e15-a3ae-69ec8b72622d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T00:30:20.1421315+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": "355a1f80-8d81-4d30-82d5-c9ce9c9a24f8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T00:30:20.1421315+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.