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": "59ce0e3c-0522-4682-bf41-ac99eecf1d80",
"jobs_id": "3d24f053-05a8-4ed8-a7b7-0ffc1205044c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7e4723f4-7dec-4b58-9b5d-e4b38976333e",
"_parent_id": "543c515e-aba5-4d2c-83eb-599347284c6f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b7c7e355-9440-449c-bde0-b66473f7777c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "90114681-1a0a-4d9f-81c2-9c7fce444ccc",
"_parent_id": "2b750bc6-7f3d-4a48-9f17-2eadc66e24c0",
"root_parent_id": "f5a712cf-234d-43e7-8e90-820f2728f29f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5c2bfd77-ba71-4c7a-8794-f09f9e39b1c5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0e0ff2ba-9732-4421-b14c-d34fa26aba5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1dcb1ac5-3f26-4252-a22c-18c56e83b6e4",
"_parent_code": "sample string 6",
"sales_organization_id": "d11ebd51-afce-4186-b250-f2323e9f6fc1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
},
"equipment_model_id": "0c00827d-1380-45bb-8fbb-e2aed2ad4a87",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9eeecd54-d0bc-457b-a58f-39e208677e53",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59821e1e-1126-48d0-9426-f050ee412bf3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b35eb0bc-45b5-43b3-abe1-db9f6abc19b0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c7ba463-5537-4063-b7f4-962d35a1c21d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
},
"equipment_family_id": "60026bae-f763-448e-ac91-e24db9973176",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0e0ff2ba-9732-4421-b14c-d34fa26aba5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1dcb1ac5-3f26-4252-a22c-18c56e83b6e4",
"_parent_code": "sample string 6",
"sales_organization_id": "d11ebd51-afce-4186-b250-f2323e9f6fc1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
},
"date_in_production_since": "2026-08-29T14:37:22.6700229+00:00",
"date_out_of_production_since": "2026-08-29T14:37:22.6700229+00:00",
"date_end_support": "2026-08-29T14:37:22.6700229+00:00",
"sales_organization_id": "babef15f-f66a-43b8-9579-4380d371353a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+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-29T14:37:22.6700229+00:00"
},
"project_status_id": "9acc263b-cb36-49f9-b819-5eeb34a12274",
"project_status_code": "sample string 10",
"project_status": {
"id": "193b666e-03d4-43bd-8dad-8035a93b59b7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "41612ca2-30a0-421f-92b9-324f3163ba79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
},
"company_id": "b5a52543-5442-4e91-8ec3-82936c7f19a6",
"company_code": "sample string 12",
"db_address_id": "9c25a615-208a-462a-af36-fb180a6e4b82",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "181024aa-8f58-4914-bced-d7d779996893",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3cd9de15-667c-408b-bed1-ee12e1860075",
"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-29T14:37:22.6700229+00:00",
"date_create": "2026-08-29T14:37:22.6700229+00:00",
"date_update": "2026-08-29T14:37:22.6700229+00:00",
"updated_by_user_id": "81bd6a82-58a8-4362-8c89-27bcdb9b0f3f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T14:37:22.6700229+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T14:37:22.6700229+00:00",
"date_last_job": "2026-08-29T14:37:22.6700229+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T14:37:22.6700229+00:00",
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00",
"is_mobile_installation": true
},
"job_type_id": "6b438d34-e172-4829-be25-b979ab4511c3",
"job_type_code": "sample string 7",
"job_type": {
"id": "8760a011-54d1-4ce5-bcc4-bf2c02a1b96d",
"name": "sample string 2",
"sales_organization_id": "f617c86b-594b-40d5-b18c-87bd001a83c6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00",
"code": "sample string 7"
},
"job_priority_id": "09417a0e-6199-4344-9e1e-356f35968842",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e1a124a0-0d70-41d7-82f5-0f79b1b88b6f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a345be58-ed88-402c-8258-a92694ef9363",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
},
"job_status_id": "aed0dec5-8f82-48f3-af38-108d30e72d9b",
"job_status_code": "sample string 11",
"db_address_id": "862aee94-1188-4945-97f0-f839329dd281",
"contact_id": "18d49148-3ff6-43b2-986d-327916a35bda",
"requested_by_company_id": "604343f1-27b4-44b7-9f07-28d69126ee3e",
"requested_by_contact_id": "6a6364b8-68ff-4e12-8009-637ca540373a",
"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-29T14:37:22.6700229+00:00",
"due_date": "2026-08-29T14:37:22.6700229+00:00",
"date_create": "2026-08-29T14:37:22.6700229+00:00",
"date_update": "2026-08-29T14:37:22.6700229+00:00",
"date_closed": "2026-08-29T14:37:22.6700229+00:00",
"suggested_user_id": "0c51e511-0560-48d3-ad0d-f71fdb5c7971",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "56037e31-c811-4e11-9998-d2ddf7da29d5",
"db_language_id": "1e6b3a25-0bd5-4b85-80d8-4a7fed36fa12",
"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-29T14:37:22.6700229+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ad24c427-2fc4-424e-869c-5224960c6661",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c3ea5f92-4375-4fe3-8f44-2ff22c1424e3",
"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": "01f774a5-2847-492d-973d-6a01c3fb0063",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7317151e-32e4-4a81-a4e9-a23100462ed9"
},
"suggested_date_start": "2026-08-29T14:37:22.6700229+00:00",
"skill_id": "edf6035a-e8c5-4484-baf6-66f684c72b87",
"skill_code": "sample string 32",
"skill": {
"id": "fb4721c2-db2c-499e-8217-0161b58d3a97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c4e9e384-48b9-4827-af40-ce73bd696dd7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9fe27ad2-4d7f-4daa-afe1-7d1c78b65cd7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47fb534b-bb1c-4bff-8f00-9ff61d043aec",
"db_currency_id": "21c4164b-92bf-4f90-8237-2fba1ddbc41d",
"db_language_id": "9cb28585-5893-4511-a412-f84f7d22a7a4",
"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-29T14:37:22.6700229+00:00"
},
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d0f046fe-ea98-4a20-9f61-efbec5de87cc",
"date_reported_by_company": "2026-08-29T14:37:22.6700229+00:00",
"id2": 36,
"company_id": "9b826910-974c-4102-bfa4-90bf2f26ef28",
"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": "df5297f0-962b-4919-8d30-a712960dcf69",
"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-29T14:37:22.6700229+00:00"
},
"work_instruction_details_id": "7496cc3c-86e6-42db-9f73-7e8fc1905031",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dfbd94d0-4510-4542-9771-5871d4f2b7c9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3410b203-26ad-464d-9f82-7bc30e68cfc2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T14:37:22.6700229+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": "908a81a6-cb34-4386-85a9-a3bdb1078188",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T14:37:22.6700229+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.