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": "54fe3f9d-92c3-4b71-853b-5a3eee279ca5",
"jobs_id": "8393f4cd-4e5b-4c72-aa26-1214edaa75b3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "16607c94-0e6d-45a1-a32a-c0736bcc34b2",
"_parent_id": "0749fcdd-5b3e-4f37-b22b-43c9e73a6569",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "230ab36a-1da6-4791-831e-35628775d9f7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "737ab445-6960-4bb3-9021-b2bc6b512231",
"_parent_id": "dbb79350-d5d6-411f-9f73-b5a51a8a96a7",
"root_parent_id": "6cfbd4d0-6a21-4c02-b3fe-178ecc95657c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "992bccd8-80be-4aec-838b-3a9c92fb5d91",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9b75b099-8ac9-4940-bb03-2b9080156a95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a07fa92a-980e-4e3a-8820-4a6b4464375b",
"_parent_code": "sample string 6",
"sales_organization_id": "eed5f3c7-c14a-448e-962f-16be67db4777",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00"
},
"equipment_model_id": "321284ca-7d79-40ca-abdb-48f2f9f31724",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7e1942ad-b5d2-475f-b630-85fc1ecf1dee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8db52cbe-0faf-4755-88c8-f8c068787105",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "33a0831d-9e54-4ee7-8c17-89615daa90b5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0945146a-8b1e-4eec-9b16-6ca84e83e405",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00"
},
"equipment_family_id": "4d498a03-a7ad-431b-949c-4ed48fed5e2d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9b75b099-8ac9-4940-bb03-2b9080156a95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a07fa92a-980e-4e3a-8820-4a6b4464375b",
"_parent_code": "sample string 6",
"sales_organization_id": "eed5f3c7-c14a-448e-962f-16be67db4777",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00"
},
"date_in_production_since": "2026-08-31T05:50:07.7974268+00:00",
"date_out_of_production_since": "2026-08-31T05:50:07.7974268+00:00",
"date_end_support": "2026-08-31T05:50:07.7974268+00:00",
"sales_organization_id": "caa3e4b4-8ce5-4d64-8a0d-9e32697e98c7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+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-08-31T05:50:07.7974268+00:00"
},
"project_status_id": "fcf6071d-a5ab-48d7-a2c5-cda76b821cd4",
"project_status_code": "sample string 10",
"project_status": {
"id": "f9a4fbfc-44f2-4cc3-9816-b81eee0959ce",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3310f81b-b617-44ed-8abf-e7fd8347d00f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00"
},
"company_id": "e60b782c-a0c6-4a05-a2d0-96dd38a2134d",
"company_code": "sample string 12",
"db_address_id": "6929d945-0bd9-4a7f-a55b-4bf947b5b37f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0af65e6c-f75b-4afc-8892-88a37ffee279",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cb7bf6e5-b041-4882-b61d-15edd849cd37",
"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-08-31T05:50:07.7974268+00:00",
"date_create": "2026-08-31T05:50:07.7974268+00:00",
"date_update": "2026-08-31T05:50:07.7974268+00:00",
"updated_by_user_id": "fe51ae93-e69c-4cd0-a3bd-ce8c2eaee97d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-31T05:50:07.7974268+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-08-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-31T05:50:07.7974268+00:00",
"date_last_job": "2026-08-31T05:50:07.7974268+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-31T05:50:07.7974268+00:00",
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00",
"is_mobile_installation": true
},
"job_type_id": "f4db109f-028a-400b-86b5-3b12fa8115b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "221a8eb4-9237-462f-87d2-c91cf8833346",
"name": "sample string 2",
"sales_organization_id": "f6387c18-b56f-4779-9283-eaa827dcaad3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00",
"code": "sample string 7"
},
"job_priority_id": "394b6767-c0a7-424e-80b8-af7dc10669e9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d45c9f46-aebc-4f6e-8141-a46a07086d2d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "37d34b6e-8ae1-49f4-a752-0e96f481a47c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-31T05:50:07.7974268+00:00"
},
"job_status_id": "f0523640-2538-421d-a65e-13a41229fcf3",
"job_status_code": "sample string 11",
"db_address_id": "f6758269-2854-4fb9-9e01-958726249d03",
"contact_id": "e452d6ba-c394-4aac-b33b-76de4e1e5d90",
"requested_by_company_id": "ef1626bc-3be4-45be-9bd4-9ce81669e23d",
"requested_by_contact_id": "2fff7b5c-c11c-470a-90de-5fda185d5946",
"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-08-31T05:50:07.7974268+00:00",
"due_date": "2026-08-31T05:50:07.7974268+00:00",
"date_create": "2026-08-31T05:50:07.7974268+00:00",
"date_update": "2026-08-31T05:50:07.7974268+00:00",
"date_closed": "2026-08-31T05:50:07.7974268+00:00",
"suggested_user_id": "be97b526-ed88-477c-82c2-e8a96dca1e51",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4d2e9050-e46d-43fb-8d3b-728501e14473",
"db_language_id": "27145c48-c159-4585-bae7-fe65be948329",
"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-08-31T05:50:07.813052+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2bcff917-a52e-4feb-a3d2-817e053cd6de",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "84f78448-bb66-46ce-ac66-0c6155920422",
"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": "c9d99315-0e6c-45e4-8e17-5bc09da94933",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-31T05:50:07.813052+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1eebeb36-825b-48d7-96ac-6fdbc10f42c4"
},
"suggested_date_start": "2026-08-31T05:50:07.813052+00:00",
"skill_id": "5e195393-5c2e-411d-b4fc-6ba79cef1605",
"skill_code": "sample string 32",
"skill": {
"id": "f931297d-ed8c-43ef-a9a3-505e56bb5975",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bf3cec24-c7f5-4171-8949-15056c296bdb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "85b63185-a81e-4e74-9041-10bf81dc94a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6fc8c67c-592a-41fa-bc82-d7af1e61582d",
"db_currency_id": "2f45dbde-2d06-49de-a20b-d09ea793b028",
"db_language_id": "124e21d5-1c39-479a-b4ee-8a01a71f5413",
"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-08-31T05:50:07.7974268+00:00"
},
"modified_dateutc": "2026-08-31T05:50:07.813052+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ae712b28-b113-46e9-bc7c-96cb404f040d",
"date_reported_by_company": "2026-08-31T05:50:07.813052+00:00",
"id2": 36,
"company_id": "ceebd413-89f9-4a01-a192-6bc4cd8fe374",
"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": "84f97026-6adb-43c0-a170-5992d7cb3acf",
"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-08-31T05:50:07.813052+00:00"
},
"work_instruction_details_id": "091ed83f-81a5-41f9-9384-86aabd027d6e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3b3ca351-d3c3-40c4-b9af-22990ab4f36a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eb4ccd35-5f80-4320-9166-013def6ee476",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-31T05:50:07.813052+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": "a28ecd79-bb71-4cd0-81af-f34eb758365f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-31T05:50:07.813052+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.