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": "28f7fb58-6999-45b4-86e9-030db63fedf7",
"jobs_id": "d3902857-afca-402b-9412-67ebd20a75f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "afe73942-6c46-4480-a6aa-b18cbeb55aff",
"_parent_id": "f89a77cc-f8f3-469a-ba9e-b2d1608dce40",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f3427efa-9778-4219-83ff-242a5caa85a3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7a77a89c-67ef-40df-a4ad-b89ff180f9f5",
"_parent_id": "0266400f-6978-4550-9c66-f42fa46641ee",
"root_parent_id": "70d6c81f-fea8-466d-8dfa-e804d500bc98",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ea0b7015-b292-4bf1-8912-f4dbdfda9c24",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5adb0ee3-344d-4c90-84ca-58b76bba8aa4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "93af8acb-68ac-4138-996c-fd6fe925b5af",
"_parent_code": "sample string 6",
"sales_organization_id": "9c6140ff-682d-4728-b8a6-5db571a5126d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
},
"equipment_model_id": "8170fae6-53e7-46b4-9e38-e51b7dbbe995",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "38093d55-5f8e-4786-aeae-68475db944bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f684b1ae-60ac-457a-8ddb-71b7183e5b48",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9bc1f1b1-fbfd-43a7-9de5-8de8099f168c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "797eede7-b5ca-49b9-ba0f-d6523aa056f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
},
"equipment_family_id": "201b1733-f3a8-4948-b2a9-9ab7de361726",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5adb0ee3-344d-4c90-84ca-58b76bba8aa4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "93af8acb-68ac-4138-996c-fd6fe925b5af",
"_parent_code": "sample string 6",
"sales_organization_id": "9c6140ff-682d-4728-b8a6-5db571a5126d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
},
"date_in_production_since": "2026-01-13T01:17:19.9676795+00:00",
"date_out_of_production_since": "2026-01-13T01:17:19.9676795+00:00",
"date_end_support": "2026-01-13T01:17:19.9676795+00:00",
"sales_organization_id": "76a64920-f406-4517-a402-9aba00f1e284",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+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-01-13T01:17:19.9676795+00:00"
},
"project_status_id": "91cb9d82-33bd-4cc0-b19f-6a11d3283105",
"project_status_code": "sample string 10",
"project_status": {
"id": "a18b3f17-0116-47e7-898c-c8bd7eeac72a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "623e8c4e-9065-40fd-baa4-1d2fefd6e8de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
},
"company_id": "079dfe00-bc23-4161-a39d-403981d84c8c",
"company_code": "sample string 12",
"db_address_id": "2045a122-e6a4-4e7e-97b8-452650893183",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0e304ae2-6740-4812-8805-d7b2b20219ff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2dc0d2e6-4f72-4854-a328-3255d3096184",
"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-01-13T01:17:19.9676795+00:00",
"date_create": "2026-01-13T01:17:19.9676795+00:00",
"date_update": "2026-01-13T01:17:19.9676795+00:00",
"updated_by_user_id": "0ae992d0-abbf-40f6-b070-ca89f38376e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-13T01:17:19.9676795+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-01-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-13T01:17:19.9676795+00:00",
"date_last_job": "2026-01-13T01:17:19.9676795+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-13T01:17:19.9676795+00:00",
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00",
"is_mobile_installation": true
},
"job_type_id": "8139ad43-7c3a-4cbf-82c8-c86a48d6a4ea",
"job_type_code": "sample string 7",
"job_type": {
"id": "7159c9e9-7e43-48ed-a67e-d9ee4b92e00d",
"name": "sample string 2",
"sales_organization_id": "44089636-43d2-4eba-9139-6b67a115d528",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00",
"code": "sample string 7"
},
"job_priority_id": "02b8b06e-ba44-48eb-9a02-11cb7021ba4f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e9d00345-9b8d-4564-bf6e-ffb06e06f3df",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "39252bad-82da-481a-a35d-61bb03aa7924",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
},
"job_status_id": "4da5d3ee-ede3-4e35-90d2-0f49cf9a4bc0",
"job_status_code": "sample string 11",
"db_address_id": "4924f1da-4721-43ce-90be-729bc47e5127",
"contact_id": "42d5a0a2-444e-44fd-86c3-d44c1776a811",
"requested_by_company_id": "8b8742b0-a980-4944-a0eb-302ab79ad03f",
"requested_by_contact_id": "6591c6ee-acca-4a7d-a85a-79cb20189c5d",
"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-01-13T01:17:19.9676795+00:00",
"due_date": "2026-01-13T01:17:19.9676795+00:00",
"date_create": "2026-01-13T01:17:19.9676795+00:00",
"date_update": "2026-01-13T01:17:19.9676795+00:00",
"date_closed": "2026-01-13T01:17:19.9676795+00:00",
"suggested_user_id": "d136835e-86eb-4589-bfbc-26fc1ea0ffca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fa5849f7-55e1-4405-a7a6-af2780d86db4",
"db_language_id": "cca0b812-cf4a-48f1-ac2c-5a947c5e3630",
"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-01-13T01:17:19.9676795+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1c880a3d-e582-4b52-86cc-34a887e7d774",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f7f55d63-a4f6-4e7d-84fb-f1410722cc8a",
"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": "85daa817-aa35-4ef0-97e8-62e95780aee1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0af2c7d5-3373-4407-bd2d-bd3cc6ded178"
},
"suggested_date_start": "2026-01-13T01:17:19.9676795+00:00",
"skill_id": "a65d64cf-28d6-45f0-815b-21cebfd5e2ba",
"skill_code": "sample string 32",
"skill": {
"id": "42049933-7ae2-4346-ae37-60c7d119cb55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "028ac2b3-05a6-4555-a68f-e7385d825c3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8d3d65df-84c4-4656-a169-3a6c4d4f45ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64a81fdf-b71c-413e-a234-c83988b224d5",
"db_currency_id": "bbbb8804-d3aa-456a-9947-04c58861267d",
"db_language_id": "d377b73f-1ca4-457e-b358-6f65c044d6e5",
"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-01-13T01:17:19.9676795+00:00"
},
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5e467bce-ee5f-4479-8b76-4eb94b7aac6f",
"date_reported_by_company": "2026-01-13T01:17:19.9676795+00:00",
"id2": 36,
"company_id": "291ddb42-63a6-479e-86d3-3754a0f284f8",
"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": "6fe0c7ef-2d1d-4fd9-a2ad-a2b164c69274",
"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-01-13T01:17:19.9676795+00:00"
},
"work_instruction_details_id": "3271e999-e779-440c-8ece-fed1afd363b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ea85d41a-ec93-4276-afe2-816029157c0e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bb9dcd2c-13ab-4370-aa69-bd2fb76111fd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-13T01:17:19.9676795+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": "f50d0cff-156d-4e66-99d6-1670263289b2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-13T01:17:19.9676795+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.