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": "dce05efc-14ea-4220-9a60-5a877706b92b",
"jobs_id": "8296a4e9-d9fa-4f4a-8334-03ffca7606a0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ce9e64b6-b95f-4c70-9dd9-76d61817f823",
"_parent_id": "7125039b-710e-415f-bf69-ae489b6fe267",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "801c0ec8-1996-4528-9aca-3982d3d20140",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bd08cc1a-95c4-4887-8ccb-880462973003",
"_parent_id": "9570e50e-38d7-474d-b602-8a011d822a97",
"root_parent_id": "56df26f9-e80d-49c9-913f-0bedcee6f5db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a6b127e0-9984-4295-833c-73b2238f602e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ffbc8ff9-b64d-441b-8e00-fd79f1597df6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d5fad230-77b8-4fcf-97ff-a3630d73f6f7",
"_parent_code": "sample string 6",
"sales_organization_id": "0c564603-ccfb-410b-87cf-81bbcecda30a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
},
"equipment_model_id": "d0090f91-c93c-4682-940f-b569319e14db",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e3582d5a-b31b-4944-b091-a3332a048f2d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "89a41769-b24d-4070-9188-3d1595fb3964",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c24415d7-519d-4896-a0ec-7ddf58d5a293",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ccc3ef8b-0499-4399-bce8-6198396cd372",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
},
"equipment_family_id": "1da17ff7-7199-4ea5-b92b-cdb5157e3066",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ffbc8ff9-b64d-441b-8e00-fd79f1597df6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d5fad230-77b8-4fcf-97ff-a3630d73f6f7",
"_parent_code": "sample string 6",
"sales_organization_id": "0c564603-ccfb-410b-87cf-81bbcecda30a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
},
"date_in_production_since": "2026-09-09T09:27:58.3164952+00:00",
"date_out_of_production_since": "2026-09-09T09:27:58.3164952+00:00",
"date_end_support": "2026-09-09T09:27:58.3164952+00:00",
"sales_organization_id": "e7bcdd62-bbaf-4b3a-a9e4-e63f5f88871d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+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-09T09:27:58.3164952+00:00"
},
"project_status_id": "217e6b4c-ad6e-431f-adaf-e7c429d2b4c9",
"project_status_code": "sample string 10",
"project_status": {
"id": "4af17063-b674-4d81-9aa0-a8702b5d5647",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4b4def39-2dd4-4f88-a03f-6ede799141cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
},
"company_id": "a9b5a771-041e-4334-8241-1cf7b078f258",
"company_code": "sample string 12",
"db_address_id": "c4dec67a-75b4-4540-8cbd-f9d13ed79b77",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fb32eb26-7c6f-4913-977c-d55ddb47f695",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cf50258b-3702-4af0-af51-690fb5c9eadd",
"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-09T09:27:58.3164952+00:00",
"date_create": "2026-09-09T09:27:58.3164952+00:00",
"date_update": "2026-09-09T09:27:58.3164952+00:00",
"updated_by_user_id": "3ea190c5-6c8f-4e71-8dce-036009773985",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-09T09:27:58.3164952+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-09T09:27:58.3164952+00:00",
"date_last_job": "2026-09-09T09:27:58.3164952+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-09T09:27:58.3164952+00:00",
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00",
"is_mobile_installation": true
},
"job_type_id": "e9c4fcf8-8aa2-416a-9713-d510ba0bf66b",
"job_type_code": "sample string 7",
"job_type": {
"id": "00f646b6-a4cd-4ebe-8ff6-e6431a8fe32a",
"name": "sample string 2",
"sales_organization_id": "15c2d593-9344-4cec-90df-a15ee0d69d6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00",
"code": "sample string 7"
},
"job_priority_id": "b659062f-b2be-4e29-9b4d-aca96e830df0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dd791ae3-f93f-4379-8505-f08f36f53691",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4a61186f-a9ab-4e14-b3b2-ce2b881926da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
},
"job_status_id": "20334c02-c7e0-4c8e-ab73-680cbd7df269",
"job_status_code": "sample string 11",
"db_address_id": "32365797-21e5-4826-af92-309685ea43d1",
"contact_id": "d3ca0583-59fa-4ca9-9044-323642c5a8a9",
"requested_by_company_id": "7e828884-8175-4ded-a158-23bfe812c565",
"requested_by_contact_id": "bdddb087-77cb-4fa7-95de-3d8e383fd19c",
"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-09T09:27:58.3164952+00:00",
"due_date": "2026-09-09T09:27:58.3164952+00:00",
"date_create": "2026-09-09T09:27:58.3164952+00:00",
"date_update": "2026-09-09T09:27:58.3164952+00:00",
"date_closed": "2026-09-09T09:27:58.3164952+00:00",
"suggested_user_id": "f0c9993f-71ef-41c3-b1e4-086ffdc0f7a2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "848d16fe-880d-4f1c-a8e1-9449d402bb7a",
"db_language_id": "9a4c40a0-adc8-4310-af66-ecfe59cb293f",
"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-09T09:27:58.3164952+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4441fe2b-5feb-47f9-b2d9-a13d6fb298e7",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b8279ef-fa85-46ba-acca-97e5e3fc9a3b",
"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": "7f8a9be9-f923-4558-9a3c-b6876d4e5ed8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "14b6adbe-a7ca-4207-9d09-9aa726b3adf0"
},
"suggested_date_start": "2026-09-09T09:27:58.3164952+00:00",
"skill_id": "8f5377e5-08db-4b1f-a7d6-3a3f0b3cbd84",
"skill_code": "sample string 32",
"skill": {
"id": "a9f0fc32-9edb-4795-ada2-cd9099d90af7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c3c4fd69-8d0d-415a-b335-ee7fad514dfa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e63fa71e-9c3e-4cc2-a5d3-958712815864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1826db07-bc34-482b-809d-a287978d7f82",
"db_currency_id": "ccc3317a-f339-4d7f-89c3-26497c95fd31",
"db_language_id": "c88e1607-c273-4154-804e-d6dda00401d7",
"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-09T09:27:58.3164952+00:00"
},
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0a364daf-72c8-4d5e-a30e-f592630b90f9",
"date_reported_by_company": "2026-09-09T09:27:58.3164952+00:00",
"id2": 36,
"company_id": "5070532a-4231-474f-82de-0c3ce29d310b",
"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": "9968ce6f-b060-4b6f-a038-0964b7241630",
"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-09T09:27:58.3164952+00:00"
},
"work_instruction_details_id": "f40fe906-dea3-47e0-bc67-53a150c1596d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8f24d2e7-ff48-41d3-869a-db2b2773faa2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c77568f0-7194-4c7f-acf4-e1f978d761ae",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-09T09:27:58.3164952+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": "9d3ab09f-b0cf-4be5-bc46-f423e6a1d002",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-09T09:27:58.3164952+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.