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": "43e11879-f961-4f1f-92d6-320f35b9fa4a",
"jobs_id": "3eced069-148d-4dfc-9ded-9769e3d9dab8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "306032be-e7f4-40b5-9962-bbd532b95041",
"_parent_id": "f6370a1c-fdfb-4877-a586-cb7593bd64e7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8f58d81f-29b0-47c0-ac23-19e46e19e934",
"project_reference_back_office": "sample string 5",
"project": {
"id": "511c721a-19af-43b1-96a0-abfec87fabd9",
"_parent_id": "9be9a6cf-088f-4c98-96f3-ec420daa38ea",
"root_parent_id": "e52a74af-35c9-4edc-9444-315ca8343a2c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "380d35b2-8fef-4943-8423-14b1c934dc13",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "60648532-77df-4e37-965f-a8680578ce30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b296136-e8fd-4de7-9a48-71eaf5d739ad",
"_parent_code": "sample string 6",
"sales_organization_id": "97af1375-6f4c-43ed-a545-d69d71b5190e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
},
"equipment_model_id": "3b059c7c-4dad-478f-a5d6-0842b866ffd6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7ee8ff6c-ca9d-4b25-b3e6-c5fe5b103b59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0ef97ec8-5350-47ba-9329-1b234ae1e946",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "863cac45-218e-4d5f-84c4-5cdb11ea182c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5fc8ea5c-6e52-4e0c-b39d-af0cdd89f685",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
},
"equipment_family_id": "31987e06-9fb9-4c6e-8996-304675d93cf9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "60648532-77df-4e37-965f-a8680578ce30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b296136-e8fd-4de7-9a48-71eaf5d739ad",
"_parent_code": "sample string 6",
"sales_organization_id": "97af1375-6f4c-43ed-a545-d69d71b5190e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
},
"date_in_production_since": "2026-05-20T06:25:06.785649+00:00",
"date_out_of_production_since": "2026-05-20T06:25:06.785649+00:00",
"date_end_support": "2026-05-20T06:25:06.785649+00:00",
"sales_organization_id": "edc2428e-834c-4711-a5e2-e8d8dee6f53a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+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-20T06:25:06.785649+00:00"
},
"project_status_id": "83c88406-6d3f-4854-b299-fd7ca8ebcced",
"project_status_code": "sample string 10",
"project_status": {
"id": "d7104623-80a3-4fc8-b304-dbeb6654850b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e779301b-7847-463d-8603-f71a28cda92a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
},
"company_id": "a449df9f-c04c-4098-bc55-41beee454429",
"company_code": "sample string 12",
"db_address_id": "53e166cf-7342-473a-b013-6436ffc5d29e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "923d8665-3b2f-4278-8921-3f000d5e1e4d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b10a52c2-11ce-4fa6-a998-2ed144f41fec",
"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-20T06:25:06.785649+00:00",
"date_create": "2026-05-20T06:25:06.785649+00:00",
"date_update": "2026-05-20T06:25:06.785649+00:00",
"updated_by_user_id": "89cc0b9f-2426-4f54-a27d-7678bab519ea",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-20T06:25:06.785649+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-20T06:25:06.785649+00:00",
"date_last_job": "2026-05-20T06:25:06.785649+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-20T06:25:06.785649+00:00",
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00",
"is_mobile_installation": true
},
"job_type_id": "0037966c-30c6-4784-abe9-1b6c80e9f032",
"job_type_code": "sample string 7",
"job_type": {
"id": "75ad20e2-137e-4e3a-83dd-0c2af14b6872",
"name": "sample string 2",
"sales_organization_id": "5690bcbb-df71-47d3-bd65-4855acbd5d1f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00",
"code": "sample string 7"
},
"job_priority_id": "9dddea8e-7f23-49d6-a9ed-d9a4a444e288",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1fa6fd6f-acbe-4cbc-ab80-cbcbfc9c145e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5a3cea29-8968-48ba-93b7-88989c5e39fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
},
"job_status_id": "3b092087-67fc-4da8-ad04-de47bc49b912",
"job_status_code": "sample string 11",
"db_address_id": "54bd541e-6f4a-46d3-808c-99daa5ee8564",
"contact_id": "657ed773-1351-4f39-a9ad-77147fb1d6fa",
"requested_by_company_id": "c629acd0-d780-4f28-9bf3-3b2dc55b85f3",
"requested_by_contact_id": "c54acdd2-4b3e-4003-bafc-f1c0b250744b",
"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-20T06:25:06.785649+00:00",
"due_date": "2026-05-20T06:25:06.785649+00:00",
"date_create": "2026-05-20T06:25:06.785649+00:00",
"date_update": "2026-05-20T06:25:06.785649+00:00",
"date_closed": "2026-05-20T06:25:06.785649+00:00",
"suggested_user_id": "b4fdd8b0-a7ef-438d-9947-dd7ad18a0228",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "32e96178-0ee9-492a-bd0e-716423359eef",
"db_language_id": "0cd9861a-8ef2-4647-b53a-e0b50dfc8e1f",
"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-20T06:25:06.785649+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5942c55e-f38a-4eda-b1ff-a212504b2111",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5daf7c1b-87cb-4ea6-9c36-387f23090c51",
"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": "1ba53a2c-5846-429b-b1f1-cae12b0f0b38",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "199738a0-c709-4b5c-b8c1-4f51fc1f35a1"
},
"suggested_date_start": "2026-05-20T06:25:06.785649+00:00",
"skill_id": "2ad8da5d-33c1-46b5-8764-70cb7f5763f1",
"skill_code": "sample string 32",
"skill": {
"id": "829c24b0-6634-4059-95de-dae8a99b87dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "10afcbb6-d46b-405e-9d55-a6b7364ae101",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c4366206-6b53-4f96-8c40-c0d7145a4b73",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "63ba7b75-edf2-4d8f-902d-7e08df35b245",
"db_currency_id": "342231d9-e5a7-4bb1-90c8-f37344a6527e",
"db_language_id": "25ad7ac5-45e5-4cdd-b56d-812b1de9aa8a",
"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-20T06:25:06.785649+00:00"
},
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "968e1d83-a11d-487f-8b36-6ee79b14ca62",
"date_reported_by_company": "2026-05-20T06:25:06.785649+00:00",
"id2": 36,
"company_id": "7f09982e-c828-4ebb-ba61-5200431c5a94",
"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": "8b5ed80d-d9ac-4524-9633-dfc3b54cf1ef",
"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-20T06:25:06.785649+00:00"
},
"work_instruction_details_id": "9179fb44-301c-4057-942e-7204a3c6f8ca",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d9bbb1b5-1055-4ff2-aa36-d0c77495de7e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "de48a374-4008-4d6e-aac1-453fc1ab6f42",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-20T06:25:06.785649+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": "228b75cf-09dd-4a45-8a97-4b0673c9d43a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-20T06:25:06.785649+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.