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": "149865ec-085b-40bd-9a93-4cc2b8daae75",
"jobs_id": "80338b18-ccdc-4942-b8a0-5adf49adc9ae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dbf2f726-6fb6-44e0-89a7-0d8518fdfa7e",
"_parent_id": "24551fb1-2db4-4e56-beb1-74916ab0a436",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e6a1f28e-c6fc-4871-8242-5a6f6f521101",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f745cbc2-ba99-492b-9341-d9599c87fe5b",
"_parent_id": "f1e4638e-b17e-4ffd-b2c4-2bda4e1c45fa",
"root_parent_id": "2396a17f-4462-4494-9694-bca423a3bae9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4441ed45-ad49-4131-8c57-67ed830b1045",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "320f0704-6818-480f-a336-a81bec757857",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d0803183-d22d-4fc6-9f34-ad944887c243",
"_parent_code": "sample string 6",
"sales_organization_id": "e89c8ef6-1ce5-4aed-9c20-0f97a21222f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00"
},
"equipment_model_id": "b51452a5-3c97-48aa-b271-929e595cedc7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "92a550bb-9b1f-464e-8b8b-6084dc1807ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6762c81a-bb9a-47e7-a066-0b3bf5652569",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7bc007d2-6f90-44de-831b-1ae19f5188c0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "820ebdc4-4c3f-40de-a2c0-c80601e90644",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00"
},
"equipment_family_id": "40a0ad47-c954-4a99-b058-79b067274948",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "320f0704-6818-480f-a336-a81bec757857",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d0803183-d22d-4fc6-9f34-ad944887c243",
"_parent_code": "sample string 6",
"sales_organization_id": "e89c8ef6-1ce5-4aed-9c20-0f97a21222f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00"
},
"date_in_production_since": "2026-05-15T02:13:26.7618648+00:00",
"date_out_of_production_since": "2026-05-15T02:13:26.7618648+00:00",
"date_end_support": "2026-05-15T02:13:26.7618648+00:00",
"sales_organization_id": "b13fe582-5f5a-4316-a559-a3d7f5872fb4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+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-15T02:13:26.7618648+00:00"
},
"project_status_id": "704c0479-9a4e-4f78-afda-9289ee0e8949",
"project_status_code": "sample string 10",
"project_status": {
"id": "17258ae7-d572-4095-b10d-a57993550c2b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d55e1d0d-9d11-4a38-86ad-148b4e719e82",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00"
},
"company_id": "c29cd34c-e786-4ae3-b200-70fe0f4a050b",
"company_code": "sample string 12",
"db_address_id": "0f11c7da-eafd-49f7-99b2-b383ca4207eb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d24bb574-5bf3-494f-988a-8b39ea197e58",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "37f38580-8d43-41ca-ba27-1fa7303e1d67",
"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-15T02:13:26.7618648+00:00",
"date_create": "2026-05-15T02:13:26.7618648+00:00",
"date_update": "2026-05-15T02:13:26.7618648+00:00",
"updated_by_user_id": "26b4ff5e-e6ce-45cd-ac8d-8dad8d044981",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-15T02:13:26.7618648+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-15T02:13:26.7618648+00:00",
"date_last_job": "2026-05-15T02:13:26.7618648+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-15T02:13:26.7618648+00:00",
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00",
"is_mobile_installation": true
},
"job_type_id": "001939af-d0d9-4638-89d9-7af65d74257f",
"job_type_code": "sample string 7",
"job_type": {
"id": "a1b2b1b5-7a1c-441b-b376-195551049b60",
"name": "sample string 2",
"sales_organization_id": "e7740ed8-4d8a-4f9c-a6be-81ef75182485",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00",
"code": "sample string 7"
},
"job_priority_id": "b733d640-e2a1-4f06-836a-b75af7ba524f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21ab3ea7-a688-41af-9e9b-44ed49a1278d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d1aa2cb-330b-4392-b1c5-42ea0b61ec9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-15T02:13:26.7618648+00:00"
},
"job_status_id": "cbcbb8a5-2555-490d-9164-769134a62239",
"job_status_code": "sample string 11",
"db_address_id": "0cd53e5d-f2f2-418f-af71-ae6865f95686",
"contact_id": "f0f77001-3bd1-48b0-ac05-f05ab469d2ce",
"requested_by_company_id": "ec03ec92-3ef1-4b98-9aa4-302213e60825",
"requested_by_contact_id": "2adfe2b4-823e-4809-b43e-e48ebdd20a27",
"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-15T02:13:26.7774877+00:00",
"due_date": "2026-05-15T02:13:26.7774877+00:00",
"date_create": "2026-05-15T02:13:26.7774877+00:00",
"date_update": "2026-05-15T02:13:26.7774877+00:00",
"date_closed": "2026-05-15T02:13:26.7774877+00:00",
"suggested_user_id": "4d825e39-2270-4bbf-abc0-a5f7192f04b7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "16d922f3-434a-4c5c-955f-0e29d005a88a",
"db_language_id": "9afbeae6-977b-41eb-8299-7f3e350ec97a",
"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-15T02:13:26.7774877+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0190acfd-d050-405a-a542-fe31937f6b04",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "219b277a-bd4b-4a2c-affa-736f4dbebb5e",
"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": "92239a04-9937-4db4-a5b9-e8584bb4d99d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-15T02:13:26.7774877+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce8072ef-c4f3-4c4b-a3b6-e4bfa7ab6263"
},
"suggested_date_start": "2026-05-15T02:13:26.7774877+00:00",
"skill_id": "9a402c3e-2860-467d-bbc5-1ec628dba37c",
"skill_code": "sample string 32",
"skill": {
"id": "6e4d7897-b84e-470f-b311-a20ef59aba88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7bc7ad67-9364-4e80-9eb8-bc142ace6618",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c850c664-c7e4-4406-837a-3448bd44a011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5039697-e4ec-4cf3-b232-619026a81ae3",
"db_currency_id": "2f1da246-c482-45cc-936e-bf7cff2bba64",
"db_language_id": "603cb0c7-5ad7-458d-831d-34cb98221af4",
"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-15T02:13:26.7618648+00:00"
},
"modified_dateutc": "2026-05-15T02:13:26.7774877+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b11f528a-29e9-4206-9128-fd19c796b504",
"date_reported_by_company": "2026-05-15T02:13:26.7774877+00:00",
"id2": 36,
"company_id": "f1d9bc8a-b9db-4ba7-9923-87a9574ff101",
"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": "2fe018ec-4413-4dc0-84ce-8bdedbed469a",
"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-15T02:13:26.7774877+00:00"
},
"work_instruction_details_id": "29cad234-d849-47b2-afdd-05c67c44c524",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "90e20687-feb4-4c9f-bdd9-c97184c26f1e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5810f465-cae7-4b4b-a0fc-6b23dd8be686",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-15T02:13:26.7774877+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": "653b2919-f550-49d2-905f-839caca3d64c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-15T02:13:26.7774877+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.