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": "82e07b33-8512-48d0-99fd-086818dbe0ed",
"jobs_id": "dd21eace-803b-4cbb-ad6b-b7e95a0c1a8b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "10bf8e8b-cb90-4a1f-b531-66e6711936ae",
"_parent_id": "a7441e3e-6508-4da1-9e6b-4e94392cd380",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f54fa822-ab5a-4d99-ab40-52dc5d39af27",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0ecf794b-9c58-4ffa-9216-ba390cb8d821",
"_parent_id": "8c96994c-0290-4b0e-b194-acbb79e3ac90",
"root_parent_id": "418191fe-6b3f-4cf8-86b6-dd3da4d9facf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e649454-e856-47e8-8117-45c7c6400a83",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eed224cb-b8dd-4da5-8049-006ae7888972",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5cc65a8c-092e-4945-90c6-7b54cefcd703",
"_parent_code": "sample string 6",
"sales_organization_id": "07315083-d25b-42f4-ba8d-eaabcc336761",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
},
"equipment_model_id": "7c9dde98-530d-48b1-8294-60104feda4ae",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea992994-5e35-4523-9f25-43b1858598f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6c2ede30-fe78-4071-b172-f6a1cbda1c5e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9900e6cb-6e28-4af2-a7b5-ed8532574713",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6063e965-d702-4b82-82f4-3f364c7e2aac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
},
"equipment_family_id": "7f5928e6-adaf-46c0-8ae5-27f9faf1b4c9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eed224cb-b8dd-4da5-8049-006ae7888972",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5cc65a8c-092e-4945-90c6-7b54cefcd703",
"_parent_code": "sample string 6",
"sales_organization_id": "07315083-d25b-42f4-ba8d-eaabcc336761",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
},
"date_in_production_since": "2026-03-10T07:41:07.5488586+00:00",
"date_out_of_production_since": "2026-03-10T07:41:07.5488586+00:00",
"date_end_support": "2026-03-10T07:41:07.5488586+00:00",
"sales_organization_id": "9f750ae1-be1b-40c2-9d6e-272968ae6818",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+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-03-10T07:41:07.5488586+00:00"
},
"project_status_id": "62bab64e-7a69-4b53-868d-40abddf1c87b",
"project_status_code": "sample string 10",
"project_status": {
"id": "9cfcff4c-0418-465a-a587-7cc37c43345c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e44fc273-1f8b-45d2-8076-00588d56832a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
},
"company_id": "0199ce7b-4710-470f-a298-1181ecbd805f",
"company_code": "sample string 12",
"db_address_id": "e5be9550-1fd8-4823-aeda-3bc2898b37f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "669737fc-df2d-4b8d-bc18-6fec9f08b693",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd57d4e0-03fd-4dbb-a834-6b567b47e0c1",
"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-03-10T07:41:07.5488586+00:00",
"date_create": "2026-03-10T07:41:07.5488586+00:00",
"date_update": "2026-03-10T07:41:07.5488586+00:00",
"updated_by_user_id": "46f2ff41-6648-4589-ad5c-831f9bc9a3f1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-10T07:41:07.5488586+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-03-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-10T07:41:07.5488586+00:00",
"date_last_job": "2026-03-10T07:41:07.5488586+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-10T07:41:07.5488586+00:00",
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00",
"is_mobile_installation": true
},
"job_type_id": "44747b45-a58d-4130-971d-eee8519ed06e",
"job_type_code": "sample string 7",
"job_type": {
"id": "0e3afcc7-54bd-4bd4-a41b-3b2a7f1ec55e",
"name": "sample string 2",
"sales_organization_id": "b4915bdb-fc7f-4e20-a10d-60c225877436",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00",
"code": "sample string 7"
},
"job_priority_id": "7c817f39-e047-45b0-95d3-11187bdf1062",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "97137ced-abe2-411c-a6ce-827399b3cb73",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "87d6a2ad-8104-4017-9ee7-4cdc880716b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
},
"job_status_id": "5bbbd530-9498-41eb-891e-ca82de5dac31",
"job_status_code": "sample string 11",
"db_address_id": "5c13f86a-6f1e-47dd-b848-ce700a60da37",
"contact_id": "88aa880f-8f1b-4a60-94c9-40ac793f189b",
"requested_by_company_id": "c8a54edc-b4a4-4438-ba57-249bfd648585",
"requested_by_contact_id": "7e110e77-6770-4492-87b6-dc20a8f84f40",
"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-03-10T07:41:07.5488586+00:00",
"due_date": "2026-03-10T07:41:07.5488586+00:00",
"date_create": "2026-03-10T07:41:07.5488586+00:00",
"date_update": "2026-03-10T07:41:07.5488586+00:00",
"date_closed": "2026-03-10T07:41:07.5488586+00:00",
"suggested_user_id": "f50a25af-0951-4baa-b48d-6d042c3abafc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f65c37f2-0b39-4ce8-b3d6-66f0f7fe5c92",
"db_language_id": "ce763bc0-3e37-42c4-9ff1-0406da68c2be",
"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-03-10T07:41:07.5488586+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5a19d312-19e7-42b9-a1e4-e4355c6b00a8",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c9fba353-4535-45a1-81aa-c1ef89143922",
"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": "868a3ffa-3afe-4974-b76a-064976d0ffa3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b1f923ac-f6bc-45d1-ab0f-7afeff6d4aa8"
},
"suggested_date_start": "2026-03-10T07:41:07.5488586+00:00",
"skill_id": "34d7bb08-0210-420f-beb9-73d164c7d5ec",
"skill_code": "sample string 32",
"skill": {
"id": "222d287d-24c8-4b12-a011-eda29c22857f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "540fb13c-8285-4fc5-9ac5-4b3b2c8d489f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bde6ae23-bf99-487c-a4b4-886a2773f6a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3330f666-6043-45b9-bb71-0c6e16a005d8",
"db_currency_id": "c032aa3c-a6ee-4abc-a80d-5df30d4e27f7",
"db_language_id": "2848ca44-ebfb-4370-9e4e-966dbe4699e8",
"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-03-10T07:41:07.5488586+00:00"
},
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d17d26bd-afdb-46fa-a763-6f56b0d709f3",
"date_reported_by_company": "2026-03-10T07:41:07.5488586+00:00",
"id2": 36,
"company_id": "81357962-2608-476c-a986-27f9231fe811",
"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": "a7974e83-732f-4c56-afd7-50252a8ef82d",
"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-03-10T07:41:07.5488586+00:00"
},
"work_instruction_details_id": "1f335ee7-37fc-4043-bd11-74a01cfe67a3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6bbcdd5a-6768-478d-9b02-fe5866ff4352",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6b8a47b6-5ca3-4f73-980b-bc7177a19633",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-10T07:41:07.5488586+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": "f612e311-e290-4e95-b42e-13b586a396c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-10T07:41:07.5488586+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.