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": "81a90035-8d7c-49a4-851a-ee0c36867d2c",
"jobs_id": "e8a6dfe4-7509-44a0-a07a-0c599a651cbd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e34f3362-bf65-4132-93ec-4a5d91923a6b",
"_parent_id": "2d71f48c-7441-4abe-b751-469beac40929",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4b864232-f1d4-473f-a4b5-77ffc004ed78",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4358d7b9-ab8c-43dd-affd-b73b055c0023",
"_parent_id": "b43f8816-4465-4fa3-b9b2-81cfc1be20b5",
"root_parent_id": "906aeb5c-4e47-4937-b4cf-f3858445045a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "432284d6-44d3-496c-a151-f81f6a7b6897",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b4f22097-b964-4948-a44d-0abe9b35b2e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "60476073-b42b-4011-91f7-f93d3caa8413",
"_parent_code": "sample string 6",
"sales_organization_id": "7fa46fb0-37ef-4930-b804-19d6375052d6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"modified_dateutc": "2026-10-28T23:46:40.1365838+00:00"
},
"equipment_model_id": "c12af65b-00f8-4d21-b0d5-bd353fa444a2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "600ece0f-9549-4de7-a2a4-f3b0d3dd451d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7d33fe0a-1a25-4b04-9326-a8b669b7fd09",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "82208732-d9db-4c97-87f0-addf11adc130",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b05c4e29-4593-423f-8fdc-bf94fa42cf35",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"modified_dateutc": "2026-10-28T23:46:40.1365838+00:00"
},
"equipment_family_id": "a6096970-ec21-4c89-a172-4bee648631ec",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b4f22097-b964-4948-a44d-0abe9b35b2e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "60476073-b42b-4011-91f7-f93d3caa8413",
"_parent_code": "sample string 6",
"sales_organization_id": "7fa46fb0-37ef-4930-b804-19d6375052d6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"modified_dateutc": "2026-10-28T23:46:40.1365838+00:00"
},
"date_in_production_since": "2026-10-28T23:46:40.1365838+00:00",
"date_out_of_production_since": "2026-10-28T23:46:40.1365838+00:00",
"date_end_support": "2026-10-28T23:46:40.1365838+00:00",
"sales_organization_id": "0af1c2fd-8fde-4601-943b-1e8dbe99c82c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+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-28T23:46:40.167505+00:00"
},
"project_status_id": "b1981962-5011-46e3-87e6-c8c635a1539b",
"project_status_code": "sample string 10",
"project_status": {
"id": "3716523f-194d-4cf6-b5cf-8d9eba8d0eff",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1d199f9d-4547-400d-97f1-060869d4196f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-28T23:46:40.167505+00:00"
},
"company_id": "e64e1717-21b9-4de1-ae7f-fc861a5df265",
"company_code": "sample string 12",
"db_address_id": "371e5830-ef55-46b6-82ac-f572f40a2ec6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b76eaed-2a7a-459a-a5a2-b0780857be90",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "88f31982-2c86-4444-b987-cf1af3da623d",
"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-28T23:46:40.1855886+00:00",
"date_create": "2026-10-28T23:46:40.1855886+00:00",
"date_update": "2026-10-28T23:46:40.1855886+00:00",
"updated_by_user_id": "c9d24118-5b11-45ed-9b39-7924a7721367",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-28T23:46:40.1855886+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-28T23:46:40.1855886+00:00",
"date_last_job": "2026-10-28T23:46:40.1855886+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-28T23:46:40.1855886+00:00",
"modified_dateutc": "2026-10-28T23:46:40.1855886+00:00",
"is_mobile_installation": true
},
"job_type_id": "46e35af5-766a-44a7-a744-9aea62dc62ea",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6bb1570-9290-493b-894f-39578c70e3a2",
"name": "sample string 2",
"sales_organization_id": "71e2d6fe-3255-4aee-bc70-47bbc72eceab",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-28T23:46:40.1855886+00:00",
"code": "sample string 7"
},
"job_priority_id": "5cd577df-996b-4923-b2d5-83a34ffa8b42",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "745adf1e-1bbe-47ab-9077-2daf1c21ea54",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d6b529a2-2de0-4c52-9a58-0e4044b45f6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-28T23:46:40.1855886+00:00"
},
"job_status_id": "19827a50-7d0e-4fe9-9ede-b4100a72537c",
"job_status_code": "sample string 11",
"db_address_id": "d75f4dcc-95d2-416a-8621-d468f83e4304",
"contact_id": "1ed35071-493c-45f2-ac31-ecfbbf30fbcf",
"requested_by_company_id": "25a0586d-abc9-4116-a81f-4aff008db7c2",
"requested_by_contact_id": "f8ee6085-99df-4d33-ad90-57c28ab4c87d",
"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-28T23:46:40.1855886+00:00",
"due_date": "2026-10-28T23:46:40.1855886+00:00",
"date_create": "2026-10-28T23:46:40.1855886+00:00",
"date_update": "2026-10-28T23:46:40.1855886+00:00",
"date_closed": "2026-10-28T23:46:40.1855886+00:00",
"suggested_user_id": "21901dd5-fbae-4968-9866-31ad8446370c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "25961f37-f49e-46e7-ba8a-4972ccf5f178",
"db_language_id": "506fe2c2-597e-495c-9ed4-631bbdf358f5",
"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-28T23:46:40.1855886+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e0ed9f0c-2ef0-44ba-a25a-4775f4d457c9",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8c061623-14e4-492f-9201-994a11b5660d",
"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": "2ed16b14-f58f-4795-89f3-1304c9114b29",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-28T23:46:40.1855886+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aa2f39b5-30f4-4039-a630-857ae34232a9"
},
"suggested_date_start": "2026-10-28T23:46:40.1855886+00:00",
"skill_id": "67e8886a-501f-4c72-a5cf-e58552f9ca7f",
"skill_code": "sample string 32",
"skill": {
"id": "4b5130ff-c876-404a-9a97-9e7cbd505a73",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8783e428-ad4d-45f3-bc1a-68d16d7d503b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2f5c1cf-e144-4817-a735-5975c5e0a350",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5ea34ce-82d5-4515-a73f-e19367cc7d13",
"db_currency_id": "d7092406-1f1b-4c56-a6c7-871f92727fe9",
"db_language_id": "a88eefef-d47f-4e05-bcf1-b13318a2dff5",
"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-28T23:46:40.1365838+00:00"
},
"modified_dateutc": "2026-10-28T23:46:40.1855886+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6695f5aa-fdc1-4c88-b084-72fc86a33b35",
"date_reported_by_company": "2026-10-28T23:46:40.1855886+00:00",
"id2": 36,
"company_id": "fc95c058-61ab-41a2-b052-27ac413527c8",
"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": "2cfac0b8-f07c-42e7-8f1c-00ce12707f04",
"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-28T23:46:40.1855886+00:00"
},
"work_instruction_details_id": "511f2deb-7a7b-4703-8b93-bd08981ee6c4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d9da7ec5-d8a9-4c32-a968-8d7512619477",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1d11a543-49e0-4d02-8e64-ffaeece1fb2c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-28T23:46:40.1855886+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": "752f49e4-b7fe-4d72-ad78-af5903f0f1cd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-28T23:46:40.1987501+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.