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": "6ec562f7-26ac-467b-8a06-965c56c32639",
"jobs_id": "644e4804-4661-4683-a775-60587fe98cbd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f35ef829-e293-4d69-a585-c25283b26954",
"_parent_id": "16f11e9f-70cd-47e4-bf9f-d702793639be",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a387b36a-fe37-4177-bb1d-88a2ff1b98f8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f4783c1b-49f1-40b9-95b8-4b78780b4e11",
"_parent_id": "ef4bbcb4-aaa6-4311-8217-89f5c67a6761",
"root_parent_id": "7a37ca3f-dbba-4008-87cc-00577a229063",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b0729722-1f07-483b-8d26-4ceb863244d5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6ac3aa2b-1ae3-4b38-a556-363d875b1dab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e41efd06-d5ec-48e4-ad80-2215efc14a47",
"_parent_code": "sample string 6",
"sales_organization_id": "330be1e3-3fb5-4450-a3f4-0c14d6e44dba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00"
},
"equipment_model_id": "b9a49072-1ac4-4687-b34c-8cf9d553b2c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f340d8eb-b190-4276-bedd-6258bb09b4a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e83e7e8f-e814-4e1e-9bb2-f0da3dd674f0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "909ae143-c19b-4e3b-bf1e-778748ae46c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2d92287d-826a-4b4b-bf3a-c46379db659a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00"
},
"equipment_family_id": "79501059-e407-49a9-815d-8c71a2424382",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6ac3aa2b-1ae3-4b38-a556-363d875b1dab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e41efd06-d5ec-48e4-ad80-2215efc14a47",
"_parent_code": "sample string 6",
"sales_organization_id": "330be1e3-3fb5-4450-a3f4-0c14d6e44dba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00"
},
"date_in_production_since": "2026-10-09T11:08:51.4277029+00:00",
"date_out_of_production_since": "2026-10-09T11:08:51.4277029+00:00",
"date_end_support": "2026-10-09T11:08:51.4277029+00:00",
"sales_organization_id": "db37bb0a-efc0-4f9a-ba10-2b14adb86c41",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+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-10-09T11:08:51.4277029+00:00"
},
"project_status_id": "62b83ddb-1382-45ff-adde-986250fa68b7",
"project_status_code": "sample string 10",
"project_status": {
"id": "67269417-4df7-4cc8-a6f1-40e07f1e9b2f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "83c49920-561c-41b1-bf0b-b32e38d69f02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00"
},
"company_id": "8c2e4c9a-daa2-4fbd-b1c1-81dba3c73f0d",
"company_code": "sample string 12",
"db_address_id": "d643032e-cb92-4ce3-8f1a-14e183eaee14",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "58b8364a-1b73-49bd-9487-b72e58f4d99b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "decb35b3-56c4-44f8-880d-909604bdd4bf",
"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-10-09T11:08:51.4277029+00:00",
"date_create": "2026-10-09T11:08:51.4277029+00:00",
"date_update": "2026-10-09T11:08:51.4277029+00:00",
"updated_by_user_id": "1b7a22f2-44f6-4276-bc45-93b5701b3cb5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-09T11:08:51.4277029+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-10-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-09T11:08:51.4277029+00:00",
"date_last_job": "2026-10-09T11:08:51.4277029+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-09T11:08:51.4277029+00:00",
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00",
"is_mobile_installation": true
},
"job_type_id": "b6f35198-a555-4f47-afd8-6f24227e6ed4",
"job_type_code": "sample string 7",
"job_type": {
"id": "8301a077-da3a-4606-99d0-c96ec3a07d2c",
"name": "sample string 2",
"sales_organization_id": "2f201ac9-e25d-4632-a9d6-64b7d5b9708a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00",
"code": "sample string 7"
},
"job_priority_id": "88ee5f4a-f5b8-40ff-9923-7bbd35415043",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4026b6b6-76e2-4b81-a28c-3f3c303d7ae5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a2981e76-df13-4e46-910c-1a8722625b05",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00"
},
"job_status_id": "5372b852-1c0c-4554-b3e8-1282bd47908a",
"job_status_code": "sample string 11",
"db_address_id": "973c0012-cec7-4e06-a196-1c79533d6ee9",
"contact_id": "e5016341-3dd3-416c-bdba-6dd1a99eb265",
"requested_by_company_id": "78c9f736-8ae3-41d6-b3ad-8543d25f0799",
"requested_by_contact_id": "48db8df5-615a-4a72-beaf-a0dd3af5a76d",
"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-10-09T11:08:51.4277029+00:00",
"due_date": "2026-10-09T11:08:51.4277029+00:00",
"date_create": "2026-10-09T11:08:51.4277029+00:00",
"date_update": "2026-10-09T11:08:51.4277029+00:00",
"date_closed": "2026-10-09T11:08:51.4277029+00:00",
"suggested_user_id": "344cd3ec-f82a-4408-9638-06d5c066a158",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4ee80371-7e8a-4001-b8f0-d1c1b65459e0",
"db_language_id": "6d5f2f32-ff22-41db-a2bf-e7b9959d55a8",
"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-10-09T11:08:51.4277029+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "87b63806-7aaf-4955-a8d4-d6eecf7057d3",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8633d7af-0613-4eec-a763-c2e7d4ade787",
"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": "73e1e460-43ba-4cb2-9799-b24c3a01d160",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4f5ef74d-1d6e-44c8-8ccf-f74eba3c79de"
},
"suggested_date_start": "2026-10-09T11:08:51.4277029+00:00",
"skill_id": "95913ca9-df50-4134-89af-8479e2a03784",
"skill_code": "sample string 32",
"skill": {
"id": "8a80b80d-ad39-432f-818b-2c458fd202cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "571c425d-5ecb-4961-8cee-d8eb18e40fa5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "684a638f-f831-4533-836b-1e7bbb53bdb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5c52e8d-a737-41d2-900c-ef9c309031bf",
"db_currency_id": "ea900ab0-0510-4331-9470-c9fbda9b3761",
"db_language_id": "3a87dc8f-7a8f-4747-8a9b-d6d51aad4649",
"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-10-09T11:08:51.4164444+00:00"
},
"modified_dateutc": "2026-10-09T11:08:51.4277029+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eaeb08f3-8cfc-4dce-b92c-515d80ea3547",
"date_reported_by_company": "2026-10-09T11:08:51.4277029+00:00",
"id2": 36,
"company_id": "66e099a1-b73f-4e1d-adef-9b545a264f3d",
"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": "9f2866e2-ff58-4e9d-80f6-2a734aa34d25",
"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-10-09T11:08:51.4277029+00:00"
},
"work_instruction_details_id": "61bd29e6-ced3-4867-b034-44da1c531048",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6da6505b-933d-4e66-b4ed-6740d8fcdc29",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f14e81df-9393-4e27-8aa4-8bc6f00079db",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-09T11:08:51.4277029+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": "0ae00e8d-d98d-4639-8485-235f80174a14",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-09T11:08:51.4433003+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.