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": "71cf297e-5392-41cd-a80f-273b07a5e3d0",
"jobs_id": "aba6e422-a113-4e12-93be-c5d0886d6c3c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ca55d01e-d69d-4a73-b592-21c8a7051155",
"_parent_id": "04235c58-7dd6-4946-b0c5-21bbd24f9afe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aee295d6-012f-4985-9fc1-aef2d3b26062",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0938d67a-1916-429e-b223-5e24c10acfde",
"_parent_id": "093eb762-a192-4d54-8752-ced66feb9cc4",
"root_parent_id": "15601543-00ff-44aa-9434-affcce3ace6e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f22166e4-c08f-4f37-b3c0-1bc925dcc4cd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fe3ae2c2-7f29-413e-88c6-985c8e54561f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e2ffb17-95c3-4989-9494-7b44fb98dc93",
"_parent_code": "sample string 6",
"sales_organization_id": "3d539374-fa92-41ca-938a-a4e25eeb5a82",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"modified_dateutc": "2026-10-25T08:57:28.6532904+00:00"
},
"equipment_model_id": "19e99860-eea0-4dc3-8678-f3d8260cf6a2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d7ae170b-9338-4b75-9fe2-2fe69df64ee7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f5357a16-8ccf-4073-a92e-a0646d3bdcca",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "71112aa7-b0ca-45bc-8e1d-f79602467c92",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d5882932-8216-444d-b89d-ff44ed4c7ea0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"modified_dateutc": "2026-10-25T08:57:28.6532904+00:00"
},
"equipment_family_id": "e1468bec-3655-46f8-97a2-e9b9c3c4b029",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fe3ae2c2-7f29-413e-88c6-985c8e54561f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e2ffb17-95c3-4989-9494-7b44fb98dc93",
"_parent_code": "sample string 6",
"sales_organization_id": "3d539374-fa92-41ca-938a-a4e25eeb5a82",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"modified_dateutc": "2026-10-25T08:57:28.6532904+00:00"
},
"date_in_production_since": "2026-10-25T08:57:28.6532904+00:00",
"date_out_of_production_since": "2026-10-25T08:57:28.6532904+00:00",
"date_end_support": "2026-10-25T08:57:28.6532904+00:00",
"sales_organization_id": "26babb6b-8c30-4fc4-8af3-51c8ac052ab8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+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-25T08:57:28.6532904+00:00"
},
"project_status_id": "ad427ff9-4da0-4dbd-bd38-9707279392d1",
"project_status_code": "sample string 10",
"project_status": {
"id": "484088ab-7c73-435e-8192-b56daa05afe3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f3e77e74-e01e-416c-ae7f-fe23b8a72ff6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-25T08:57:28.6532904+00:00"
},
"company_id": "80ba1bf1-d2ec-4795-be50-80377dcca9a2",
"company_code": "sample string 12",
"db_address_id": "0e7428e3-acff-4243-a4cf-97c67b1709d7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5a9a2d21-0805-43a6-b8e7-2b3587b68f8c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "84846bb1-fb5b-4c01-98cc-1811ce3d855d",
"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-25T08:57:28.672933+00:00",
"date_create": "2026-10-25T08:57:28.672933+00:00",
"date_update": "2026-10-25T08:57:28.672933+00:00",
"updated_by_user_id": "9acfbb0a-3e0d-4ddd-bbb7-1afc9305d5c5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-25T08:57:28.672933+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-25T08:57:28.672933+00:00",
"date_last_job": "2026-10-25T08:57:28.672933+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-25T08:57:28.672933+00:00",
"modified_dateutc": "2026-10-25T08:57:28.672933+00:00",
"is_mobile_installation": true
},
"job_type_id": "1e80dd85-d14f-4f24-8008-696111fd5595",
"job_type_code": "sample string 7",
"job_type": {
"id": "6367eab8-7a76-4146-b649-b06ce7571d00",
"name": "sample string 2",
"sales_organization_id": "ecc4117a-c544-42f4-b503-3314870156cd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-25T08:57:28.672933+00:00",
"code": "sample string 7"
},
"job_priority_id": "af5bb3c3-8b90-47cc-ab96-64c01fe6df5a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6d138c00-84c2-4fa9-b68b-69ccbe83ffb9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f385b3f4-5b02-4576-9b5c-05acba0c347a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-25T08:57:28.672933+00:00"
},
"job_status_id": "5d0fd667-4825-4fa4-a85a-562bbf237c73",
"job_status_code": "sample string 11",
"db_address_id": "902f8247-71e9-44a1-9be1-46a467717481",
"contact_id": "3574ebc5-5768-4f85-a147-4a49980dfdf6",
"requested_by_company_id": "d10e5887-2042-4442-a0bc-b85123d4616d",
"requested_by_contact_id": "bfe8928d-efd2-49d6-b32f-c9712a38b9eb",
"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-25T08:57:28.672933+00:00",
"due_date": "2026-10-25T08:57:28.672933+00:00",
"date_create": "2026-10-25T08:57:28.672933+00:00",
"date_update": "2026-10-25T08:57:28.672933+00:00",
"date_closed": "2026-10-25T08:57:28.672933+00:00",
"suggested_user_id": "2783787b-8614-4b32-a46c-b4dd91800989",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68b59a88-d892-474d-ac56-681ed80adbec",
"db_language_id": "89cbbad2-b780-4abd-9139-137c08d9773f",
"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-25T08:57:28.672933+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d40f4fd9-b648-4434-b743-ae9d3ce913a8",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b245a7f0-79b1-48cd-90d5-84495b30cdf4",
"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": "df8b1310-c366-4b82-8447-6d9d9a61b3e0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-25T08:57:28.672933+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c6db29a6-d429-4123-86f9-4b68983edd69"
},
"suggested_date_start": "2026-10-25T08:57:28.672933+00:00",
"skill_id": "3a40b782-76b8-4bbd-a5d3-b564fd020522",
"skill_code": "sample string 32",
"skill": {
"id": "e18817d5-ad7d-4508-945f-bb22125dc949",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2b790bc8-68f3-4f7f-811e-726f9e7bdf87",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a1cca36-3a11-4dc7-ad02-e0ede27effd9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4fc3d407-6916-4610-93ef-dda940bcefd1",
"db_currency_id": "ffe34e04-a9bf-4c8b-9d61-2bbee15e6841",
"db_language_id": "c61a6b61-d2bb-480c-9773-6cd0a9a368e2",
"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-25T08:57:28.6532904+00:00"
},
"modified_dateutc": "2026-10-25T08:57:28.672933+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4f2e5d17-8688-47f8-b326-eb081c681d7b",
"date_reported_by_company": "2026-10-25T08:57:28.672933+00:00",
"id2": 36,
"company_id": "75beae8d-d1b7-4452-8591-45f30bd62369",
"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": "6a937d1a-c4c8-49d8-815e-be7e1d152ed4",
"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-25T08:57:28.672933+00:00"
},
"work_instruction_details_id": "cec0f0ba-ae0c-4fa0-88f8-e50ab2914bd5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a5ace778-bbe3-467e-a8b5-422af69847bb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "68f1b68d-dda0-43ae-a2d9-14937f7e9078",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-25T08:57:28.672933+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": "3c776f20-10d7-476f-a352-f8174b6b83b8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-25T08:57:28.68454+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.