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": "038d9f73-f067-4ea5-86fb-ac8ce94c82fc",
"jobs_id": "e9be30a2-ec19-48e8-900a-9ab6ce54332e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "36bb42eb-9137-48a6-b544-f310f569671e",
"_parent_id": "dcdf9014-d711-4b23-bf63-34945dbaee54",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ac45f85b-d14f-40fe-9506-4631230f1773",
"project_reference_back_office": "sample string 5",
"project": {
"id": "26889b19-c02e-403d-80b3-7f63c3376ba5",
"_parent_id": "0ebf96e2-864f-4eda-b5ea-758391348fee",
"root_parent_id": "d3115e16-94af-482c-9c00-eb326d26c622",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "eb39ab87-995a-4fc4-aaef-0fbe73fcc54e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ccfda74d-ccf5-49e5-a79f-9de582bfa6b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0437196-869a-4cb9-82b7-fcd7beb7b32b",
"_parent_code": "sample string 6",
"sales_organization_id": "4393f444-a372-46c1-9af6-99211d84e8c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
},
"equipment_model_id": "93221b59-6cbe-4036-aa6c-ac7aa367ee5c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "931008f3-b5a8-40a4-b4ec-bf00975c0083",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "783f1f47-be83-4d75-9a3a-259023a5f49d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bc847bb9-a807-4682-97de-534589e4a04f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3c5a470b-7e18-48bc-b0ef-838e036e6bb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
},
"equipment_family_id": "77446f68-72fd-406e-b8b6-eb3664330fd2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ccfda74d-ccf5-49e5-a79f-9de582bfa6b9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0437196-869a-4cb9-82b7-fcd7beb7b32b",
"_parent_code": "sample string 6",
"sales_organization_id": "4393f444-a372-46c1-9af6-99211d84e8c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
},
"date_in_production_since": "2025-12-24T00:04:18.6463489+00:00",
"date_out_of_production_since": "2025-12-24T00:04:18.6463489+00:00",
"date_end_support": "2025-12-24T00:04:18.6463489+00:00",
"sales_organization_id": "80ebd500-1e02-4854-acdd-02cdf8b02755",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+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": "2025-12-24T00:04:18.6463489+00:00"
},
"project_status_id": "f36d6547-91a1-4dc4-94ba-6a8a4a855d0f",
"project_status_code": "sample string 10",
"project_status": {
"id": "657774cd-7bd4-4d78-a500-f2eb031ac85a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "106360d2-e21a-4b28-b13c-0020ca174611",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
},
"company_id": "5df6ac56-141d-4df5-8f79-ab465cecab1f",
"company_code": "sample string 12",
"db_address_id": "f2312b33-9b8c-401a-a5cb-9266417f2de6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0e656eb7-e359-4c9c-8c99-cf9451baab51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e55a71ae-10a6-4773-be83-3c15ee803bf3",
"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": "2025-12-24T00:04:18.6463489+00:00",
"date_create": "2025-12-24T00:04:18.6463489+00:00",
"date_update": "2025-12-24T00:04:18.6463489+00:00",
"updated_by_user_id": "d26d117b-53ef-44a3-a04c-3bc96362d13e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-24T00:04:18.6463489+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": "2025-12-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-24T00:04:18.6463489+00:00",
"date_last_job": "2025-12-24T00:04:18.6463489+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-24T00:04:18.6463489+00:00",
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00",
"is_mobile_installation": true
},
"job_type_id": "f74aff6d-4922-4745-99b4-1001e9eedd17",
"job_type_code": "sample string 7",
"job_type": {
"id": "2c2ee835-57d7-4f0f-9006-3f7c279aa419",
"name": "sample string 2",
"sales_organization_id": "b3c3874c-37f6-4a63-959a-c7ff786d4e5a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00",
"code": "sample string 7"
},
"job_priority_id": "8096460f-519d-42a2-a0b0-dc6329201579",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c8e3d7cd-5dea-452d-a373-06dc879fcb6d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "52509b11-590d-41d6-9a88-ef302638e85b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
},
"job_status_id": "fdf65d15-1202-4b84-8f0b-5436def2f635",
"job_status_code": "sample string 11",
"db_address_id": "39efc8da-f23c-4145-a9ac-bdbecaeb2f44",
"contact_id": "14aaaaa1-cbea-4b5c-b41c-8663134f4380",
"requested_by_company_id": "1d38d086-a72c-4424-91b5-0a4020c9462d",
"requested_by_contact_id": "db590f26-9396-4edf-a613-6dd91ec0bd35",
"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": "2025-12-24T00:04:18.6463489+00:00",
"due_date": "2025-12-24T00:04:18.6463489+00:00",
"date_create": "2025-12-24T00:04:18.6463489+00:00",
"date_update": "2025-12-24T00:04:18.6463489+00:00",
"date_closed": "2025-12-24T00:04:18.6463489+00:00",
"suggested_user_id": "a6e72c9f-a37a-43a5-90d0-0e0bb3e3349a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "57ab0b4d-b549-46e8-9a15-d85c04c6ddc9",
"db_language_id": "7a25b086-57ef-495e-adf9-396bbc9297d5",
"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": "2025-12-24T00:04:18.6463489+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d349b642-c4a6-44da-a4e5-1eabb0558786",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0cee8b69-0859-446a-b129-7b30dd158d62",
"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": "e57d7809-eee2-48e1-a4d8-cf2ee3e2e98d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "20f02f1a-829b-4530-a236-6909f0bd7ee7"
},
"suggested_date_start": "2025-12-24T00:04:18.6463489+00:00",
"skill_id": "c997602f-7f37-4dee-9772-9132dad4afa6",
"skill_code": "sample string 32",
"skill": {
"id": "9b13afc4-f1f4-49e7-81fe-1026382c5f75",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ed388b4f-8ac1-4f81-aea0-67c65e6c1f68",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f6355e6-9b56-43dd-a4fe-71dc4071f19d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2e40d08-0baf-4f40-93e0-c462f33c8b8c",
"db_currency_id": "50749c55-3633-4e42-a890-de9c47bf0391",
"db_language_id": "016a57b1-5559-4dc2-a310-e7b7d5ad9dbe",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c254536-9bb5-43b8-9c8b-4e4fe3bc606d",
"date_reported_by_company": "2025-12-24T00:04:18.6463489+00:00",
"id2": 36,
"company_id": "7c448b7d-cc6d-491e-82aa-c47b95d47470",
"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": "34ff5ab4-6446-463d-8944-0145be286fc9",
"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": "2025-12-24T00:04:18.6463489+00:00"
},
"work_instruction_details_id": "2ac0ba3b-0436-48bf-bbca-12b7631b5b54",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3ef8ab5b-e4e5-4c54-8068-d17c08c237a3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c9c9e076-49c4-4d87-b2cf-dcbe177f7bf2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-24T00:04:18.6463489+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": "ada3b589-0126-430a-8c2c-8410c52cce09",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-24T00:04:18.6463489+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.