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": "e9084a55-cbfd-4558-8fdb-339fa303d76a",
"jobs_id": "9239d258-8ae1-4a44-9c03-9059a580dbdf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d8dc920c-5fcc-467a-91ab-94eb41b76d89",
"_parent_id": "7c3ab718-226c-42f5-8c6e-c2bd09702807",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "65ceb56d-2966-4cee-8eee-486be9633d32",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6599f215-13bc-4a38-b069-0d38e02937b7",
"_parent_id": "1851a698-9a3f-4d84-9bb1-e87aba58cd1b",
"root_parent_id": "f455ffdf-c1c2-4725-8253-417d30284988",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e5df004a-43e0-4860-a456-f409d993b15e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b48b72ff-c4a4-43df-ad19-90c56d0741b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be811cc1-bb39-4915-be7b-090ff57fc9f5",
"_parent_code": "sample string 6",
"sales_organization_id": "82134bd9-adfe-4f06-84ac-53d96bcd12b8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
},
"equipment_model_id": "80b88bc7-abe4-4604-8e98-61f80745204a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b874c185-7960-43e8-8a4d-3f02a941d0b7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "71daf96c-f945-45a3-96f4-9510bf748eff",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f4d156bd-3474-460c-9fa8-68de178ef6df",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f104ed18-83d8-4c72-8b67-832733d5ee38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
},
"equipment_family_id": "2bd56458-211e-4f73-b5ad-edaff9ce6b91",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b48b72ff-c4a4-43df-ad19-90c56d0741b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be811cc1-bb39-4915-be7b-090ff57fc9f5",
"_parent_code": "sample string 6",
"sales_organization_id": "82134bd9-adfe-4f06-84ac-53d96bcd12b8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
},
"date_in_production_since": "2026-07-11T18:17:21.9306594+00:00",
"date_out_of_production_since": "2026-07-11T18:17:21.9306594+00:00",
"date_end_support": "2026-07-11T18:17:21.9306594+00:00",
"sales_organization_id": "2799a2b2-af67-4a74-a11c-fd2a85ed0120",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+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-07-11T18:17:21.9306594+00:00"
},
"project_status_id": "488b24a3-4ca4-460f-8c1f-78cb4338eb10",
"project_status_code": "sample string 10",
"project_status": {
"id": "7121ad17-b997-4e3d-baf8-8c7621583d56",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a8d33d6a-c3a8-494e-8805-3379476ea833",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
},
"company_id": "73a8a653-e1d1-472d-ba66-f696a9993549",
"company_code": "sample string 12",
"db_address_id": "bbc5dc2c-1b0c-48d1-a0e1-e6259bad944f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "87a92a07-8a57-4dd9-81c4-ce9ee917aa4e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3743aef2-3400-4b56-9cfc-a3184af3c014",
"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-07-11T18:17:21.9306594+00:00",
"date_create": "2026-07-11T18:17:21.9306594+00:00",
"date_update": "2026-07-11T18:17:21.9306594+00:00",
"updated_by_user_id": "8547b279-6a72-4aef-b080-21c9135cbd56",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-11T18:17:21.9306594+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-07-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-11T18:17:21.9306594+00:00",
"date_last_job": "2026-07-11T18:17:21.9306594+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-11T18:17:21.9306594+00:00",
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00",
"is_mobile_installation": true
},
"job_type_id": "319a7e6b-cbd8-4b7e-9b43-4b6d81d3d9a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "3b1f25aa-58fc-4c6d-9b66-b4d52e48037e",
"name": "sample string 2",
"sales_organization_id": "dd2515de-6706-4f5b-ad89-a38a6acd6a06",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00",
"code": "sample string 7"
},
"job_priority_id": "ca626562-4736-4b82-a578-cdf66561aad3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "60fd092b-30b0-4d5f-8de0-206d85a2bbf0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e85d07ad-d950-4ff4-bd0c-4f584bedb403",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
},
"job_status_id": "d55d22a3-e697-45f1-8877-dcee1689a3e8",
"job_status_code": "sample string 11",
"db_address_id": "6865ce3f-a01a-4dc0-bd3e-7be5a6c74f06",
"contact_id": "868494da-a7a4-4f8c-82e0-6fa43e868839",
"requested_by_company_id": "11145412-d679-42ec-8eac-feaf9a173cc4",
"requested_by_contact_id": "84d9fc92-1b33-492e-bfb0-28401ef1eb7d",
"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-07-11T18:17:21.9306594+00:00",
"due_date": "2026-07-11T18:17:21.9306594+00:00",
"date_create": "2026-07-11T18:17:21.9306594+00:00",
"date_update": "2026-07-11T18:17:21.9306594+00:00",
"date_closed": "2026-07-11T18:17:21.9306594+00:00",
"suggested_user_id": "c7e1df19-1d4e-4d92-821d-c8f405d495b2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8ac85ba9-0efc-41a8-9548-150212872f03",
"db_language_id": "a5ba43ad-9c64-4ff4-ae6b-86efe1dfb1fb",
"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-07-11T18:17:21.9306594+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "31d80c39-27b4-436e-af42-db51be693dde",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "683d493d-adee-4981-8681-827f3ac7cbd4",
"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": "d3ae13dd-a1cf-4950-be1a-da795f4ab3d1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "af7959bd-f7bb-41d5-b9bf-abacb2c76ff5"
},
"suggested_date_start": "2026-07-11T18:17:21.9306594+00:00",
"skill_id": "d1076104-e912-4406-a596-3f0b18958417",
"skill_code": "sample string 32",
"skill": {
"id": "d36eb4a3-a66b-4a1e-8eae-e76991801cd7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "660193b0-7897-4483-bf2c-4265dbc95866",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "975d1a4d-6b90-47ee-a944-319beb64c1dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27892d17-880b-427a-9369-5b824a46028c",
"db_currency_id": "f6a786c9-e6a4-4620-919c-e0a83e4ef0c6",
"db_language_id": "c864abc8-f0d8-4619-9d90-65f799d78277",
"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-07-11T18:17:21.9306594+00:00"
},
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9371a410-f39f-453d-bb86-ada56ae449b2",
"date_reported_by_company": "2026-07-11T18:17:21.9306594+00:00",
"id2": 36,
"company_id": "ae57bec6-696c-4afb-8e79-11190c9a7ce7",
"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": "4b335d60-bc49-4d96-bf1b-3d4869973e07",
"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-07-11T18:17:21.9306594+00:00"
},
"work_instruction_details_id": "60491802-c91d-4032-84f2-4af8605e250a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c4f827bf-b388-413a-a1bd-4b7bd3f406ad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9661f7c6-028f-404a-9ea1-fb6d71304f0d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-11T18:17:21.9306594+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": "7cd0e65c-d903-4023-83f8-d17f9f72e276",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-11T18:17:21.9306594+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.