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": "8eca68a0-7860-4400-9a35-37adb05e971f",
"jobs_id": "ddd101b5-3b9a-4b10-9830-d403a706030a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "23e946ec-6d61-46a3-8bd8-3220148b1072",
"_parent_id": "c9e0d53f-5ae2-4b55-bcfe-ffdbf61de631",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1bab7f48-a79d-4947-9947-d4b9504e3837",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fd27a272-0ce7-461e-aa64-b774dc7945eb",
"_parent_id": "83cf7534-3bf8-422f-b063-43fea44e34c2",
"root_parent_id": "5670c431-af77-4875-83c6-82490127b4bf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d1f90684-3432-420d-995a-ea6822cba3be",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5bbf8237-1ae5-4743-a1aa-89a028bf2299",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2167e837-e566-4165-a1eb-ca1a7e2cf1b2",
"_parent_code": "sample string 6",
"sales_organization_id": "158f0d62-f9aa-41f5-949a-850398a86f66",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"modified_dateutc": "2025-10-17T06:45:02.1219548+00:00"
},
"equipment_model_id": "39daaf63-c201-4933-ac72-c068795844b9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "73b379d7-fbf1-430f-8c18-6307c988ebdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "adafbda9-0dcc-4f14-9005-abe59049189b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f9d9fdc3-f629-4ea6-aba4-7bea59018b20",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b04271cd-34ad-4b5b-8e94-d6569ff6a8dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"modified_dateutc": "2025-10-17T06:45:02.1219548+00:00"
},
"equipment_family_id": "7171bb99-0d81-4c11-bf09-bac50e015fb7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5bbf8237-1ae5-4743-a1aa-89a028bf2299",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2167e837-e566-4165-a1eb-ca1a7e2cf1b2",
"_parent_code": "sample string 6",
"sales_organization_id": "158f0d62-f9aa-41f5-949a-850398a86f66",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"modified_dateutc": "2025-10-17T06:45:02.1219548+00:00"
},
"date_in_production_since": "2025-10-17T06:45:02.1219548+00:00",
"date_out_of_production_since": "2025-10-17T06:45:02.1219548+00:00",
"date_end_support": "2025-10-17T06:45:02.1219548+00:00",
"sales_organization_id": "04163fc0-e691-49de-9934-65bbb7cab1c0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+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": "2025-10-17T06:45:02.1219548+00:00"
},
"project_status_id": "2e800fec-817f-4c8f-9aba-f3d59ec19d8f",
"project_status_code": "sample string 10",
"project_status": {
"id": "1e778552-00f6-4c21-a575-f1b7985dcba8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "52a47054-1afc-41b0-9715-fab392c00bd4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-17T06:45:02.1219548+00:00"
},
"company_id": "4bb08a02-7788-4124-8ff3-d1455ad6d32e",
"company_code": "sample string 12",
"db_address_id": "82dde8e6-7573-4e71-9401-44ad635af727",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0e54f9c2-55a6-4b94-bf37-da6c95bf401d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d96e323b-7263-49eb-97f2-c4c789408db4",
"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": "2025-10-17T06:45:02.1375782+00:00",
"date_create": "2025-10-17T06:45:02.1375782+00:00",
"date_update": "2025-10-17T06:45:02.1375782+00:00",
"updated_by_user_id": "42e59351-6b9a-49ac-b7ad-a1eda8a8c638",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-17T06:45:02.1375782+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": "2025-10-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-17T06:45:02.1375782+00:00",
"date_last_job": "2025-10-17T06:45:02.1375782+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-17T06:45:02.1375782+00:00",
"modified_dateutc": "2025-10-17T06:45:02.1375782+00:00",
"is_mobile_installation": true
},
"job_type_id": "88150ba8-dd19-4919-94f9-e840554af3b0",
"job_type_code": "sample string 7",
"job_type": {
"id": "527225e6-4e13-4283-aa43-6f0104012eb6",
"name": "sample string 2",
"sales_organization_id": "52a05059-fe89-49d2-94ae-57b7788494b7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-17T06:45:02.1375782+00:00",
"code": "sample string 7"
},
"job_priority_id": "7410a95f-038b-4fd3-86d7-fc1eeb516478",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e6f7c86b-4eb5-4abf-8612-8e7c4b30155a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fc447236-1205-4963-b340-88b127efa9a8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-17T06:45:02.1375782+00:00"
},
"job_status_id": "4b0b52fa-f76d-491d-a734-cbda74c3d259",
"job_status_code": "sample string 11",
"db_address_id": "da665702-2a6b-47d9-8b74-dbdf868a4143",
"contact_id": "072116da-8af1-4227-b787-43291ba4dc36",
"requested_by_company_id": "3c7c7251-165d-4c73-9018-53c6b49d985f",
"requested_by_contact_id": "63f23aea-1a09-48bd-8e7c-08c972c0385e",
"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": "2025-10-17T06:45:02.1375782+00:00",
"due_date": "2025-10-17T06:45:02.1375782+00:00",
"date_create": "2025-10-17T06:45:02.1375782+00:00",
"date_update": "2025-10-17T06:45:02.1375782+00:00",
"date_closed": "2025-10-17T06:45:02.1375782+00:00",
"suggested_user_id": "c1840858-e784-414c-8300-27b2b48066c0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fee2bc50-c2a0-4d73-a681-729ac2cb838e",
"db_language_id": "fbaed144-3788-4805-b3e6-c953ecf4d7d8",
"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": "2025-10-17T06:45:02.1375782+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0eab0536-6fca-4d5f-95d2-b355e8db1627",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d1d5f6b1-941a-4d7d-b3ac-540be87ac9bf",
"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": "a21fb2d5-00bd-4beb-8163-67fe99afa28a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-17T06:45:02.1375782+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0309cf4f-725e-4302-884a-ebb956d6e51a"
},
"suggested_date_start": "2025-10-17T06:45:02.1375782+00:00",
"skill_id": "aaf4baab-1844-47de-b43a-50b94b9cd370",
"skill_code": "sample string 32",
"skill": {
"id": "c6189f22-3176-4486-8109-60fc25fd3c94",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bac3fac9-66d8-40cc-96dc-18fd381df287",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a5858ed-7117-481f-a1f6-4f8436e2c992",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c8e5303-35e2-408c-b2d7-2c305faecf61",
"db_currency_id": "197c6d90-beb9-4a24-82cc-28aa414dcf2d",
"db_language_id": "de6318a2-7fc9-4cec-8f41-3f1d73e5fb43",
"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": "2025-10-17T06:45:02.1219548+00:00"
},
"modified_dateutc": "2025-10-17T06:45:02.1375782+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "26b9cf90-c2df-4531-b936-5d9a6732cb80",
"date_reported_by_company": "2025-10-17T06:45:02.1375782+00:00",
"id2": 36,
"company_id": "c2286678-dab2-496c-8f12-fc822322d129",
"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": "957f8c97-8906-4f08-a150-4be6d6ca21d4",
"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": "2025-10-17T06:45:02.1375782+00:00"
},
"work_instruction_details_id": "1021c603-8e7d-484f-8dcd-82ee0bacce17",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "71312629-6d3e-4db6-8bd4-69df53a2c03c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "588e6522-e399-4853-a734-8e32dc7051ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-17T06:45:02.1375782+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": "c7cc3c9e-3010-4836-9669-c4f81ff17261",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-17T06:45:02.1375782+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.