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": "1aef6426-4edc-4f2d-b86a-1c7b18ab4c6c",
"jobs_id": "519477fb-d572-46ac-8d0c-11433bd9d73c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bb079c30-c9f2-4b56-bb4b-3feda7ecc269",
"_parent_id": "14fb6928-a11a-4454-82aa-a28945c8d6b9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "25ee62fa-e552-4e83-a192-763086e8709c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1e688e05-5fa1-4952-ac4f-77b382a7ce32",
"_parent_id": "c8ecaaa8-2643-4d67-8473-73b2f3d295c3",
"root_parent_id": "d70dbf74-44e6-481f-a3ca-8c619d350b06",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b654b1a3-fe53-4b3d-9f4d-bf48041a3b1b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d98bd77c-4490-445b-9492-b0b8d9911cfb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a732b098-653f-4c07-8622-0cc18dfecd4a",
"_parent_code": "sample string 6",
"sales_organization_id": "dd5c5b03-dabd-4592-8355-503d8e9f6b79",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.8701634+00:00"
},
"equipment_model_id": "7b20db28-0b8a-42d6-843f-12f2fbea9050",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "56f735ec-47cb-4a0f-b336-3b39707a7e0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9d2d8c26-5ab5-48da-89d2-ab9e5d1802fd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1da3b002-a694-42e0-bee6-c0cf855147f0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "44c1d61c-709f-4621-bb8d-5f539c34ab26",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.8701634+00:00"
},
"equipment_family_id": "2d88faca-cd62-4f0c-8602-b8263fb34570",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d98bd77c-4490-445b-9492-b0b8d9911cfb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a732b098-653f-4c07-8622-0cc18dfecd4a",
"_parent_code": "sample string 6",
"sales_organization_id": "dd5c5b03-dabd-4592-8355-503d8e9f6b79",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.8701634+00:00"
},
"date_in_production_since": "2026-09-21T20:11:40.8701634+00:00",
"date_out_of_production_since": "2026-09-21T20:11:40.8701634+00:00",
"date_end_support": "2026-09-21T20:11:40.8701634+00:00",
"sales_organization_id": "521ca16e-286b-4440-87fb-b8530f9d79bc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+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-21T20:11:40.8857818+00:00"
},
"project_status_id": "32240f8a-6be1-41eb-bac2-30857cf7456c",
"project_status_code": "sample string 10",
"project_status": {
"id": "8a71e27d-61da-4f3c-863d-557462281acf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "78f47cda-f288-48e9-a882-92f961767cb4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00"
},
"company_id": "85f884ec-55d5-4ba3-b08a-fb97c1a85e9b",
"company_code": "sample string 12",
"db_address_id": "8d3ac6b6-104f-42a2-871f-9e7ae5d4881b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a6141e10-d69d-41e6-a441-09a8524998f2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8d116f92-11ff-476d-9a7f-b1a78e35f13d",
"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-21T20:11:40.8857818+00:00",
"date_create": "2026-09-21T20:11:40.8857818+00:00",
"date_update": "2026-09-21T20:11:40.8857818+00:00",
"updated_by_user_id": "ee3aaa23-1e86-4533-9ac0-5c00cdb7bcf1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-21T20:11:40.8857818+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-21T20:11:40.8857818+00:00",
"date_last_job": "2026-09-21T20:11:40.8857818+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-21T20:11:40.8857818+00:00",
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00",
"is_mobile_installation": true
},
"job_type_id": "963de2f3-49db-4d3b-b496-bcbe83c12ee7",
"job_type_code": "sample string 7",
"job_type": {
"id": "5ec77112-1283-4f1e-85cb-2d763d2dd864",
"name": "sample string 2",
"sales_organization_id": "18eb2829-9cef-485b-8225-b4c42fcd1eb3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00",
"code": "sample string 7"
},
"job_priority_id": "a421c3d4-62db-4d4f-81ca-9d6a34fe6279",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1608eebe-8172-488a-ad10-78d915fed178",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7e122c43-32b5-4d07-b3a5-f34d156711fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00"
},
"job_status_id": "c9449ef3-31cb-4b8c-8f89-bb6f3b70bb9a",
"job_status_code": "sample string 11",
"db_address_id": "cf3093cc-6a13-4cb6-9f86-69b524a7a56e",
"contact_id": "4ffdf893-525b-414c-bbfb-53201144b029",
"requested_by_company_id": "41f8a774-7095-48fb-8c4b-e1d26ff00ec1",
"requested_by_contact_id": "667ba65b-48bf-4dee-a105-b30e4a2ac84a",
"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-21T20:11:40.8857818+00:00",
"due_date": "2026-09-21T20:11:40.8857818+00:00",
"date_create": "2026-09-21T20:11:40.8857818+00:00",
"date_update": "2026-09-21T20:11:40.8857818+00:00",
"date_closed": "2026-09-21T20:11:40.8857818+00:00",
"suggested_user_id": "a90da640-514b-47ee-8f7b-e237913b8736",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f1273c60-30a3-4921-b8eb-4fe4c1fe10a5",
"db_language_id": "e0cdeca0-6deb-429f-b9e8-72fde48ebfd3",
"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-21T20:11:40.8857818+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2fa16a72-a38d-4169-b873-66c299c80615",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6357ca99-f86b-401f-8307-df899ecf19f0",
"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": "d546fef3-8a6e-4f13-a18c-076f02b9bfa8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ad030132-41c7-4fad-97c1-71cfc8165be7"
},
"suggested_date_start": "2026-09-21T20:11:40.8857818+00:00",
"skill_id": "4f490035-e8a4-44f4-849c-72d5ec0253d6",
"skill_code": "sample string 32",
"skill": {
"id": "b76c7fb1-3f14-4435-98c4-ed76d5655c99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "945935e8-a254-4534-8fee-b33250acc895",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "faa4e783-c385-4c5c-aa20-b05347bf0e5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76262b43-4c20-4b7a-a8d5-89dc59c30b53",
"db_currency_id": "f791a7e3-34f7-45e1-8b2f-f1eaa58acd67",
"db_language_id": "bc618683-0cac-42c6-805b-7105850e2c8e",
"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-21T20:11:40.8701634+00:00"
},
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6dc7f5b8-7c94-4264-a716-5b7074e3f538",
"date_reported_by_company": "2026-09-21T20:11:40.8857818+00:00",
"id2": 36,
"company_id": "4107d702-d875-4af9-b66a-04d0433c3e6a",
"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": "959fb164-81a3-45c1-af01-6997c583c724",
"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-21T20:11:40.8857818+00:00"
},
"work_instruction_details_id": "7fb09250-9b26-4444-938e-8cb5a12a1a3e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bf1ac633-98af-4caf-9d30-d72924cf5739",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5df712e0-681c-4e66-86ea-b24bb4367f68",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-21T20:11:40.8857818+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": "04c873c3-bebd-45e9-a0c5-7c859ebee563",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-21T20:11:40.8857818+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.