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": "46b809eb-a821-4ea0-b5f7-6bb38a2b0095",
"jobs_id": "c4cf94ba-f004-4d3d-9268-a2cf180a738f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "747d9667-2219-4366-8647-e558cc3b490c",
"_parent_id": "8962e21d-a0ef-4c17-aec9-ed3c1a7d4e09",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6ccbfdf8-580a-4584-9605-770a8d2f24d9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fd497984-9950-4844-95ec-5105f9a9b100",
"_parent_id": "aaa5c7a7-6a37-4c99-918b-6a1958e52c79",
"root_parent_id": "53d0dc10-ddfd-4b85-bf62-b87f4c47080b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1fe79778-d1eb-42f0-84e2-9e66df703469",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "de42f2b3-df9a-4b04-bd70-9939d465b988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "029daedf-0ef4-4bc8-9f06-46125c24146d",
"_parent_code": "sample string 6",
"sales_organization_id": "5d4f1d93-8312-4867-b985-fa550cb55b0c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
},
"equipment_model_id": "c3f2d9bc-ef2e-4174-baa5-43e8803df99c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2304fc6b-5781-4f64-8586-b6f4e15707f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "37d2dace-bd52-4dc6-8270-fd0ba84011fc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6e9f0d14-75f5-4787-9387-a5cf118dd2bc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "05310086-9813-42c1-9b5f-6a3e503a024a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
},
"equipment_family_id": "0cdec82f-1ed1-482f-87f7-5c46f5b7e844",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "de42f2b3-df9a-4b04-bd70-9939d465b988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "029daedf-0ef4-4bc8-9f06-46125c24146d",
"_parent_code": "sample string 6",
"sales_organization_id": "5d4f1d93-8312-4867-b985-fa550cb55b0c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
},
"date_in_production_since": "2026-06-25T18:12:02.3010245+00:00",
"date_out_of_production_since": "2026-06-25T18:12:02.3010245+00:00",
"date_end_support": "2026-06-25T18:12:02.3010245+00:00",
"sales_organization_id": "b505bd4f-1780-4749-bc75-d28eeb9ab12e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+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-25T18:12:02.3010245+00:00"
},
"project_status_id": "1f364d4b-7264-4825-888f-b08d258d9f0c",
"project_status_code": "sample string 10",
"project_status": {
"id": "fe8f967f-b9d2-4a9a-a879-0ad9d7e40ee0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "43459e05-2e7d-46b2-9a13-4cc657f43703",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
},
"company_id": "0d53f5a5-1b9a-45a2-ad08-399f93fb144d",
"company_code": "sample string 12",
"db_address_id": "0f611cf4-a937-401c-8d2f-35a45abff995",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "41295583-4d71-4ce8-af80-f20f3c52a132",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "21b84857-710c-47e9-953a-804dc97275ff",
"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-25T18:12:02.3010245+00:00",
"date_create": "2026-06-25T18:12:02.3010245+00:00",
"date_update": "2026-06-25T18:12:02.3010245+00:00",
"updated_by_user_id": "87d83c0f-4255-456a-be63-04e56c7eaf4a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-25T18:12:02.3010245+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-25T18:12:02.3010245+00:00",
"date_last_job": "2026-06-25T18:12:02.3010245+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-25T18:12:02.3010245+00:00",
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00",
"is_mobile_installation": true
},
"job_type_id": "c98655ea-7162-4474-982c-d967745c58b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "2eff39b1-39e9-45ec-9d5f-0749ba9c0bda",
"name": "sample string 2",
"sales_organization_id": "239d3de5-ed34-479b-98cd-0c522c804de3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00",
"code": "sample string 7"
},
"job_priority_id": "7e8ab293-c108-49a4-b2a0-a365d37bf3a1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "af286ad2-36a3-4b35-8bb4-a35a8b2d262b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "70f07708-690d-40e8-85fd-b145b34af21e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
},
"job_status_id": "bb2402e1-454d-4349-bb12-a0801e1e549f",
"job_status_code": "sample string 11",
"db_address_id": "ca46fc31-7518-488c-82d0-6a56ff64b5d7",
"contact_id": "f266efed-7376-4f2a-9ddb-a441b6359900",
"requested_by_company_id": "490f2675-09fd-4f7d-a94d-76ca21face41",
"requested_by_contact_id": "9de39a75-fdd8-4f5c-9437-dafcf4ffe4a4",
"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-25T18:12:02.3010245+00:00",
"due_date": "2026-06-25T18:12:02.3010245+00:00",
"date_create": "2026-06-25T18:12:02.3010245+00:00",
"date_update": "2026-06-25T18:12:02.3010245+00:00",
"date_closed": "2026-06-25T18:12:02.3010245+00:00",
"suggested_user_id": "a27610cd-b674-4b24-a76c-6a3f6f79f06a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "759ff2e0-3423-4cba-88e7-d4d02bd73a78",
"db_language_id": "9452bd30-b4a3-4400-b1c7-9c4621297fbd",
"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-25T18:12:02.3010245+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ad449469-4341-4734-aedb-37f245fb14e5",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d0402e11-3853-410e-8064-61a1d72c3463",
"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": "f9441a26-c9de-46dd-ad6f-8f423e301ed3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "03402042-c8e1-4929-9299-47f2c3fdce14"
},
"suggested_date_start": "2026-06-25T18:12:02.3010245+00:00",
"skill_id": "cf37726b-4378-4c82-9702-a7ba600a8df2",
"skill_code": "sample string 32",
"skill": {
"id": "f22ac482-09f5-47e0-b3c5-8bc10a41a636",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2ac94678-ec5f-4d5d-9b83-62ae36983706",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ca3cba0-65c8-411f-96c5-1dd18bd8b408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c1a0a2c7-a570-4116-a10f-7d9eff8ab623",
"db_currency_id": "e2433f1a-88e2-4b1e-a3d4-7dda709a54be",
"db_language_id": "84a3bb4f-729f-40f9-8366-916580de682e",
"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-25T18:12:02.3010245+00:00"
},
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9db6888e-1eee-4301-9e29-de319e04a5d9",
"date_reported_by_company": "2026-06-25T18:12:02.3010245+00:00",
"id2": 36,
"company_id": "c081338b-99d2-4e76-8519-39f01f8b8868",
"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": "ff926bfe-2f25-4e13-892c-b460e2d5a1b1",
"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-25T18:12:02.3010245+00:00"
},
"work_instruction_details_id": "655d4668-6a3d-4108-baf3-dd49b0051143",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ad25e0ae-8d62-4170-9851-4d85a29a08ad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bd4e3465-733b-4853-b9df-b67d4175944f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-25T18:12:02.3010245+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": "afc36684-69c5-495e-87a4-ebb140a66c64",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-25T18:12:02.3010245+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.