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": "448e3d31-97e7-4133-8417-97e6497e9b14",
"jobs_id": "11622f8c-b538-4d47-aad8-8bd8edd0941f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c66ecc3c-5e35-435a-9271-c1a301baac3a",
"_parent_id": "f889f20c-360e-412c-af51-e2fcf2f0f73a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "841f71c7-798a-437f-8488-d0149820cc73",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6c283b09-248c-4618-8c78-41e3b083739a",
"_parent_id": "6547c3c3-610f-49bf-9f31-5e5dfc6cec41",
"root_parent_id": "145c519e-c052-436a-879b-fd84981364b7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "555b938a-59ec-4d5b-b93b-259be9c1b8cb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "56dbc26b-2989-43dd-b0ef-4890a305b51d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3575d16-d4e3-41d1-8bc5-387d46d61d29",
"_parent_code": "sample string 6",
"sales_organization_id": "7ed2945e-8e75-4688-922e-6fb0a1395d88",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00"
},
"equipment_model_id": "ccabd347-b4d3-4284-a4d8-978eb6861898",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d5d2e387-5aa8-4c55-855c-1b13f5399ae5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "455e5d85-e823-407f-8775-73f3f49d2650",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3e1fcb2-3186-467a-aba0-40517982fd08",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1d2c62ce-d784-43ec-bb1c-d1ed1d3972f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00"
},
"equipment_family_id": "fa26e5e6-073d-4865-adbf-939d0723dcb4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "56dbc26b-2989-43dd-b0ef-4890a305b51d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3575d16-d4e3-41d1-8bc5-387d46d61d29",
"_parent_code": "sample string 6",
"sales_organization_id": "7ed2945e-8e75-4688-922e-6fb0a1395d88",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00"
},
"date_in_production_since": "2026-06-10T16:28:43.4876962+00:00",
"date_out_of_production_since": "2026-06-10T16:28:43.4876962+00:00",
"date_end_support": "2026-06-10T16:28:43.4876962+00:00",
"sales_organization_id": "f3f10e97-8d7e-45d7-85e8-3d6e749ac230",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+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-06-10T16:28:43.4876962+00:00"
},
"project_status_id": "72ec53e4-db41-40f4-9fb9-04f23ab8423a",
"project_status_code": "sample string 10",
"project_status": {
"id": "059369a8-18e1-4ba4-845c-f08f671e9878",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "165f0be9-919f-4d2d-9aae-22c04c39e496",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00"
},
"company_id": "c569539e-f4b4-4b28-b167-25045fa27c9d",
"company_code": "sample string 12",
"db_address_id": "6f8f2688-0b24-4497-b34b-dacd5dae2a91",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "80fa22ae-498c-4d9f-a808-8465903a278a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dce20197-64ab-4ae9-be96-c9af94e78dc2",
"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-06-10T16:28:43.4876962+00:00",
"date_create": "2026-06-10T16:28:43.4876962+00:00",
"date_update": "2026-06-10T16:28:43.4876962+00:00",
"updated_by_user_id": "17e76886-242e-41f1-bb17-78afc22791a8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-10T16:28:43.4876962+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-06-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-10T16:28:43.4876962+00:00",
"date_last_job": "2026-06-10T16:28:43.4876962+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-10T16:28:43.4876962+00:00",
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00",
"is_mobile_installation": true
},
"job_type_id": "5534b6d9-603d-4586-8f78-895162769bc7",
"job_type_code": "sample string 7",
"job_type": {
"id": "1a29fa8a-e126-41a9-aa48-ab8fbe9de577",
"name": "sample string 2",
"sales_organization_id": "f5f25306-9f3e-45e6-b24a-744153719b7d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00",
"code": "sample string 7"
},
"job_priority_id": "9860fc6c-eee3-4173-8a4b-5717c38f41ae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6799d97f-dc19-4612-85ca-a716b1394122",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f4b80567-c828-4468-8b8c-c3fbec759a3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T16:28:43.4876962+00:00"
},
"job_status_id": "16f0f77e-ba7e-40a7-84d7-330eb710e601",
"job_status_code": "sample string 11",
"db_address_id": "c1efc1a1-1852-4c40-9950-6b2f7ae5ed00",
"contact_id": "40f8d03d-a8cd-49c1-9ac8-045bf56e34e7",
"requested_by_company_id": "e69bb3fd-b9ed-4046-80fb-cd5265159cdf",
"requested_by_contact_id": "e4c8ebd7-cebb-4e61-b650-001c6cd6a98a",
"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-06-10T16:28:43.4876962+00:00",
"due_date": "2026-06-10T16:28:43.4876962+00:00",
"date_create": "2026-06-10T16:28:43.4876962+00:00",
"date_update": "2026-06-10T16:28:43.4876962+00:00",
"date_closed": "2026-06-10T16:28:43.4876962+00:00",
"suggested_user_id": "f4ce36c8-ab04-49bd-a32a-89a8ccc3b9f1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "879a71e1-a4ba-4347-87eb-91517fac6fa7",
"db_language_id": "ddd28834-7125-49de-a175-0943e10fc7f5",
"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-06-10T16:28:43.5033187+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b9750ed7-fce0-41c6-a3ac-50312ad23c3c",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2e50a1e9-88e5-4fc9-b552-6db9d1960ef6",
"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": "963434a5-9ce6-43a3-874e-1721a8d6237d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-10T16:28:43.5033187+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "47b7b215-dabb-4f76-b98c-8f01558af482"
},
"suggested_date_start": "2026-06-10T16:28:43.5033187+00:00",
"skill_id": "cf09d0bf-ff7b-480c-8be4-80f1223670cd",
"skill_code": "sample string 32",
"skill": {
"id": "1e023186-e801-4392-9b0c-6509b7e5c172",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f7b8f9b-bdd6-4237-a2ef-a89666fcd4ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42609eff-33f1-479d-875b-99b45479a915",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ca2a415-888a-4170-ac9f-b897b6126142",
"db_currency_id": "d5129776-05e0-42be-816b-7309fdd40ac5",
"db_language_id": "c2158ec6-01d5-40a6-a57f-fd19eea298c9",
"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-06-10T16:28:43.4876962+00:00"
},
"modified_dateutc": "2026-06-10T16:28:43.5033187+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fb2530b8-d7a4-473f-8c07-a12758da1de4",
"date_reported_by_company": "2026-06-10T16:28:43.5033187+00:00",
"id2": 36,
"company_id": "01ee1b25-834c-4fc9-b756-6f7536a4ea05",
"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": "0003a53f-0b28-4c16-b4bb-5c35b4d8b64e",
"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-06-10T16:28:43.5033187+00:00"
},
"work_instruction_details_id": "c210b298-1944-4581-b88b-cd1be5175e6d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "681f2b07-44f4-4e29-a0a8-080ce05f5565",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8aa74baf-bd39-47c4-8c3c-099e942d5a07",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-10T16:28:43.5033187+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": "e6b720ea-99f0-447a-97fc-f87bb8d978df",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-10T16:28:43.5033187+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.