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": "fd5d96c2-63ee-4909-bf1b-46cdb22a7246",
"jobs_id": "3b7875c4-2944-4b3a-939a-b7c767030330",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "52cf0bd1-d406-434e-bb8b-e64d6c0ae05d",
"_parent_id": "2a859c08-609f-47c2-a6de-07775dbed621",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "56034c4d-5a25-4764-bf05-9aa16852f1d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f8cb317b-63e1-42ed-9526-2192063ee06d",
"_parent_id": "aedcd973-8383-420b-94c9-717791a68d3a",
"root_parent_id": "8106e976-5d07-4591-a92a-0953ea93f399",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4965b1f0-4e42-459b-954a-446a392328d4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3c7a92c9-3af8-418a-9e62-d1298e3c1680",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b522d94d-8810-44b9-a1b1-34bd5b063148",
"_parent_code": "sample string 6",
"sales_organization_id": "48d37d02-a4ad-4298-ab3f-ab6b4bff77ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
},
"equipment_model_id": "5d2ef1d8-f68c-4618-bb7f-ea721fd74bd7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a266abf7-c52b-469d-98da-36c5dfec7637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c5644f16-d03d-4a32-a522-2ba039b9926c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6919029c-2a19-4060-86e2-51a535a3101f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "490eeeb2-dbae-4909-9ae2-8c7cbca43966",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
},
"equipment_family_id": "f9d5fc98-ac5b-4f7a-89d5-fa58ef7d32bf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3c7a92c9-3af8-418a-9e62-d1298e3c1680",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b522d94d-8810-44b9-a1b1-34bd5b063148",
"_parent_code": "sample string 6",
"sales_organization_id": "48d37d02-a4ad-4298-ab3f-ab6b4bff77ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
},
"date_in_production_since": "2026-04-09T15:46:56.4905604+00:00",
"date_out_of_production_since": "2026-04-09T15:46:56.4905604+00:00",
"date_end_support": "2026-04-09T15:46:56.4905604+00:00",
"sales_organization_id": "18e116a9-055d-436e-a162-101f3a93c0e8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+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-04-09T15:46:56.4905604+00:00"
},
"project_status_id": "773f949e-d00b-4706-929c-46d8f6834dae",
"project_status_code": "sample string 10",
"project_status": {
"id": "0527c3dc-0405-4711-99b2-5d37de7ff751",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8d89f0a8-19f6-4641-a966-9ebc8dad0bbc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
},
"company_id": "4b440ba6-9fb7-4684-a09f-bcedc6b23cca",
"company_code": "sample string 12",
"db_address_id": "832f0326-cf4d-4eef-991c-44123b676e8a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11927528-126a-410b-a2b9-3c7351d140ad",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "467cbb37-ba87-445a-b9fc-fd8dc8d18120",
"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-04-09T15:46:56.4905604+00:00",
"date_create": "2026-04-09T15:46:56.4905604+00:00",
"date_update": "2026-04-09T15:46:56.4905604+00:00",
"updated_by_user_id": "de4d5645-057c-4228-a892-04a32b2c5974",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-09T15:46:56.4905604+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-04-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-09T15:46:56.4905604+00:00",
"date_last_job": "2026-04-09T15:46:56.4905604+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-09T15:46:56.4905604+00:00",
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00",
"is_mobile_installation": true
},
"job_type_id": "64908ee9-d982-4297-b70b-09582285c0e9",
"job_type_code": "sample string 7",
"job_type": {
"id": "ba1aaf64-40cc-4f5b-b806-82a57a1222fa",
"name": "sample string 2",
"sales_organization_id": "e80edbe9-6d60-4825-b558-371de294c338",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00",
"code": "sample string 7"
},
"job_priority_id": "15c8fc35-0669-4a18-ba55-cb25aaefc949",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "91d35fb0-9a2f-4a60-881c-29731e28fca0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1f10248a-1740-4f80-a92f-98c913b0133a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
},
"job_status_id": "43bba2c6-c86e-4b09-b1c2-e7d236631b41",
"job_status_code": "sample string 11",
"db_address_id": "e26583fb-ecdf-4f24-a2c5-1a2bb428525d",
"contact_id": "9d19aa24-3403-43c1-a28f-67972f311dfd",
"requested_by_company_id": "2c9c4618-cb30-441d-b9c7-b393390a8c69",
"requested_by_contact_id": "2e53c7e1-9163-452a-a680-5d194385534c",
"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-04-09T15:46:56.4905604+00:00",
"due_date": "2026-04-09T15:46:56.4905604+00:00",
"date_create": "2026-04-09T15:46:56.4905604+00:00",
"date_update": "2026-04-09T15:46:56.4905604+00:00",
"date_closed": "2026-04-09T15:46:56.4905604+00:00",
"suggested_user_id": "e4893656-58c5-4078-aab1-964bf24d38fc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ef743c6c-0103-42ea-9208-329e30689a2b",
"db_language_id": "b918f883-8d29-4e51-a57b-c2e8bfdc2069",
"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-04-09T15:46:56.4905604+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6d158dcc-691c-4876-a6a0-04f711e1af87",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "95889ea7-6d3e-4505-8419-4ac315b519c2",
"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": "4fb96e0d-585a-4cb1-addf-ad6e97a45c6c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "360912ab-c090-4c94-b2a3-197b8c15d7fd"
},
"suggested_date_start": "2026-04-09T15:46:56.4905604+00:00",
"skill_id": "702e29b7-e50d-43f6-9532-fdaa19d964bd",
"skill_code": "sample string 32",
"skill": {
"id": "9e1314fa-ce1c-4c81-a48b-10ae8cda92f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8084602e-0cb2-46c9-a5e4-136157e9ab69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aaf7b522-0fb1-4445-96ad-ce901feb7c44",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93a48891-37d7-4dda-a3f3-46f42af97aef",
"db_currency_id": "f0e52879-636b-4fa1-b328-8533bb3590e2",
"db_language_id": "a9d12025-327a-49c4-836d-139561ced5dd",
"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-04-09T15:46:56.4905604+00:00"
},
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b9ae9f43-19fd-4a69-82a6-24c9058b12f1",
"date_reported_by_company": "2026-04-09T15:46:56.4905604+00:00",
"id2": 36,
"company_id": "72b29ba0-b10a-404e-b62a-c613ab06571a",
"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": "9a1cc7cf-1a75-48ad-be4b-d4d5f55a49e6",
"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-04-09T15:46:56.4905604+00:00"
},
"work_instruction_details_id": "c7c9f32f-b068-47c6-be92-0a93b37939c9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c013c864-c76e-4787-9dec-a2a7ad2484fb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "63962ce1-e1b9-4701-a790-095a0c0e0e23",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-09T15:46:56.4905604+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": "ac53c613-d255-4d90-b5c2-35b1979eb920",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-09T15:46:56.4905604+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.