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": "b26d6b54-7867-43a1-adb8-8a74eebef29e",
"jobs_id": "1465b317-cf7b-44cd-8479-4658197ff90f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fd2cfc20-0d12-407b-b46e-247b06a7357c",
"_parent_id": "b94406c5-d0b8-4572-be61-6c0c1936a63e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4defff8-2870-4c4f-8bf6-70790827d665",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a796f2a1-22c2-4ecd-806a-8ab116145df9",
"_parent_id": "f8e133b0-e1c6-40a2-a173-b7c149192de6",
"root_parent_id": "97b98cc5-fd0c-4cb0-b586-806665b6bbd9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e100283d-9a98-424b-b710-201050992b51",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0bba14dd-30c4-4805-bd78-365e0395b0bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3d46397a-c766-4d73-9a3a-8a9c277df30a",
"_parent_code": "sample string 6",
"sales_organization_id": "df91ef6a-1109-4981-8e1d-38461c587677",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"modified_dateutc": "2026-05-03T09:36:33.2044675+00:00"
},
"equipment_model_id": "123a7d4b-e0bc-4370-aa19-44d0bef429fd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5d156d1a-775c-4950-b54b-78ff407b672f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7d5b14ae-ca08-41a5-be2f-64ef0d34f0a1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b070f2a7-a971-44f2-8147-facbe368f088",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1aab04e5-729e-4ef5-8358-b08fd867c25e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"modified_dateutc": "2026-05-03T09:36:33.2044675+00:00"
},
"equipment_family_id": "1d95b8e8-12fe-42bd-a88e-4f857e3be267",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0bba14dd-30c4-4805-bd78-365e0395b0bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3d46397a-c766-4d73-9a3a-8a9c277df30a",
"_parent_code": "sample string 6",
"sales_organization_id": "df91ef6a-1109-4981-8e1d-38461c587677",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"modified_dateutc": "2026-05-03T09:36:33.2044675+00:00"
},
"date_in_production_since": "2026-05-03T09:36:33.2044675+00:00",
"date_out_of_production_since": "2026-05-03T09:36:33.2044675+00:00",
"date_end_support": "2026-05-03T09:36:33.2044675+00:00",
"sales_organization_id": "d80c92dd-6b3e-4dbd-a5c7-5abf07b8daef",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+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-05-03T09:36:33.2200862+00:00"
},
"project_status_id": "6f490348-0fe3-414b-b37d-767a074500af",
"project_status_code": "sample string 10",
"project_status": {
"id": "c0262347-a90f-493f-bea4-bd18d03c969a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c1fb2bcc-b525-4ec2-92b4-2698762df9be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00"
},
"company_id": "08a732f2-9668-426b-9295-84c41c81cac0",
"company_code": "sample string 12",
"db_address_id": "b36761ac-def4-41d6-b03b-a0ff285dd469",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b0f348ee-6196-4595-a560-c4382a4568e5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7c295af3-6bb2-4bd0-87bb-2927f32f8614",
"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-05-03T09:36:33.2200862+00:00",
"date_create": "2026-05-03T09:36:33.2200862+00:00",
"date_update": "2026-05-03T09:36:33.2200862+00:00",
"updated_by_user_id": "95e80891-c1e0-4a0d-b2c2-a14d1439ee23",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-03T09:36:33.2200862+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-05-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-03T09:36:33.2200862+00:00",
"date_last_job": "2026-05-03T09:36:33.2200862+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-03T09:36:33.2200862+00:00",
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00",
"is_mobile_installation": true
},
"job_type_id": "90a75596-10fc-4699-8737-112c9b196791",
"job_type_code": "sample string 7",
"job_type": {
"id": "e42413ca-1741-40aa-8879-c26f5f7bb00c",
"name": "sample string 2",
"sales_organization_id": "8b366595-4e89-44b4-a3c3-b60eefd17710",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00",
"code": "sample string 7"
},
"job_priority_id": "d987e026-eb5f-4cbc-bc74-cc49cc59c995",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "839d9cef-3e7c-4628-ae66-669a952d92ab",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d91d9df1-f2d9-43c1-9c88-9ed29f19fa5f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00"
},
"job_status_id": "9290e171-d49b-4468-b6d3-c4a1bc0fa650",
"job_status_code": "sample string 11",
"db_address_id": "bbaacf0e-6a49-4329-b888-c3c370ea0ec4",
"contact_id": "eeb3da7c-332a-4bdb-b67c-5dcbc26041a4",
"requested_by_company_id": "741efa61-95d7-4859-b035-39cf35aca397",
"requested_by_contact_id": "e5694d9b-2932-4728-b266-ba4bec178a24",
"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-05-03T09:36:33.2200862+00:00",
"due_date": "2026-05-03T09:36:33.2200862+00:00",
"date_create": "2026-05-03T09:36:33.2200862+00:00",
"date_update": "2026-05-03T09:36:33.2200862+00:00",
"date_closed": "2026-05-03T09:36:33.2200862+00:00",
"suggested_user_id": "e4ff4861-8c4c-4809-81d3-93e20eaa8e76",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c516b33a-1ec6-48d9-81c1-a8533e4ae37b",
"db_language_id": "a143f510-459c-4605-b640-936dd7c11ad9",
"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-05-03T09:36:33.2200862+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "59e42ed7-87d8-49d6-8baa-7652f75422c2",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dc6e14e9-0a75-42ed-84fc-d6fdef7da6af",
"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": "fb91010a-2da7-46df-904a-6eb4909169cc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ad82791f-296b-44fd-8433-7db903a9028f"
},
"suggested_date_start": "2026-05-03T09:36:33.2200862+00:00",
"skill_id": "d841d511-cb73-40f9-bd9c-c5d276178712",
"skill_code": "sample string 32",
"skill": {
"id": "47738d52-011b-4d83-8cb7-9bf377f45de0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "632b5395-f546-4dd9-8cab-d74c9976bfea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4db51ab9-47be-417b-b3f6-cc5949e640d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "747f6b7f-e93e-46a7-bfee-f5c0ebe7aef6",
"db_currency_id": "7a265110-9206-45df-9ec3-3e9164b7c2f6",
"db_language_id": "e4ad2699-96d0-4575-b072-145c13158acf",
"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-05-03T09:36:33.2044675+00:00"
},
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "91826cf3-041e-48cd-bd14-d868f2d5cda1",
"date_reported_by_company": "2026-05-03T09:36:33.2200862+00:00",
"id2": 36,
"company_id": "b49c83dc-5aad-4619-96f4-6a5f83a13686",
"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": "5de14640-2636-43b8-8a9a-16116320375a",
"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-05-03T09:36:33.2200862+00:00"
},
"work_instruction_details_id": "b16f06b7-61a4-4315-a1ef-a4a1e9cca3dd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dca995b9-563a-4934-a7bd-d48f5b386ebd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eb58c343-a47f-4262-a28c-a2d206dd6b2c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-03T09:36:33.2200862+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": "40a6365e-4da2-49a0-a567-c478cf64445f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-03T09:36:33.2200862+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.