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": "2e3fe983-8b26-432f-a5af-68d3d1855444",
"jobs_id": "4c0e3431-29f3-40e9-830c-0b77215b7652",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8ee91665-03d6-4d2f-a961-8660eba7a34d",
"_parent_id": "088bde6e-981c-438c-9a86-f73e8de1f76e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9a681fd2-1f30-42ad-817c-99e16e8abe54",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f0947287-546b-4fec-aa96-e0fcc38d69cd",
"_parent_id": "b3a038ca-daee-4a55-bfdc-dd173c61f6b1",
"root_parent_id": "32081cc1-f931-45c3-9d1b-817647e69d67",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c6f621b6-821f-40bb-80a8-0762d77ac1dc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d390ba72-fe1d-491f-b46e-c51f7723d4be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6470281-c89c-493b-a856-7bc6b5f3b318",
"_parent_code": "sample string 6",
"sales_organization_id": "6f1d659e-f71c-438a-9406-a8628273b966",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
},
"equipment_model_id": "a48f0a70-5728-484c-aef9-3edd151f48d5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "580a07af-7c07-40cb-820d-d7ff8f357b08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "783d7597-fb21-4156-9613-3e829676df36",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ba0bee09-82cf-44d5-8219-38de07930201",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7e9a23aa-ac25-4e70-ace1-19ddff7ae3a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
},
"equipment_family_id": "1f41e314-fa7e-48b5-a3bb-6479bab1f89a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d390ba72-fe1d-491f-b46e-c51f7723d4be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e6470281-c89c-493b-a856-7bc6b5f3b318",
"_parent_code": "sample string 6",
"sales_organization_id": "6f1d659e-f71c-438a-9406-a8628273b966",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
},
"date_in_production_since": "2026-11-14T17:23:03.6569584+00:00",
"date_out_of_production_since": "2026-11-14T17:23:03.6569584+00:00",
"date_end_support": "2026-11-14T17:23:03.6569584+00:00",
"sales_organization_id": "1ffe5574-576c-4a37-8684-13f5ba50699d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+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-11-14T17:23:03.6569584+00:00"
},
"project_status_id": "788ab702-1bf2-476d-a48f-632405f2d80e",
"project_status_code": "sample string 10",
"project_status": {
"id": "99a40ee3-d261-465e-a05b-398763fb7199",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cce160de-6e1b-4175-bdc5-8480b601b898",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
},
"company_id": "89e3bfd5-4359-412a-b788-9a41877126da",
"company_code": "sample string 12",
"db_address_id": "d56b0911-9ec9-4498-bfd9-a0148c952c30",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4a6ada07-d224-478d-9260-092f844a63f0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "62be7abe-e291-4916-b90f-f1d3209b3064",
"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-11-14T17:23:03.6569584+00:00",
"date_create": "2026-11-14T17:23:03.6569584+00:00",
"date_update": "2026-11-14T17:23:03.6569584+00:00",
"updated_by_user_id": "614e2ee9-26c1-46c3-b5d6-451e00850d18",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-14T17:23:03.6569584+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-11-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-14T17:23:03.6569584+00:00",
"date_last_job": "2026-11-14T17:23:03.6569584+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-14T17:23:03.6569584+00:00",
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00",
"is_mobile_installation": true
},
"job_type_id": "f973e2ce-0e9d-4685-8984-2df6656b3e50",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d4d7a2d-29c8-471d-b1bd-cf327433c9b3",
"name": "sample string 2",
"sales_organization_id": "2af29584-031e-4247-ba18-727638758833",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00",
"code": "sample string 7"
},
"job_priority_id": "1b40afdc-712e-4368-a0a7-d4b5e37c30ae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5bceb00c-1a9b-48e5-877a-ca7ef78a8e44",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "98fad182-e916-423a-8187-1d74de04ca34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
},
"job_status_id": "016f6122-6b19-4049-be13-a0b697935d69",
"job_status_code": "sample string 11",
"db_address_id": "4605f303-d18c-435f-8004-8c8a27518313",
"contact_id": "8aa8c7e1-7be5-4b38-832e-7d4c7998990c",
"requested_by_company_id": "072aac35-c993-454e-a3cb-b09cd2e9485c",
"requested_by_contact_id": "a987f9db-b586-4a7b-ba38-9a1b65b6bac1",
"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-11-14T17:23:03.6569584+00:00",
"due_date": "2026-11-14T17:23:03.6569584+00:00",
"date_create": "2026-11-14T17:23:03.6569584+00:00",
"date_update": "2026-11-14T17:23:03.6569584+00:00",
"date_closed": "2026-11-14T17:23:03.6569584+00:00",
"suggested_user_id": "51df6b64-8641-4193-b9e1-ae31e61096ce",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "44ee6168-b65c-40e2-844d-3a67e615ac0b",
"db_language_id": "2087254e-088b-4fb8-a23f-ededcc554ae6",
"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-11-14T17:23:03.6569584+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f6ee52c-5a2d-4d32-9df8-4b4f7d5f8803",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "93d699ed-9bdc-412d-914b-6e5193eaabb0",
"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": "5dc95da8-9308-403c-abd1-8f66872fd60c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "16108971-4cf5-4825-98d4-6db501488570"
},
"suggested_date_start": "2026-11-14T17:23:03.6569584+00:00",
"skill_id": "c76b3f53-7cdd-4ba5-86c2-d1bac41b7ad7",
"skill_code": "sample string 32",
"skill": {
"id": "f76bc988-147d-482e-a07a-2844288497ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2b685c39-e0cb-457c-a8a8-a829d1f82703",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34dd2dfe-5e86-4499-9a29-e4961b576b0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f26d61a0-4568-420f-a31d-75f6bf215028",
"db_currency_id": "e8ad1dd4-a33f-42d6-b446-f52fb7e100f6",
"db_language_id": "47b50553-3894-4af9-97c9-221892bd0670",
"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-11-14T17:23:03.6569584+00:00"
},
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0c282fc4-5356-4061-86dd-0b6795882cd4",
"date_reported_by_company": "2026-11-14T17:23:03.6569584+00:00",
"id2": 36,
"company_id": "5709450a-8a7e-4311-a5f7-6cb1ea78d3cf",
"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": "f688683b-79aa-4118-9282-a55fc0a308c6",
"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-11-14T17:23:03.6569584+00:00"
},
"work_instruction_details_id": "af3210cd-109d-4ada-b297-ccab8fb9d98d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b8cae186-b4a6-4109-b8f9-eea5cb32a1b7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a758c622-97ee-404b-a212-9cee23a193dd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-14T17:23:03.6569584+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": "0205e82f-9500-419f-abee-3baa237e9990",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-14T17:23:03.6569584+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.