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": "ce28b8be-af4c-4d1d-a733-4cc414b38c55",
"jobs_id": "d6185e84-97fa-4b8c-ae49-6482c5069966",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed8d2d29-507c-4d93-9e23-d37cdcfc4eca",
"_parent_id": "eb56cf6e-b6bc-4e78-8ecb-b7852c71c3c5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b56d178a-db0c-4222-8bbb-7e7a29655191",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04fec81e-3fb9-4367-bdfc-6c557d0f4643",
"_parent_id": "2df619fd-f22b-461c-9ab8-d1e70afeb3de",
"root_parent_id": "2530cdf8-529a-4ada-a2f3-dc7559293d15",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b51f0d7-e0c6-4361-8974-497feed97f15",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "09fd9ab3-af66-42e1-8ccf-5e23a48adde7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3945ec4e-87bf-478b-86d7-b2a4eb09d956",
"_parent_code": "sample string 6",
"sales_organization_id": "4c8dd948-3a02-470d-981e-4e609cead2a5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
},
"equipment_model_id": "74de63aa-0c90-4e95-94bd-1870676b57ee",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "15d56b89-52a5-441d-bee7-441c659b4e4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "22b0a685-b8ce-43a9-a867-dc495918fb45",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "283eed38-e088-439c-9d39-e855d5f0d711",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cc3bfb0d-78ae-46c5-9201-e07e0a410453",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
},
"equipment_family_id": "0696dbba-c9df-4428-b398-b35806c7ceac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "09fd9ab3-af66-42e1-8ccf-5e23a48adde7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3945ec4e-87bf-478b-86d7-b2a4eb09d956",
"_parent_code": "sample string 6",
"sales_organization_id": "4c8dd948-3a02-470d-981e-4e609cead2a5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
},
"date_in_production_since": "2026-07-14T06:27:29.0209501+00:00",
"date_out_of_production_since": "2026-07-14T06:27:29.0209501+00:00",
"date_end_support": "2026-07-14T06:27:29.0209501+00:00",
"sales_organization_id": "283880ec-0934-429c-97b8-6c203911d7cb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+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-07-14T06:27:29.0209501+00:00"
},
"project_status_id": "eee5c735-a68a-4d61-9464-f978736b6585",
"project_status_code": "sample string 10",
"project_status": {
"id": "0886cd3d-88be-4de2-8e47-6e612770ac51",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5d627607-916c-4cb9-bb75-57889450500d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
},
"company_id": "dfe9d6f1-483f-43ae-8ae7-4f673bc0a609",
"company_code": "sample string 12",
"db_address_id": "2e914b9e-d217-4123-857f-087fc769d407",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dc58823b-59ed-4882-8ecf-6e3b000f1f9e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "180eb81e-8f47-47ce-8e9d-6efbdb317af1",
"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-07-14T06:27:29.0209501+00:00",
"date_create": "2026-07-14T06:27:29.0209501+00:00",
"date_update": "2026-07-14T06:27:29.0209501+00:00",
"updated_by_user_id": "9c2197ce-663e-4e89-82b9-49f40662900d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-14T06:27:29.0209501+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-07-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-14T06:27:29.0209501+00:00",
"date_last_job": "2026-07-14T06:27:29.0209501+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-14T06:27:29.0209501+00:00",
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00",
"is_mobile_installation": true
},
"job_type_id": "54350103-3c0d-4c3e-b2dd-46e08bfa0a12",
"job_type_code": "sample string 7",
"job_type": {
"id": "b765a53b-7351-4b66-b2df-ed189b3bc1da",
"name": "sample string 2",
"sales_organization_id": "cf286063-eca9-47f0-8e30-11855e4e9cb8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00",
"code": "sample string 7"
},
"job_priority_id": "92199a0f-5f4a-4c75-9536-cc6db761d5fb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2df6b39d-0786-4efd-993b-e45db81e803b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fde95841-9256-44de-9f94-746eeda492a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
},
"job_status_id": "18b4c154-350c-448e-8ab9-108915acd96f",
"job_status_code": "sample string 11",
"db_address_id": "acb84d04-619c-459b-af41-2767db304a1f",
"contact_id": "14a1aabb-ee3e-413c-ac58-cedb17878e9c",
"requested_by_company_id": "98622a7b-779d-448c-ae0c-dd3b8f4e67a5",
"requested_by_contact_id": "e79d33d8-f311-48fd-97ce-374d2fca2da3",
"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-07-14T06:27:29.0209501+00:00",
"due_date": "2026-07-14T06:27:29.0209501+00:00",
"date_create": "2026-07-14T06:27:29.0209501+00:00",
"date_update": "2026-07-14T06:27:29.0209501+00:00",
"date_closed": "2026-07-14T06:27:29.0209501+00:00",
"suggested_user_id": "3ab36423-caf0-42d5-beaa-5ceb03f3571b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "61b306b5-4f97-4d80-8e64-0b91ddb5fff3",
"db_language_id": "c9a4caa2-8f4c-412f-965c-a0fe1b2b8256",
"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-07-14T06:27:29.0209501+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a373005d-5aed-4124-a84c-3636a520a8e8",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "044b3f58-117e-43a6-ac12-1abba5b90922",
"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": "773a832d-7d0c-4320-ac59-3a5123643c0e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "432cd33d-4d64-4421-8eef-73d00eb9e0fc"
},
"suggested_date_start": "2026-07-14T06:27:29.0209501+00:00",
"skill_id": "c4cc0167-f381-43b2-add9-21692b9378df",
"skill_code": "sample string 32",
"skill": {
"id": "b2c00fcd-cec4-4e7c-8a44-ff86e1f2564b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cdb1c22a-90ce-4dd9-81cf-358ca21bcd29",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf326424-ba7d-482c-ae65-eff47c4a8557",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "46f292a4-a861-4cd0-96c0-21f505df2116",
"db_currency_id": "d06eb80f-a42e-4708-8204-6ebf34facc2e",
"db_language_id": "7b73334c-8b1e-416c-a429-d9e1c68095bc",
"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-07-14T06:27:29.0209501+00:00"
},
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b1545cc0-2fd4-463b-a0b1-3c04140d6802",
"date_reported_by_company": "2026-07-14T06:27:29.0209501+00:00",
"id2": 36,
"company_id": "b934bc8a-9b7e-46d4-8ef3-dc31e353f346",
"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": "c3664dc7-0089-4d3f-bb9b-31eccb85e7f6",
"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-07-14T06:27:29.0209501+00:00"
},
"work_instruction_details_id": "7bda1b58-9327-4864-8b0e-c4e3e0d0aa37",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "65e8ac59-8919-4283-b4fe-fdb242a224ae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7264f5cb-da2a-4e92-840b-41ffc4ed980e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-14T06:27:29.0209501+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": "c32e4d2e-98cf-4a28-a168-0ea47d6c8160",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-14T06:27:29.0209501+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.