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": "6134a570-aadb-4451-a9f4-82540c3bda58",
"jobs_id": "816635d2-e466-4079-afae-bba568b4d5ad",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b9aacb37-1428-46fe-9174-2b4ee49b05ce",
"_parent_id": "f0ab60fa-5cc6-4a16-9808-7dfdc12a989c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7a456b97-a639-482e-824a-330f45d82118",
"project_reference_back_office": "sample string 5",
"project": {
"id": "629f3031-7611-421d-85d7-448a8c65b8e9",
"_parent_id": "96c62997-bf72-47df-a043-a068482ab149",
"root_parent_id": "a74a923f-f841-44a7-bc42-00ec231b2e8a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "78f78541-01db-4a3c-8ee6-361001d8547c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f3f31c0d-28dd-4f05-b4f8-36c60c31d5c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cbc97f1c-9365-475f-b3ed-8e7289c4d526",
"_parent_code": "sample string 6",
"sales_organization_id": "6bc5c042-b9f3-4053-82ae-f6c621916eb2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00"
},
"equipment_model_id": "efb3e491-3bc9-4728-80b0-081519a14609",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2972422c-b14a-4e1a-86ff-e849ce231493",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "73662a90-8a9a-419a-a9fb-8564c752d2f8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e435e135-f74b-4f37-8ea8-9499f5df1ec9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "11dfa36c-7647-406e-8c0e-9ffdbf4b4e1d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00"
},
"equipment_family_id": "1d1f8bc8-ad1a-4318-9307-6cacf2bcc8bf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f3f31c0d-28dd-4f05-b4f8-36c60c31d5c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cbc97f1c-9365-475f-b3ed-8e7289c4d526",
"_parent_code": "sample string 6",
"sales_organization_id": "6bc5c042-b9f3-4053-82ae-f6c621916eb2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00"
},
"date_in_production_since": "2026-10-31T22:36:55.6401827+00:00",
"date_out_of_production_since": "2026-10-31T22:36:55.6401827+00:00",
"date_end_support": "2026-10-31T22:36:55.6401827+00:00",
"sales_organization_id": "312af53a-1e2b-4c0b-84a0-38e3bf0ba12d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+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-10-31T22:36:55.6401827+00:00"
},
"project_status_id": "aefca7d1-f99a-4c9f-8833-811e28bd4874",
"project_status_code": "sample string 10",
"project_status": {
"id": "fe6f686d-9106-4c93-89a2-705c8bcf3dc7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "626e29e3-e142-4d40-9a93-f6b450c6b7cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00"
},
"company_id": "80ee1f5c-0f42-403e-a3e3-9f19b51ec513",
"company_code": "sample string 12",
"db_address_id": "0d01ed03-3a06-4869-9d78-0138ff9dd7a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fdf0b21e-38ac-4275-858a-31e0909538aa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3a436a76-9955-4d4b-a759-9adc8d937daa",
"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-10-31T22:36:55.6401827+00:00",
"date_create": "2026-10-31T22:36:55.6401827+00:00",
"date_update": "2026-10-31T22:36:55.6401827+00:00",
"updated_by_user_id": "555983c1-a5b5-4f32-be03-5f4fcf039225",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-31T22:36:55.6401827+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-10-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-31T22:36:55.6401827+00:00",
"date_last_job": "2026-10-31T22:36:55.6401827+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-31T22:36:55.6401827+00:00",
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00",
"is_mobile_installation": true
},
"job_type_id": "fb08492c-9d7f-49f5-b7ef-d04bec0ee85d",
"job_type_code": "sample string 7",
"job_type": {
"id": "ee709ccb-e69d-4b4d-8dde-18498496ddd0",
"name": "sample string 2",
"sales_organization_id": "da8a6acd-6bf6-4a20-8ac1-7cc1a0252194",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00",
"code": "sample string 7"
},
"job_priority_id": "f0fab4fd-923f-4846-9a49-ae3bb0283f28",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6fc2406f-d36d-4546-8cc0-0f579a5a3569",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "60669475-c155-40fe-af34-cf99d41ab266",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00"
},
"job_status_id": "f0e92feb-2599-4558-851b-c9bbdf65f747",
"job_status_code": "sample string 11",
"db_address_id": "b841b036-5a96-4891-a699-61e660dd6e5d",
"contact_id": "18f3a6e3-c325-4f53-8004-b1bd2609b468",
"requested_by_company_id": "b64a661b-3339-4a07-9f35-2ae99f2ead8d",
"requested_by_contact_id": "cfa40206-bf2b-47b5-90b7-c71f3189f062",
"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-10-31T22:36:55.6401827+00:00",
"due_date": "2026-10-31T22:36:55.6401827+00:00",
"date_create": "2026-10-31T22:36:55.6401827+00:00",
"date_update": "2026-10-31T22:36:55.6401827+00:00",
"date_closed": "2026-10-31T22:36:55.6401827+00:00",
"suggested_user_id": "90fed867-b6a0-4364-a3ba-6001471fa070",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "470e351e-270c-4446-a693-a63c6693a0ab",
"db_language_id": "2d014857-2109-4ef3-878c-0c628f8b8812",
"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-10-31T22:36:55.6401827+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2c90ff5d-fd38-4fb2-a8bc-e0c14ac8c389",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c366fe39-2cbf-4a1c-a59d-8af8926e015e",
"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": "82848b82-11c3-4529-8e3e-a2d013710cd6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "86fa2788-3650-40bf-9e85-c66a3f99fb60"
},
"suggested_date_start": "2026-10-31T22:36:55.6401827+00:00",
"skill_id": "18d2149d-7be3-4a81-9f07-e0e4b1f360af",
"skill_code": "sample string 32",
"skill": {
"id": "6ee63290-a8fd-4699-9f0c-1c69ab91f8a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9c2572ba-b94e-49be-bc85-b7800ed73117",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "58dd027d-4643-4127-a302-c89d551cfa63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9016d6df-dc28-463e-81aa-b75fe4f71827",
"db_currency_id": "7c8abbe0-3d02-4cae-a586-a92c422914f1",
"db_language_id": "b462c549-3f6b-4074-badf-b7739770cb88",
"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-10-31T22:36:55.6229478+00:00"
},
"modified_dateutc": "2026-10-31T22:36:55.6401827+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f930c09b-8837-4ad1-a21f-7298eaa5eb7d",
"date_reported_by_company": "2026-10-31T22:36:55.6401827+00:00",
"id2": 36,
"company_id": "49554adc-76cd-4fb2-8023-41e4d01cc2e3",
"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": "a3706dd1-cd34-4913-8e85-27184bf8aca2",
"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-10-31T22:36:55.6541968+00:00"
},
"work_instruction_details_id": "79180d15-ecaf-4e50-8d12-706206f147cc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0cf5f972-b64a-4c74-b4ac-31ef4f87db0d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4abc1ed6-a6a5-49dc-bdec-442d67d99a34",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-31T22:36:55.6541968+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": "8ae5fa6b-5f01-447b-9c36-6d3d344845b4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-31T22:36:55.6541968+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.