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": "c526e636-bbda-4b24-9547-818169d050f9",
"jobs_id": "32417b3b-c4c2-4980-9db3-8691fd4c3e59",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "86d5960c-dde1-4b9c-9568-a091bfbd2c59",
"_parent_id": "c38d0d92-bbe3-4e52-9c79-6a5e76f5b9df",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c6c5cda2-540e-48e6-a444-42ba22c5495c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "584c3ecb-943e-4b43-b0e5-aaec270812fc",
"_parent_id": "9eff527d-3616-47c3-8557-5bb7151d12b5",
"root_parent_id": "9e0bf257-1a87-4142-bff4-7a1f28462434",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "223d49ea-9add-486f-afff-6935b9d75eec",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9c906b71-244c-4055-bead-4a1dbe7a4d96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "65d2ea0a-a74c-4840-a53f-b2f7ff42696c",
"_parent_code": "sample string 6",
"sales_organization_id": "c450899b-e17e-4a86-904d-c194b8c858c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"modified_dateutc": "2026-09-30T12:06:40.9301829+00:00"
},
"equipment_model_id": "c785357a-c3ae-45ba-ba12-fcacc8e073be",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9d36c082-50d5-4af6-823b-2f421be1a608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "04871cba-23d7-4d2b-b532-88feb91239e3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0f17a204-3609-4250-b065-ff5a6858a179",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fb1d2a18-702a-4732-9011-5b21a25c612e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"modified_dateutc": "2026-09-30T12:06:40.9301829+00:00"
},
"equipment_family_id": "638738a8-e32a-41d0-b91b-59dff176d1a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9c906b71-244c-4055-bead-4a1dbe7a4d96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "65d2ea0a-a74c-4840-a53f-b2f7ff42696c",
"_parent_code": "sample string 6",
"sales_organization_id": "c450899b-e17e-4a86-904d-c194b8c858c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"modified_dateutc": "2026-09-30T12:06:40.9301829+00:00"
},
"date_in_production_since": "2026-09-30T12:06:40.9425968+00:00",
"date_out_of_production_since": "2026-09-30T12:06:40.9425968+00:00",
"date_end_support": "2026-09-30T12:06:40.9425968+00:00",
"sales_organization_id": "45b364c3-a407-4720-98f1-a7e7745c46f4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+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-09-30T12:06:40.9425968+00:00"
},
"project_status_id": "7f83c532-c6e2-4f4b-ae73-9bde4b911dd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "26b38027-1186-4a8c-bff9-8109153809e5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "39ff05f8-04d3-46ad-bb2e-8b56fa1e3d09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T12:06:40.9425968+00:00"
},
"company_id": "4edd6e52-d058-4678-8910-c2c12a223eeb",
"company_code": "sample string 12",
"db_address_id": "02bc44d0-5c6f-4935-85de-f0deea3638c1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c127566b-617d-4c80-add5-08b4c7382cc0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d343dbc2-ffc8-4593-88c4-af684f85cedf",
"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-09-30T12:06:40.9425968+00:00",
"date_create": "2026-09-30T12:06:40.9425968+00:00",
"date_update": "2026-09-30T12:06:40.9425968+00:00",
"updated_by_user_id": "b2d14a4c-cbc0-4f47-abb5-f4e13e5c9b24",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T12:06:40.9425968+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-09-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T12:06:40.9425968+00:00",
"date_last_job": "2026-09-30T12:06:40.9425968+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T12:06:40.9425968+00:00",
"modified_dateutc": "2026-09-30T12:06:40.9425968+00:00",
"is_mobile_installation": true
},
"job_type_id": "27517c49-0724-406a-9427-7d0b119f75e4",
"job_type_code": "sample string 7",
"job_type": {
"id": "e004e636-ee51-434e-8836-ccc5c46998ec",
"name": "sample string 2",
"sales_organization_id": "cfd056af-45f4-4807-9d98-898303cbf16c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T12:06:40.9425968+00:00",
"code": "sample string 7"
},
"job_priority_id": "c8424ec7-32ae-442d-bffb-3f137b029925",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "79c5940c-22c0-4ce3-a62e-efc34a90b053",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a2405234-5d04-475b-8f31-0d8495ce08d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T12:06:40.9425968+00:00"
},
"job_status_id": "1a9d73e9-9ead-431e-8e48-7a9b2dd9acac",
"job_status_code": "sample string 11",
"db_address_id": "66e4e921-a866-4c0f-8d59-1b8229e13ee2",
"contact_id": "7ed5d564-da6f-4c6b-95c8-38dc41cb9c21",
"requested_by_company_id": "99b4eb8d-e64a-4185-b4b0-bab0be724e31",
"requested_by_contact_id": "2d4a1b4f-5979-4e1f-a05a-207b8b44a123",
"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-09-30T12:06:40.9425968+00:00",
"due_date": "2026-09-30T12:06:40.9425968+00:00",
"date_create": "2026-09-30T12:06:40.9425968+00:00",
"date_update": "2026-09-30T12:06:40.9425968+00:00",
"date_closed": "2026-09-30T12:06:40.9425968+00:00",
"suggested_user_id": "00c20a92-21ff-4bab-8fdb-49f1c8ebb120",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e8433c95-31d4-4052-b1bb-969a4dc49724",
"db_language_id": "90862925-187b-4f80-af17-5916f81c2455",
"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-09-30T12:06:40.9425968+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "446c69a8-1d2f-4892-bea1-a499bd7e5bf3",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2797e3b5-17b9-47e1-98f9-91a62264d079",
"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": "9aeaf196-6b26-42c9-8fac-9c1371553302",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T12:06:40.9425968+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4f82fd38-bffc-4fba-a2f7-7a4b5dec41a4"
},
"suggested_date_start": "2026-09-30T12:06:40.9425968+00:00",
"skill_id": "7f033f8b-4063-4772-8246-e3f2f09c06e8",
"skill_code": "sample string 32",
"skill": {
"id": "0ec41169-2850-4184-943a-1054b3045e78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "669e0d69-b2d8-47f8-9217-cfea591ced23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "83a1332d-e8e1-4ff2-aac1-308106a85b4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "492aee3b-03a3-4e6f-8618-b1a0a0391097",
"db_currency_id": "12b20184-874b-4aca-9451-16feba30f9b1",
"db_language_id": "5fbe38ea-04b5-4f19-9eb5-f64af494ff19",
"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-09-30T12:06:40.9301829+00:00"
},
"modified_dateutc": "2026-09-30T12:06:40.9425968+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f70abf96-6b89-47cb-a0a5-c6192c698fb9",
"date_reported_by_company": "2026-09-30T12:06:40.9425968+00:00",
"id2": 36,
"company_id": "44736086-6b75-4c43-9779-4c6443073d42",
"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": "e4829717-b5f7-487a-ba79-aa90ea448fdc",
"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-09-30T12:06:40.9425968+00:00"
},
"work_instruction_details_id": "c7c1f7b6-701f-4243-b2ac-d3747398697d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "848ba0f3-ddf1-42ae-823f-09f037d1c344",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fa37323d-f4b6-42be-a0fc-dff813dacce6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T12:06:40.960256+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": "d1a265b6-ae1c-4ea4-8a25-39c37a7f5c38",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T12:06:40.960256+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.