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": "8378c603-0c34-417d-9a1f-f21ffda21093",
"jobs_id": "5482ddde-c564-4fef-831c-bb0875f7220a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "acc1b275-4d46-44d3-b204-3f3b2fd086fe",
"_parent_id": "87915d5e-058e-4fe1-9706-6cb366139666",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d610df08-6288-46dc-b34e-c55f1a7212f2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "02ae9468-cd3a-490c-ae08-33ad074f7b38",
"_parent_id": "d325b048-0e11-44c2-8109-7015d30ad88f",
"root_parent_id": "45498779-5962-4791-bdb6-3cb561abbab1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8c8987a-be9d-4f29-b50b-f6697bb2899f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ebb9ce80-4e7a-4cbd-9f51-694ac4ab4062",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12c9d7f0-494b-4103-a0a8-d570866a3e30",
"_parent_code": "sample string 6",
"sales_organization_id": "e613d5cd-63cd-423c-aed2-9c5ac84f9992",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
},
"equipment_model_id": "e2813177-22f3-437d-9d76-1561dabcbb8b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fad81b3f-1340-4eba-a345-ee8646372237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f756d0fa-1b3f-4934-934e-b092b3bb4126",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6dd9da39-32dd-4817-9854-7fda820f4844",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9e3de2c8-c4dd-44d8-bfcb-c9d019f4011b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
},
"equipment_family_id": "44ef78c9-faba-4023-be49-c22be0814756",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ebb9ce80-4e7a-4cbd-9f51-694ac4ab4062",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "12c9d7f0-494b-4103-a0a8-d570866a3e30",
"_parent_code": "sample string 6",
"sales_organization_id": "e613d5cd-63cd-423c-aed2-9c5ac84f9992",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
},
"date_in_production_since": "2026-07-26T01:33:26.6307768+00:00",
"date_out_of_production_since": "2026-07-26T01:33:26.6307768+00:00",
"date_end_support": "2026-07-26T01:33:26.6307768+00:00",
"sales_organization_id": "95cc7039-2f02-466c-b747-76050d84aa9b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+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-07-26T01:33:26.6307768+00:00"
},
"project_status_id": "13f1eb8c-7670-4c56-b177-194c23ee7e73",
"project_status_code": "sample string 10",
"project_status": {
"id": "0efe89b9-078f-44c7-9935-c2ab58b044e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "27be091b-cbfe-4755-b058-26e145f4d09e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
},
"company_id": "00e46292-03ea-4719-9a98-e759f609d00a",
"company_code": "sample string 12",
"db_address_id": "c318ecf4-5f0f-42ff-8634-119849095d92",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "afb94fdf-97c3-4302-bc2f-46f207a2f056",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2437d552-562b-4d98-8399-093f054e2e55",
"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-07-26T01:33:26.6307768+00:00",
"date_create": "2026-07-26T01:33:26.6307768+00:00",
"date_update": "2026-07-26T01:33:26.6307768+00:00",
"updated_by_user_id": "599cc0ac-f7a7-445d-8213-56a3e08338ed",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-26T01:33:26.6307768+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-07-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-26T01:33:26.6307768+00:00",
"date_last_job": "2026-07-26T01:33:26.6307768+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-26T01:33:26.6307768+00:00",
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00",
"is_mobile_installation": true
},
"job_type_id": "7d746e30-7dc1-4224-9d0a-609bde4517f3",
"job_type_code": "sample string 7",
"job_type": {
"id": "4de0c75d-2cb7-4b0b-baf5-dcd46c8468ad",
"name": "sample string 2",
"sales_organization_id": "f5c1ef14-4a99-4370-a48b-c6797f34ddc7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00",
"code": "sample string 7"
},
"job_priority_id": "3772a1d1-42b5-43c6-99b1-3007ad2a7843",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0341c5b3-5eea-4b26-a370-300ffb853d24",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "67473891-5a6f-4f18-aff1-54f6e19d212b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
},
"job_status_id": "0e86b0e9-8346-441c-b1c5-43b689879aab",
"job_status_code": "sample string 11",
"db_address_id": "8e2e22bf-0f16-48ad-a6a1-38a259f13747",
"contact_id": "3317f7df-c2ec-4e55-bff2-e98887fb469c",
"requested_by_company_id": "514bb2f9-a8aa-4b0e-8938-43f6bd7a34bb",
"requested_by_contact_id": "b7c06cdc-4368-4284-8fa2-b8e7f0399752",
"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-07-26T01:33:26.6307768+00:00",
"due_date": "2026-07-26T01:33:26.6307768+00:00",
"date_create": "2026-07-26T01:33:26.6307768+00:00",
"date_update": "2026-07-26T01:33:26.6307768+00:00",
"date_closed": "2026-07-26T01:33:26.6307768+00:00",
"suggested_user_id": "de3adab8-1d35-4cea-9284-90c782ee71e7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "76eed480-e7e1-4828-a087-77d80681310b",
"db_language_id": "191440fe-d3dd-47f0-b88e-b2c9f2cdf177",
"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-07-26T01:33:26.6307768+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ce75cb09-a10a-4a2e-b661-46b5a0c3c88b",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7abc6484-8b93-41a0-9353-adc10a69792a",
"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": "7083c18c-62d8-46db-b122-699f36c743e4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4d43004a-e8f0-4439-bad2-e94d39ae8e6e"
},
"suggested_date_start": "2026-07-26T01:33:26.6307768+00:00",
"skill_id": "f3d921ad-efec-42f2-af78-a1cb1c1b565e",
"skill_code": "sample string 32",
"skill": {
"id": "9258a530-433e-4abb-9bae-f003a9e70911",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c9162fd9-bb3e-4517-beb4-d725743aac44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cc79255e-fd2f-4458-9816-b78fbe668c3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d2bc981-a18c-486a-b27c-e62f77918339",
"db_currency_id": "c16168ae-cc25-4af3-bae6-a2ae521157db",
"db_language_id": "f3b6ee41-f69e-482d-aafc-3a8f27b641bb",
"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-07-26T01:33:26.6307768+00:00"
},
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d5971e54-9875-4f18-9ec1-64ba4bf6d8c6",
"date_reported_by_company": "2026-07-26T01:33:26.6307768+00:00",
"id2": 36,
"company_id": "7979358c-3759-441f-a33f-24f07475856d",
"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": "e4f18a5d-a2be-4289-8956-49e4105c586e",
"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-07-26T01:33:26.6307768+00:00"
},
"work_instruction_details_id": "2314c07e-a605-4e1f-aaf3-65757d9487a2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "929c7ff2-0974-4b77-8eae-77137c029381",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f68c3090-d22a-4e7a-8556-74c46a32251a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-26T01:33:26.6307768+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": "845f433a-bd8f-4bec-8b6b-fea126f5efdf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-26T01:33:26.6307768+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.