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": "0a5709bc-77a8-45a7-a05b-7ec90a88c7e9",
"jobs_id": "439c147d-aa43-4685-877c-c5ecfd62c8cd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8bf598ee-1567-4607-b124-95c751737c4b",
"_parent_id": "9697cdc8-8216-48a2-90ad-702d335e1440",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8a5e41e7-790f-4f57-b7d2-a37ea1cf3c36",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1cc5deb1-177c-4094-b09a-a2479564ba9c",
"_parent_id": "1e6d14cc-b3bc-4ab1-819a-eed4e2b3ca4b",
"root_parent_id": "de4ee4d9-7703-44eb-b03b-ffe44f23bdbd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2298ca9a-a637-4639-89f7-4f9a15735900",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2ba186f0-8479-4464-ba43-6a35bca2704d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ddead64-a11c-4f1e-92d3-afaa0aa88050",
"_parent_code": "sample string 6",
"sales_organization_id": "ba978a17-d00b-4350-a987-bdb42431afef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
},
"equipment_model_id": "02bec788-f68f-4e14-a23f-edca8b0fc55e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "751b2b5a-1ccc-498c-a05f-c86260b394f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c330f653-1b8b-4c58-91b9-1d18e2880507",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cd2a5387-549e-4760-ad1b-0d771c56f819",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8a338e7e-66cd-45a0-86f7-988c0b70f385",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
},
"equipment_family_id": "eac2649a-4125-4a78-87af-0d7beb492020",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2ba186f0-8479-4464-ba43-6a35bca2704d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ddead64-a11c-4f1e-92d3-afaa0aa88050",
"_parent_code": "sample string 6",
"sales_organization_id": "ba978a17-d00b-4350-a987-bdb42431afef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
},
"date_in_production_since": "2026-09-18T21:23:11.184113+00:00",
"date_out_of_production_since": "2026-09-18T21:23:11.184113+00:00",
"date_end_support": "2026-09-18T21:23:11.184113+00:00",
"sales_organization_id": "ddc6e49e-c843-462e-8587-48f8a81c6637",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+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-09-18T21:23:11.184113+00:00"
},
"project_status_id": "bfc22e21-30bb-413d-8669-34b52e088d19",
"project_status_code": "sample string 10",
"project_status": {
"id": "7d889b7d-1630-4481-9532-1253a3becff1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "96271092-7c80-4761-bb77-31f1bbdbcfe6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
},
"company_id": "7bc490ac-a530-42cb-9828-22705517e6c8",
"company_code": "sample string 12",
"db_address_id": "0beca1c6-d3b6-4b55-a85f-8fa9159282d0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0776d2b3-75df-42de-9ba2-439a2a6d8195",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "586e1ffe-65af-4237-bc14-a0f4e13c98f5",
"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-09-18T21:23:11.184113+00:00",
"date_create": "2026-09-18T21:23:11.184113+00:00",
"date_update": "2026-09-18T21:23:11.184113+00:00",
"updated_by_user_id": "81918e2b-cb6d-4763-9692-1182de3f6759",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T21:23:11.184113+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-09-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T21:23:11.184113+00:00",
"date_last_job": "2026-09-18T21:23:11.184113+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T21:23:11.184113+00:00",
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00",
"is_mobile_installation": true
},
"job_type_id": "1ec5439a-67c9-43a1-a624-bd254325038e",
"job_type_code": "sample string 7",
"job_type": {
"id": "c4f83817-982e-44e2-93df-61c9be64e4c5",
"name": "sample string 2",
"sales_organization_id": "8ffb3b9b-7573-4bbb-8591-8c7bb6c9229c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00",
"code": "sample string 7"
},
"job_priority_id": "c9266b3b-f604-446d-9db9-44ce1690555e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "548e982b-f93f-4cbb-b61f-8787496cf023",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a6dc1a69-b732-4b75-bc15-9f1293d98732",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
},
"job_status_id": "f09a82f6-2e44-4a57-8090-df593bd500df",
"job_status_code": "sample string 11",
"db_address_id": "cd068df1-3c93-409e-b423-5993575d99a0",
"contact_id": "a076489a-8203-4680-ba58-7f27313ddeb0",
"requested_by_company_id": "05d18b9a-92a2-458d-80b7-d35372a19746",
"requested_by_contact_id": "d2291314-95e8-4631-abac-f421111dad41",
"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-09-18T21:23:11.184113+00:00",
"due_date": "2026-09-18T21:23:11.184113+00:00",
"date_create": "2026-09-18T21:23:11.184113+00:00",
"date_update": "2026-09-18T21:23:11.184113+00:00",
"date_closed": "2026-09-18T21:23:11.184113+00:00",
"suggested_user_id": "ab312b8e-bb69-4ddf-99b9-180723ba1769",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f0d5d84d-71c4-4aa3-8846-715239b69d05",
"db_language_id": "07e17ec3-fd66-436e-85ab-4fb9adec6e02",
"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-09-18T21:23:11.184113+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e33fde96-1267-4c46-98a0-bee98dec14b2",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6b838308-c5fe-457b-acd6-3800e65d54f2",
"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": "93cb01f8-c819-4a59-8fba-2c7f1be8acb4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9d8bde90-a40d-4b14-b661-ccbecc7fe796"
},
"suggested_date_start": "2026-09-18T21:23:11.184113+00:00",
"skill_id": "d00fe890-b995-4eca-b370-3c579407d712",
"skill_code": "sample string 32",
"skill": {
"id": "52264a86-3342-4192-86bc-ef59b9a7bfff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d412285b-4d76-47a6-b7ce-2fca206968f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0366beda-9e45-44ee-8bd7-76e73f7e7ab9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "710853c4-f8de-4e06-a23e-8cc7d9b711b1",
"db_currency_id": "eb291efd-816f-4a3b-83e4-7c306994f541",
"db_language_id": "339d88b4-72d9-4730-b1a6-1de9a0054793",
"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-09-18T21:23:11.184113+00:00"
},
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "44a11cbb-ec2d-4784-b75b-2a7d2b90c181",
"date_reported_by_company": "2026-09-18T21:23:11.184113+00:00",
"id2": 36,
"company_id": "bd1ef175-56e3-4b11-9159-62f13cfb4d74",
"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": "4c317caa-83e5-4c1a-a7f7-66c79451bfea",
"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-09-18T21:23:11.184113+00:00"
},
"work_instruction_details_id": "d40e6609-ade1-4ef0-b5b7-a28b76367c70",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7bc769c6-f5e9-4efc-a079-744ce23dd20c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "215f7af7-4682-428f-932d-b665c83fc5b6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T21:23:11.184113+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": "d8abfde2-4e9b-4ccb-886d-c26cb3410c8c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T21:23:11.184113+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.