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": "d885816f-d6de-4741-804a-ad036136897a",
"jobs_id": "7407b1c3-1889-4d01-8cca-b18c71bfe94b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f5ac09fc-d642-4dfa-919b-1bf88c9e7bc1",
"_parent_id": "5a54cd2d-d7a7-4b09-9170-c6150f6009ad",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2cf8f160-9ac8-461d-8f4f-629fa237bea4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "23d2f50b-0810-426a-b964-6daa696acaf7",
"_parent_id": "5af7a0af-00cc-44fc-89a1-2c939eb45c0d",
"root_parent_id": "68233d02-b744-4fa7-9673-cc4bdd072966",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8e0bd4a5-6582-49ce-8cc3-dd4a51d874a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "67664c83-0fd3-4dc7-a08d-a1b10edb5750",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe35052a-eefd-4afe-a1a3-9b2892bd582f",
"_parent_code": "sample string 6",
"sales_organization_id": "f91c5bd3-31ce-40de-a0d6-947436d4aa17",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"modified_dateutc": "2026-04-17T15:18:22.3792488+00:00"
},
"equipment_model_id": "cac90cb9-7bd4-48bf-92c8-6d9a14cdb7fc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6bb4339c-d90f-4024-9db3-26d4003dc900",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e57cc48e-8d25-4d33-af28-8f73c418818f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "add8daab-e165-42b4-a689-a0ba56427f2c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "df5e562c-5793-48fd-b565-6066149aa567",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"modified_dateutc": "2026-04-17T15:18:22.3792488+00:00"
},
"equipment_family_id": "d83ed177-a8e6-4d6f-8eab-e4276ee6d2e1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "67664c83-0fd3-4dc7-a08d-a1b10edb5750",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe35052a-eefd-4afe-a1a3-9b2892bd582f",
"_parent_code": "sample string 6",
"sales_organization_id": "f91c5bd3-31ce-40de-a0d6-947436d4aa17",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"modified_dateutc": "2026-04-17T15:18:22.3792488+00:00"
},
"date_in_production_since": "2026-04-17T15:18:22.3792488+00:00",
"date_out_of_production_since": "2026-04-17T15:18:22.3792488+00:00",
"date_end_support": "2026-04-17T15:18:22.3792488+00:00",
"sales_organization_id": "c54bfe15-490c-44b9-a182-15c13f2d6c0d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+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-17T15:18:22.3948666+00:00"
},
"project_status_id": "ad6ae3a7-de61-4b96-b0dd-d66722b419c6",
"project_status_code": "sample string 10",
"project_status": {
"id": "9c989b18-51e8-4a1f-a479-570431cd1d71",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1b86f9d5-3378-43e5-ba85-e1e60341fcc0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00"
},
"company_id": "f2cf88d5-c547-4613-8965-c212d2d99f8d",
"company_code": "sample string 12",
"db_address_id": "e6a051d7-ab1c-4363-a249-23e97e64cf9d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4b3966b6-f922-4060-83fa-2a2c9e612950",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bafa52d1-1273-4f78-a15f-16e3c546c77a",
"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-17T15:18:22.3948666+00:00",
"date_create": "2026-04-17T15:18:22.3948666+00:00",
"date_update": "2026-04-17T15:18:22.3948666+00:00",
"updated_by_user_id": "46bbc86e-c575-455e-9a96-5735448836e3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-17T15:18:22.3948666+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-17T15:18:22.3948666+00:00",
"date_last_job": "2026-04-17T15:18:22.3948666+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-17T15:18:22.3948666+00:00",
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00",
"is_mobile_installation": true
},
"job_type_id": "8aecbac1-3c02-4ad5-a909-19bd09d0c203",
"job_type_code": "sample string 7",
"job_type": {
"id": "dae0001b-b153-48e8-a91f-06dfa44db68e",
"name": "sample string 2",
"sales_organization_id": "9bab58f2-cd64-409b-90a4-388c2b3994f1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00",
"code": "sample string 7"
},
"job_priority_id": "220641fc-fa22-4052-a387-261a5ac5bbad",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5c28f6be-27af-4137-9ccd-d67c01f2cca0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ba684baa-6a52-47ea-9275-cc46cda1d3cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00"
},
"job_status_id": "40cdcad5-94d0-4b0d-8ba5-4de2b5cfdb41",
"job_status_code": "sample string 11",
"db_address_id": "b226c9fc-34b8-4f67-b845-0bf18f63b658",
"contact_id": "70856de3-49a5-4963-8d8f-07878a3c1800",
"requested_by_company_id": "e369adb4-0d6b-4472-87c3-09a7c1592600",
"requested_by_contact_id": "872cd564-8636-49a7-bb2e-3b2f1595349d",
"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-17T15:18:22.3948666+00:00",
"due_date": "2026-04-17T15:18:22.3948666+00:00",
"date_create": "2026-04-17T15:18:22.3948666+00:00",
"date_update": "2026-04-17T15:18:22.3948666+00:00",
"date_closed": "2026-04-17T15:18:22.3948666+00:00",
"suggested_user_id": "6b67940a-1e63-4832-8529-239eb8a5838b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "16aa0de7-5358-4585-b07e-ac86f361aa9c",
"db_language_id": "474e47c1-ac09-463c-9d37-1c806ef6ef7c",
"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-17T15:18:22.3948666+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "71719493-668f-40f3-99c8-f0fffe3fcfa1",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "30def015-0775-4d8a-bcf8-e24605163067",
"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": "e91747e9-1d0a-41fd-a194-0993fa0eb96b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "34f2baff-c9d6-470f-93dd-59f88f581daf"
},
"suggested_date_start": "2026-04-17T15:18:22.3948666+00:00",
"skill_id": "8180a897-6102-4751-b799-1003913eb0d7",
"skill_code": "sample string 32",
"skill": {
"id": "0d0d687b-f493-41ea-96f6-8bf7bf8ff366",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3dc79102-d4ec-4633-9328-d3f7b5b51f27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "373c7515-749d-4393-9ebe-40b58ecc8da2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4cb802fc-85ea-42a0-bf1f-f373aa734be6",
"db_currency_id": "35b335a2-8f5e-4d83-8495-847727d07a93",
"db_language_id": "6d057d89-bb18-42ef-9fe5-86c6b4968e32",
"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-17T15:18:22.3792488+00:00"
},
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "60966614-a3be-4b09-8a9b-eb2b8b8e2475",
"date_reported_by_company": "2026-04-17T15:18:22.3948666+00:00",
"id2": 36,
"company_id": "47c4e7f7-1962-4627-88f4-12fcaea35f5b",
"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": "37c7dc7d-96de-4c7c-b094-ad6ab2863f55",
"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-17T15:18:22.3948666+00:00"
},
"work_instruction_details_id": "17b09e06-2fae-45bd-b46b-c078ff937651",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9c54cf4e-3457-453e-8671-4f71a24120ec",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e840de50-4a51-49a7-bdfa-b6150f4ee07c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-17T15:18:22.3948666+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": "f6f6f6de-c802-4fed-96c0-b71c90f5a8ba",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-17T15:18:22.3948666+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.