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": "2f28df4d-c3a1-4083-a7be-4c6f599152d0",
"jobs_id": "48fa7f14-6909-475d-84ad-3b74c5caf9b0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e6ee6700-db9f-460b-8230-7f4b3c8ebf6d",
"_parent_id": "a71038ee-2ccf-4309-9599-a9f745fe4bb6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0ffd5105-5b63-4105-ab7e-597fac560cf9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "42281bc6-fae2-474d-994a-758d8b6f85e7",
"_parent_id": "1984209c-01d9-4e75-8afa-01943789706f",
"root_parent_id": "6751008c-16d9-4be2-8a8a-bd902d92411d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9e38ad3c-8502-4050-9004-192ffa114ec8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "25c4c0e2-322b-47d8-9eff-69826a59df71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "37741513-deef-46ee-bf77-47491a348203",
"_parent_code": "sample string 6",
"sales_organization_id": "04e6bdad-ab4e-4eae-af47-66a77a0d839f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
},
"equipment_model_id": "9692da2c-142e-44be-a87e-8d1d2dae0a3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0a483e11-6331-45f6-97a1-f1a115aba3dc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e5ae7706-5451-41b6-b020-be6fce7669ae",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "354daee0-8675-49f7-95ff-203c16393b5f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8c31d2db-3acf-49dc-a91f-c8f98227c709",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
},
"equipment_family_id": "e4aba04d-342c-4e60-8acc-64cf5428fe14",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "25c4c0e2-322b-47d8-9eff-69826a59df71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "37741513-deef-46ee-bf77-47491a348203",
"_parent_code": "sample string 6",
"sales_organization_id": "04e6bdad-ab4e-4eae-af47-66a77a0d839f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
},
"date_in_production_since": "2025-10-20T00:34:00.736226+00:00",
"date_out_of_production_since": "2025-10-20T00:34:00.736226+00:00",
"date_end_support": "2025-10-20T00:34:00.736226+00:00",
"sales_organization_id": "1508c0e5-c527-4f2b-a330-aa06a8a05177",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+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-10-20T00:34:00.736226+00:00"
},
"project_status_id": "3b25d235-2ef0-41b2-8754-2379c120d10e",
"project_status_code": "sample string 10",
"project_status": {
"id": "ad077760-b9ae-483d-9979-7d0274987d57",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "75409e4f-f2ff-4c9b-8e05-a51e22dcdcd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
},
"company_id": "f886b45a-1043-4e99-b712-51a91047ac51",
"company_code": "sample string 12",
"db_address_id": "f902ba16-108c-4af5-a8ef-ada877e100e2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0d34d61e-fe65-419f-9454-d1c4bd91173c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e95e1291-c34c-4df6-9213-dbeeadce7235",
"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-10-20T00:34:00.736226+00:00",
"date_create": "2025-10-20T00:34:00.736226+00:00",
"date_update": "2025-10-20T00:34:00.736226+00:00",
"updated_by_user_id": "5ed0ca6c-112d-45d3-93f3-d6e18f4dd7db",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-20T00:34:00.736226+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-10-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-20T00:34:00.736226+00:00",
"date_last_job": "2025-10-20T00:34:00.736226+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-20T00:34:00.736226+00:00",
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00",
"is_mobile_installation": true
},
"job_type_id": "ca50af28-486a-4f3a-a0e9-c60d989f247e",
"job_type_code": "sample string 7",
"job_type": {
"id": "411fd061-eabb-43bc-8cdf-405c0bc4e296",
"name": "sample string 2",
"sales_organization_id": "c61c4052-ab96-4367-bc8b-80e5bb0f1195",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00",
"code": "sample string 7"
},
"job_priority_id": "1dc3ec83-7146-4801-9799-33b5435eaed4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a2de8cd4-c2a8-4e51-9528-abbd8778d6fd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "73aa44db-68e1-42ef-959d-c1cbb9ce1363",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
},
"job_status_id": "2fad6a80-d14b-4683-8dbb-8897073ac64a",
"job_status_code": "sample string 11",
"db_address_id": "d33ea06f-d357-40a2-be4a-97513534eacc",
"contact_id": "96d52ff5-de2d-4dc1-a7e8-ef326f777c13",
"requested_by_company_id": "1666e99c-3173-422b-b297-0af4997dc104",
"requested_by_contact_id": "e3284598-100d-4451-b7ac-bd414f0db42a",
"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-10-20T00:34:00.736226+00:00",
"due_date": "2025-10-20T00:34:00.736226+00:00",
"date_create": "2025-10-20T00:34:00.736226+00:00",
"date_update": "2025-10-20T00:34:00.736226+00:00",
"date_closed": "2025-10-20T00:34:00.736226+00:00",
"suggested_user_id": "f4235122-e1ca-4ede-8459-e9a11fc4cea3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "85d10e13-aecd-40ad-bb82-975eff1af086",
"db_language_id": "dd8aa3d9-b0b7-4469-82cd-5e0c05bf2765",
"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-10-20T00:34:00.736226+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f1fdf52e-2e8e-43dd-b09c-77f48f5bc283",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "54944669-f66f-4883-bd86-1c7493aecf93",
"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": "11258f5f-f681-4756-a70d-7e9403f0d5e3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d859ea5a-2494-4200-9e4f-9ce5580e8e2e"
},
"suggested_date_start": "2025-10-20T00:34:00.736226+00:00",
"skill_id": "ced819e5-bb79-46fe-97a7-296e1fb996ef",
"skill_code": "sample string 32",
"skill": {
"id": "869da84e-edf0-4df2-8096-9a430349d800",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "53c2ed4e-255c-4b29-a1a2-d78241fa9706",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae548b48-9a96-4457-adc0-e533f2ab11d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "15de249b-14e2-43d7-89a1-d0c71c4092d4",
"db_currency_id": "9064e668-eb28-46bf-b2fe-1c292aa6a203",
"db_language_id": "40008c77-68d2-46b0-8ce5-0c19a44c8ccd",
"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-10-20T00:34:00.736226+00:00"
},
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7aa08dbc-b3ef-4897-ae3e-d0bf2de9291a",
"date_reported_by_company": "2025-10-20T00:34:00.736226+00:00",
"id2": 36,
"company_id": "850cb990-d345-4e3b-a239-d79d106e6360",
"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": "8fcc2d83-5796-4341-a72a-5f5fcf9cc103",
"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-10-20T00:34:00.736226+00:00"
},
"work_instruction_details_id": "bf21aa5c-af39-4020-88a7-a3d976d158b8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "27541bdb-f680-4fd0-a0f8-a04084e832fd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0bc1ab25-cfa2-4695-8a57-e6e942be555c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-20T00:34:00.736226+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": "5bac3ba0-13b4-4301-8ed4-716f0dbd6f38",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-20T00:34:00.736226+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.