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": "e07df02b-2328-42b2-8486-4d6fc632dd42",
"jobs_id": "e96dabe3-1b94-4b6e-ad1e-5fcdc345ca0c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cd8f00d3-0980-4744-9210-fdb7f5282ed0",
"_parent_id": "10d20fbd-5fc0-40e7-8a3d-830e52e6e6f9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fea40eee-c885-4c6e-89f1-d0690d778941",
"project_reference_back_office": "sample string 5",
"project": {
"id": "542a0143-a0e2-43e2-b8d3-9ca30b132db2",
"_parent_id": "4457668b-f22f-4ea3-989d-e63f8b33843d",
"root_parent_id": "083da783-a220-45ae-b8af-388bb2ec4848",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10ac20d9-e636-4c3d-be80-4fd96194d95f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f3286bd3-4cca-406a-84d7-2e0fa426c621",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e190344-3263-4e06-923f-441225ac09fa",
"_parent_code": "sample string 6",
"sales_organization_id": "c7f99df2-5874-4517-9ebe-78379c0fea14",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
},
"equipment_model_id": "4102555f-3007-4a22-a953-6baaea3fc9ed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cef4fa67-7b3d-4f93-bb2c-ee76774f6322",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a1f88987-b5a3-4b88-9fe1-b5904d4a2910",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ec4e944b-8712-466f-a7a7-c0e67b9201f5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "340fbaea-886a-4464-b628-f14bde0d2f81",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
},
"equipment_family_id": "88612491-b72b-45d3-8deb-97826f3ec02f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f3286bd3-4cca-406a-84d7-2e0fa426c621",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e190344-3263-4e06-923f-441225ac09fa",
"_parent_code": "sample string 6",
"sales_organization_id": "c7f99df2-5874-4517-9ebe-78379c0fea14",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
},
"date_in_production_since": "2026-07-01T12:29:52.008007+00:00",
"date_out_of_production_since": "2026-07-01T12:29:52.008007+00:00",
"date_end_support": "2026-07-01T12:29:52.008007+00:00",
"sales_organization_id": "82ff60e9-c2d2-4eae-a5f1-00a3ce98a2c6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+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-01T12:29:52.008007+00:00"
},
"project_status_id": "080b47a8-a0a6-4322-ae81-905636004977",
"project_status_code": "sample string 10",
"project_status": {
"id": "3a875757-0ee2-47fa-8697-8cf628893e5b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "35740dfb-8ec3-40ff-8c94-d974ef4ecf38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
},
"company_id": "9a28e741-ce71-4cbb-8ab2-ae325cc7906d",
"company_code": "sample string 12",
"db_address_id": "2e6d46d8-f8dd-4ed2-9667-d581ce825c5c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "16274705-d570-4611-a794-8b6d7ac2e7a3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "64447cd8-df34-45a5-b436-e43e4c543080",
"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-01T12:29:52.008007+00:00",
"date_create": "2026-07-01T12:29:52.008007+00:00",
"date_update": "2026-07-01T12:29:52.008007+00:00",
"updated_by_user_id": "fdef5cdf-4a94-4b0c-805e-fb8baf4df58a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-01T12:29:52.008007+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-01T12:29:52.008007+00:00",
"date_last_job": "2026-07-01T12:29:52.008007+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-01T12:29:52.008007+00:00",
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00",
"is_mobile_installation": true
},
"job_type_id": "b9547358-dc19-4a9d-a167-01b45e740a33",
"job_type_code": "sample string 7",
"job_type": {
"id": "3afb69b8-47fa-403c-bcc2-1b5f60833789",
"name": "sample string 2",
"sales_organization_id": "4b07b3c8-6a52-43f5-ab26-0caa89ddff5e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00",
"code": "sample string 7"
},
"job_priority_id": "8e3dfbf1-c709-4c64-8c0c-62be59da0402",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a4627e0e-53d1-440c-ba69-121443cbf1fa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6f11c370-4791-4e86-a8a3-83463c56915f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
},
"job_status_id": "181c2af4-c8b3-4c3e-a160-83cca9edbfbd",
"job_status_code": "sample string 11",
"db_address_id": "64d31aff-c5a3-46cb-8c75-892809792f3b",
"contact_id": "7474fa40-2c63-4e06-9f64-52b28dd1294b",
"requested_by_company_id": "c0d233ac-20cf-4671-b116-2d13d8742b11",
"requested_by_contact_id": "685790d1-4638-4c8a-b164-4e6340ae153a",
"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-01T12:29:52.008007+00:00",
"due_date": "2026-07-01T12:29:52.008007+00:00",
"date_create": "2026-07-01T12:29:52.008007+00:00",
"date_update": "2026-07-01T12:29:52.008007+00:00",
"date_closed": "2026-07-01T12:29:52.008007+00:00",
"suggested_user_id": "e2e3058d-d9bc-47f9-99d5-3caeda50b075",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d172df37-0b18-45be-b805-cdaea8fb42f9",
"db_language_id": "56ba4c21-cf4e-4c21-888b-99bdbb38ee5c",
"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-01T12:29:52.008007+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f83f58b-9f72-4ea9-aae4-357aab1ffd05",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dfcd2bf0-60f7-4f9f-a1d9-ce5fe4a97892",
"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": "632de262-81b5-466e-9e60-aa3f73617f15",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2af5118f-edc2-4c6c-977f-53d9ab45077c"
},
"suggested_date_start": "2026-07-01T12:29:52.008007+00:00",
"skill_id": "e47e0cfc-3487-4e4e-b9e3-7f5a55610e29",
"skill_code": "sample string 32",
"skill": {
"id": "502d859c-897a-4e0a-91c0-637bc5f6ba18",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bbe519b0-a0e2-45c2-9f49-ca10252b71d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74ab9064-5072-491c-b434-36fc06835fb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e61ebc98-7402-422d-9a67-f62907c85793",
"db_currency_id": "62f39e17-5d71-41bc-a178-241977f8287a",
"db_language_id": "bc1747a0-9c85-4562-9081-bd25441eeb37",
"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-01T12:29:52.008007+00:00"
},
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f156a53f-1d40-4ad0-b2dc-8a693703ec49",
"date_reported_by_company": "2026-07-01T12:29:52.008007+00:00",
"id2": 36,
"company_id": "ca4ee799-5064-45a2-ab8f-a74c94bddae7",
"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": "68e98aba-79be-45b1-a020-17e20aac72d2",
"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-01T12:29:52.008007+00:00"
},
"work_instruction_details_id": "ce87df93-b097-43aa-86af-67d5bcbca00b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f30f3a29-60d8-4e2a-bd21-4067f6397c81",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2dcafe22-18a3-44f6-962d-c2f93e458029",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-01T12:29:52.008007+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": "41764ffd-0d5e-4937-a1d1-24c9eb1298d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-01T12:29:52.008007+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.