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": "c54b37bc-4264-4820-86b1-febfec713fdf",
"jobs_id": "03dadc53-4f63-47e7-bb4f-0829049972d3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9ed5c896-1bc0-4ea3-b823-a2e732775686",
"_parent_id": "704be972-8c1d-42b5-9f10-956b7175dbac",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3535aa63-e0b4-46a4-86ea-52c6cb9b415e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b0268ab9-f921-47f1-8684-1848a04e8560",
"_parent_id": "f1e4e42f-ebbf-4293-b52d-540cbe2d047c",
"root_parent_id": "2cf88382-25ea-44f7-8756-d044b9c49a10",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "003e8c58-87a9-4ffc-9ce9-8862115e93f5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eb63bb6b-369b-48a2-8674-76bb226a1653",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e439f59b-f287-434f-91b1-253baa75033e",
"_parent_code": "sample string 6",
"sales_organization_id": "359cbf96-7fd0-4f26-ad9c-6e8c07d5cd40",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
},
"equipment_model_id": "81caa114-5bd3-48f8-9eef-e6182426c3fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e26ed12d-835e-4a65-9f5a-3a6d39814b15",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2b7cd761-d955-464e-b3ea-eb1d5ce63343",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "24822b11-9c65-477d-ac91-b197ecfab8d5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a605a5b9-4aed-4220-9b9e-48566eda9dd1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
},
"equipment_family_id": "85e5c9d7-8110-4271-bc5f-1e49102ed1db",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eb63bb6b-369b-48a2-8674-76bb226a1653",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e439f59b-f287-434f-91b1-253baa75033e",
"_parent_code": "sample string 6",
"sales_organization_id": "359cbf96-7fd0-4f26-ad9c-6e8c07d5cd40",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
},
"date_in_production_since": "2025-11-17T07:22:04.4189057+00:00",
"date_out_of_production_since": "2025-11-17T07:22:04.4189057+00:00",
"date_end_support": "2025-11-17T07:22:04.4189057+00:00",
"sales_organization_id": "f8976411-0c8c-4ce1-89a0-12aad0aeb549",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+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-11-17T07:22:04.4189057+00:00"
},
"project_status_id": "05e74579-c600-4fef-aee2-7c5101db2e74",
"project_status_code": "sample string 10",
"project_status": {
"id": "06a4117c-98db-49be-8f76-0e4730aecf9c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ef8ec2f4-cac9-40c4-b27c-164923af52e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
},
"company_id": "47b74a04-e143-44d2-96ed-ec126cb3cf0e",
"company_code": "sample string 12",
"db_address_id": "32743973-21ed-438a-a7fc-ce87289e4279",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1f825e5d-ac96-4b7d-944e-51c1426e9f51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8ded0508-0e5d-4cb2-9202-90a5a4a4778e",
"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-11-17T07:22:04.4189057+00:00",
"date_create": "2025-11-17T07:22:04.4189057+00:00",
"date_update": "2025-11-17T07:22:04.4189057+00:00",
"updated_by_user_id": "2d73b054-178d-4149-a807-938039dc1428",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-17T07:22:04.4189057+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-11-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-17T07:22:04.4189057+00:00",
"date_last_job": "2025-11-17T07:22:04.4189057+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-17T07:22:04.4189057+00:00",
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00",
"is_mobile_installation": true
},
"job_type_id": "9e752b9b-050d-403e-a58f-ea6233d594f2",
"job_type_code": "sample string 7",
"job_type": {
"id": "e304cf3f-1168-4134-a992-bc1ad38622a2",
"name": "sample string 2",
"sales_organization_id": "737b2ec7-e358-4921-b09d-2a2039f27adf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d2a7393-f77b-45f6-87f5-2305eefbd141",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2d462059-87de-4511-b8b0-eac7fe1d7179",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "69b39308-5a0b-44c9-9ea0-73073544e32d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
},
"job_status_id": "0e632089-9341-4e78-88ca-38328b846741",
"job_status_code": "sample string 11",
"db_address_id": "8e3f80be-db46-430c-a3e2-9799058eea14",
"contact_id": "c29a98d4-c1ef-4792-9508-88e3712e4e1d",
"requested_by_company_id": "e756a91a-a46e-46d8-b487-b843add66c59",
"requested_by_contact_id": "9119c263-ba12-42e6-8ab7-60d5960ff2f3",
"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-11-17T07:22:04.4189057+00:00",
"due_date": "2025-11-17T07:22:04.4189057+00:00",
"date_create": "2025-11-17T07:22:04.4189057+00:00",
"date_update": "2025-11-17T07:22:04.4189057+00:00",
"date_closed": "2025-11-17T07:22:04.4189057+00:00",
"suggested_user_id": "cd0e4fe1-d0fc-4314-b5a0-5241ff57bff3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f8fb236b-6032-45b6-947a-5f4e1723d85b",
"db_language_id": "22b2664f-afb2-4cb4-8aaf-7f911c3fd3c7",
"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-11-17T07:22:04.4189057+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "22fcc978-f094-4d04-baf6-0dd0b998998c",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1c795c1e-29cd-4988-a366-d4e5cd07896d",
"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": "18687842-a73b-429b-b8b6-369f65bceaa6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "afb8c2ac-08ef-4cbe-8617-d92b11a71e28"
},
"suggested_date_start": "2025-11-17T07:22:04.4189057+00:00",
"skill_id": "01b4631c-ce6e-4189-8be2-c892af38d84f",
"skill_code": "sample string 32",
"skill": {
"id": "69f1273f-6d07-4a40-aca6-5fbf9d000ef3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d2298be6-97fe-4e5d-a896-237a7112e7d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6a7c9f6b-ee53-4807-b13e-bd899414f22f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4b218bc-ce42-479d-96ac-bd233240ef92",
"db_currency_id": "5f9248bf-5a85-4776-bd39-d991ea8e4d65",
"db_language_id": "8aa55c9a-4980-45d7-a7ba-a177191e4c51",
"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-11-17T07:22:04.4189057+00:00"
},
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c8fa6c80-b6ab-4a62-a1d9-cbd3db1cf06b",
"date_reported_by_company": "2025-11-17T07:22:04.4189057+00:00",
"id2": 36,
"company_id": "748e9b65-71ba-4aa3-8e20-505f792f0958",
"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": "9717b0ee-af6f-40f2-882a-aab3aa1f641f",
"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-11-17T07:22:04.4189057+00:00"
},
"work_instruction_details_id": "b6e49b07-4a77-4269-ab76-2ed1cbeb8713",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "57a35503-3c5f-4ac2-b57a-20d1b74221fe",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "da941c80-30fb-4eff-b1c1-e0454f6b68d9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-17T07:22:04.4189057+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": "ce729086-b140-4084-90b9-9a209894f8f2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-17T07:22:04.4189057+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.