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": "162c0de6-4205-4b26-92f2-ce3afc7af585",
"jobs_id": "e017a697-4a5b-4b8b-aeae-5a7ab0eb4016",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "25588048-922a-4152-b0fd-f3b0896512b1",
"_parent_id": "bd83b08f-cdb8-403a-be1d-6c9aa8440636",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "baa53f6f-0821-493e-ad45-92f529d1f100",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8929a3bd-a656-423d-8f03-9f803bd3b06c",
"_parent_id": "2d1de98b-0e1e-4f45-b1cf-68426b28b7c3",
"root_parent_id": "a28742d0-441f-450c-be98-b5d328dd49c9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "893d8eaa-64e2-468a-8c30-0522a92683ec",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "98578448-da2b-45e4-98f8-10ab04d55586",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b7807963-d16d-41de-b05b-dab5802fc58f",
"_parent_code": "sample string 6",
"sales_organization_id": "6aa99456-9735-40b4-bced-7a40221a9588",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00"
},
"equipment_model_id": "ce846445-075a-4f1f-b055-f2da2fa4431e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cf0fb4c8-942b-428a-91f7-1967f4c1d350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "14c19837-1c59-4947-9687-8e311f3cff3a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b0207821-3c4a-49cb-b590-2e7ed4f55a1b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fcd9a593-8621-4b7a-bf96-974e26398235",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00"
},
"equipment_family_id": "47983528-937a-46aa-857d-d6c00270b2dd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "98578448-da2b-45e4-98f8-10ab04d55586",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b7807963-d16d-41de-b05b-dab5802fc58f",
"_parent_code": "sample string 6",
"sales_organization_id": "6aa99456-9735-40b4-bced-7a40221a9588",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00"
},
"date_in_production_since": "2026-08-19T02:38:01.9647323+00:00",
"date_out_of_production_since": "2026-08-19T02:38:01.9647323+00:00",
"date_end_support": "2026-08-19T02:38:01.9647323+00:00",
"sales_organization_id": "02616718-8031-4a0e-a7af-3c16f7ad6177",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+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-08-19T02:38:01.9647323+00:00"
},
"project_status_id": "6c6412cc-6fd7-4e8d-863a-a8d4e5824bb8",
"project_status_code": "sample string 10",
"project_status": {
"id": "c2a5710e-e25d-4366-8aeb-cdd3c6f3f4d5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ea59b96e-8404-4eee-818f-588f5ab1de2d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00"
},
"company_id": "aed6b5ea-e578-49db-8b4d-455f4190aa9a",
"company_code": "sample string 12",
"db_address_id": "03682574-3ab3-4b34-bbd7-a06e24bdb041",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b7dc78e1-f269-40ea-97e6-4d22e5c1fcdb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5d0fdc33-4423-4177-a099-17aec0d827e8",
"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-08-19T02:38:01.9647323+00:00",
"date_create": "2026-08-19T02:38:01.9647323+00:00",
"date_update": "2026-08-19T02:38:01.9647323+00:00",
"updated_by_user_id": "40883bf4-39d6-4ce2-8ee7-ceb9f56f43a7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-19T02:38:01.9647323+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-08-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-19T02:38:01.9647323+00:00",
"date_last_job": "2026-08-19T02:38:01.9647323+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-19T02:38:01.9647323+00:00",
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00",
"is_mobile_installation": true
},
"job_type_id": "f14992d9-edaa-43ce-8f20-accdbd144d99",
"job_type_code": "sample string 7",
"job_type": {
"id": "cb90c825-fc36-4e80-af9f-6ccacee597ad",
"name": "sample string 2",
"sales_organization_id": "b27d400e-d62d-4fb1-bc21-c04d61cde8d1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00",
"code": "sample string 7"
},
"job_priority_id": "49d0f310-1988-4986-bcb0-ef51d98ffc1c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0560b548-506e-4c2e-9f38-5c4624aa8793",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ec1186a0-6e4f-4e73-987f-96ad77a1a866",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00"
},
"job_status_id": "e22c30f6-a7f2-493f-873a-7726e2a6bc22",
"job_status_code": "sample string 11",
"db_address_id": "7ec2dd7c-a323-476e-9404-b017180a47fb",
"contact_id": "b3dfc7ae-a694-4372-9b82-7ed9186adcbc",
"requested_by_company_id": "076de4cd-74eb-4bfb-9541-f62b26bc7abc",
"requested_by_contact_id": "77b77ef7-8ae9-4e70-aada-4b6fe64efa87",
"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-08-19T02:38:01.9647323+00:00",
"due_date": "2026-08-19T02:38:01.9647323+00:00",
"date_create": "2026-08-19T02:38:01.9647323+00:00",
"date_update": "2026-08-19T02:38:01.9647323+00:00",
"date_closed": "2026-08-19T02:38:01.9647323+00:00",
"suggested_user_id": "5170e56d-6a36-421e-89c5-456a2e6e5bf6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a10015a0-bc32-4463-9608-4c3412e5ea72",
"db_language_id": "3b89ace7-9b84-4992-91e0-f9f55010af84",
"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-08-19T02:38:01.9647323+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8aaf59cb-d901-40ce-9fe3-fe862b17ce1b",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7e2e2fe2-0a8d-4517-8267-9a1b19af5358",
"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": "70d9ad49-b9a2-47bc-9531-8a5919b63ce9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95701454-83f2-4925-83b6-2ce31c9704a2"
},
"suggested_date_start": "2026-08-19T02:38:01.9647323+00:00",
"skill_id": "88e2c817-717f-4c84-a096-a2e326db46d4",
"skill_code": "sample string 32",
"skill": {
"id": "70f0ced3-0797-4121-a912-ac16d5dbaada",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "32bb658a-35c2-43ae-852d-8ee704802ce6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5465ea69-0ea5-4fb7-b49a-4d5e326a7be2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4748af41-ba7a-4953-bc41-60150ec9958d",
"db_currency_id": "b89c2d1d-c593-4546-bffb-df2b91517deb",
"db_language_id": "674283b0-819f-49e4-a040-4c5b4aa0c154",
"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-08-19T02:38:01.9647323+00:00"
},
"modified_dateutc": "2026-08-19T02:38:01.9647323+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78eeb72a-5e46-4b4d-8a37-47fe5a81ce0c",
"date_reported_by_company": "2026-08-19T02:38:01.9647323+00:00",
"id2": 36,
"company_id": "579171bd-db2a-4cc0-9bbc-e12e97027e96",
"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": "54b2c755-7b5d-4771-867c-69dd70af625a",
"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-08-19T02:38:01.980357+00:00"
},
"work_instruction_details_id": "9875f224-84b1-4cb9-8729-9aa5d55b8388",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f09d9601-1921-4230-bd15-5a0bebfeac35",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1b6006bc-f16a-49bd-8cde-568e39fb5c1b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-19T02:38:01.980357+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": "705cd49f-b341-4fd5-a2e1-3ee9d22b4e41",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-19T02:38:01.980357+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.