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": "f5a4ee70-565f-4b88-a4b9-ed403074b3a4",
"jobs_id": "03d16136-61a6-4e47-b769-9da1dd82152f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "80233c73-2477-44e7-aba7-2cb8e4e1a95e",
"_parent_id": "2dff5c6d-d6e1-43de-a9ec-488ff1b0e3cf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fa70ef9e-b1f9-4cbe-b2b8-e748399fbf48",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3ee154d2-bcf5-477c-95d4-c2ef89139268",
"_parent_id": "2e569d66-7de3-4e0b-a02b-72faddc27b5e",
"root_parent_id": "f5a95397-f6b0-42be-b376-c48e8bf3b07b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d45d54a1-5b61-45fa-be13-e56576a8d782",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "07f59f2b-d543-40ca-a065-b578f323f50a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e74715e-8d1b-4e68-8af8-7698ee73cbfe",
"_parent_code": "sample string 6",
"sales_organization_id": "7711622b-3c3a-4223-877e-97030b9db789",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"modified_dateutc": "2026-10-06T19:42:13.5034919+00:00"
},
"equipment_model_id": "b2fcb5ea-4847-4393-b467-04a7a15d363f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5b2f6aa5-2db8-4593-95e0-45248a4b7b19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a7f049d7-6e09-4f15-a24e-d84b0c01b8a0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "77623e20-5a5f-4143-87ef-8294556e8835",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e257b9de-ef33-40a1-9cc8-98d8aa1e97fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00"
},
"equipment_family_id": "8060cc22-5f6c-44ce-878a-e0797588df55",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "07f59f2b-d543-40ca-a065-b578f323f50a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e74715e-8d1b-4e68-8af8-7698ee73cbfe",
"_parent_code": "sample string 6",
"sales_organization_id": "7711622b-3c3a-4223-877e-97030b9db789",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"modified_dateutc": "2026-10-06T19:42:13.5034919+00:00"
},
"date_in_production_since": "2026-10-06T19:42:13.5214922+00:00",
"date_out_of_production_since": "2026-10-06T19:42:13.5214922+00:00",
"date_end_support": "2026-10-06T19:42:13.5214922+00:00",
"sales_organization_id": "b4afd6ce-3bc8-4a71-9e3d-add2871ad310",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+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-06T19:42:13.5214922+00:00"
},
"project_status_id": "cea236b2-2ac1-4684-a109-b17b79a2af6c",
"project_status_code": "sample string 10",
"project_status": {
"id": "40f8c8a2-7fbe-4ea5-899a-807637191b88",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "434c8a7e-e096-4a8a-947e-2378e02ea2f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00"
},
"company_id": "b64e24a4-dfe7-4c9c-89c3-bf2c90b5a46c",
"company_code": "sample string 12",
"db_address_id": "25bd4850-7e19-40fe-8a46-11f930bda529",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3539c06f-7af3-47a1-97e7-2a86a066fb97",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90d3df53-10b2-481d-991b-df3f9ffe539b",
"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-06T19:42:13.5214922+00:00",
"date_create": "2026-10-06T19:42:13.5214922+00:00",
"date_update": "2026-10-06T19:42:13.5214922+00:00",
"updated_by_user_id": "258b115c-ee70-4d10-8af2-3a976e88768a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T19:42:13.5214922+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T19:42:13.5214922+00:00",
"date_last_job": "2026-10-06T19:42:13.5214922+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T19:42:13.5214922+00:00",
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00",
"is_mobile_installation": true
},
"job_type_id": "0dd66b67-2964-4ae1-a3c1-d132155688b4",
"job_type_code": "sample string 7",
"job_type": {
"id": "691e82d0-d625-421a-b1ef-293ba0081e45",
"name": "sample string 2",
"sales_organization_id": "997350f2-5e17-45ba-adfe-356021985ff2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00",
"code": "sample string 7"
},
"job_priority_id": "3dd1049e-3641-4b1d-8b7f-9acaf8f21e5a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "135d6544-96d1-4420-8f92-514b7122a4c2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "15d21664-4cc9-40ef-9a55-ef2488f7607c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00"
},
"job_status_id": "e1779015-0bbd-4fed-afca-a3bc6edf2647",
"job_status_code": "sample string 11",
"db_address_id": "5e873cf0-2787-43f4-90a7-a6745e04fdc4",
"contact_id": "45aaef54-3402-4d73-b628-ec3558eb5e0a",
"requested_by_company_id": "4cb09c2d-e83a-4dd0-a4a2-bcaac294d51f",
"requested_by_contact_id": "09a9991c-5e72-412f-9c6c-4cdca2861968",
"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-06T19:42:13.5214922+00:00",
"due_date": "2026-10-06T19:42:13.5214922+00:00",
"date_create": "2026-10-06T19:42:13.5214922+00:00",
"date_update": "2026-10-06T19:42:13.5214922+00:00",
"date_closed": "2026-10-06T19:42:13.5214922+00:00",
"suggested_user_id": "60f92595-eb02-4ba4-8d31-303dc753eb44",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "543c3c12-7cdb-4348-9974-eaf8042c8323",
"db_language_id": "f5e351b2-6743-4840-919a-04b01608d986",
"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-06T19:42:13.5214922+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4808cb55-46c4-4409-8760-cb8705296816",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fa7057a0-9e1e-4819-8c08-b6ce0f499233",
"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": "37a0e687-8022-494a-a868-c848ed3359f1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f59e7747-9e7c-4610-9af3-19e6f2d593c0"
},
"suggested_date_start": "2026-10-06T19:42:13.5214922+00:00",
"skill_id": "90a2e829-8f52-4234-9976-1079b7c35520",
"skill_code": "sample string 32",
"skill": {
"id": "9a67807c-ad7f-4a3f-81bc-79476cf16c23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8871fa0c-a774-41ed-9c1c-a959bc639531",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "db631f8c-aafe-496e-9507-a4984c052d2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ef4ac49-42e3-4203-b9f5-86d002c7820f",
"db_currency_id": "86be0273-1deb-4c28-88a2-1ea83f1e5d10",
"db_language_id": "36d7d470-3cd1-4ffc-a699-c7d6a55fd1e4",
"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-06T19:42:13.5034919+00:00"
},
"modified_dateutc": "2026-10-06T19:42:13.5214922+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5f70d779-1c59-42f3-8e93-50cf1a63e258",
"date_reported_by_company": "2026-10-06T19:42:13.5214922+00:00",
"id2": 36,
"company_id": "8fd57877-7318-41b2-b3de-ec348939c707",
"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": "2fe5ba0e-1099-42b7-b0d2-dccabcb1140f",
"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-06T19:42:13.5214922+00:00"
},
"work_instruction_details_id": "bcf08e77-bbb7-4d06-85e2-6495abe54547",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "764e1658-8f45-4fab-aaa9-47ab2c8abfd2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1da13988-2152-4aa0-a72d-c288cfb9d860",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T19:42:13.5214922+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": "57e94407-2ced-40fd-8f6d-45bccd692222",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T19:42:13.5346844+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.