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": "ea4798c3-cfb1-46a1-a341-7c75f4e6ff80",
"jobs_id": "84ea98d3-b4f7-40fd-b1c2-9181ad2e9174",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "74229c74-5cee-499c-b8dc-95252b62fe43",
"_parent_id": "765b2f3f-0c23-4ad4-be9c-9f691f99535d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c703b3bd-5aee-41e7-ad60-653fd2ff49c1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e7065a6d-da71-44a6-bb51-dc192d41ff36",
"_parent_id": "17267715-3397-4201-8716-6003317163c1",
"root_parent_id": "ab55fec7-d0dc-46ec-afb1-0d1ca2485610",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e2fe8bcd-2b9d-4a74-ad8b-2b7e3be67ce9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "27c5fd92-d063-4fce-9fab-af9641cd4a0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8fd5eac-9f26-4092-b867-4352facbe676",
"_parent_code": "sample string 6",
"sales_organization_id": "a4d19934-9b0b-4f22-8c39-3370508dceee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
},
"equipment_model_id": "1aeab642-451d-4c79-b930-d72734d1c95f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6cf50c2f-3dfc-4559-b0af-d955af359e7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0d8a2833-46d0-4e99-b9a8-7096f5261bbe",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "aaced690-5ddf-49fb-8a8a-5452b1c5684f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "89ffd89d-d026-439b-93a2-7555aa148659",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
},
"equipment_family_id": "6618df62-0a58-482a-be44-6390996da272",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "27c5fd92-d063-4fce-9fab-af9641cd4a0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8fd5eac-9f26-4092-b867-4352facbe676",
"_parent_code": "sample string 6",
"sales_organization_id": "a4d19934-9b0b-4f22-8c39-3370508dceee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
},
"date_in_production_since": "2026-05-04T10:08:02.0655+00:00",
"date_out_of_production_since": "2026-05-04T10:08:02.0655+00:00",
"date_end_support": "2026-05-04T10:08:02.0655+00:00",
"sales_organization_id": "4a9a0ed1-bca6-450d-af83-43e70e6198d5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+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-05-04T10:08:02.0655+00:00"
},
"project_status_id": "34c06479-3a20-48a4-a5ef-263d85afaf33",
"project_status_code": "sample string 10",
"project_status": {
"id": "2af37983-da43-4c7c-ab6d-e891e56c3a62",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "10489d0f-9ef9-495e-88c0-6acd00e7139f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
},
"company_id": "123658ee-72e5-4e33-a8ba-6389272068d9",
"company_code": "sample string 12",
"db_address_id": "639ddb2e-ac53-4a0c-8c7b-9423f106aa89",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "31682781-04cb-4adc-8617-3443ea8b1e2c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "91df9696-cbec-4ab8-a438-2dc0b7f0dd13",
"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-05-04T10:08:02.0655+00:00",
"date_create": "2026-05-04T10:08:02.0655+00:00",
"date_update": "2026-05-04T10:08:02.0655+00:00",
"updated_by_user_id": "029b4cff-943e-4f1f-b424-6ebb5aa5cb90",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-04T10:08:02.0655+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-05-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-04T10:08:02.0655+00:00",
"date_last_job": "2026-05-04T10:08:02.0655+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-04T10:08:02.0655+00:00",
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00",
"is_mobile_installation": true
},
"job_type_id": "dec02f46-70c4-4306-b0b4-4428c0e4cc43",
"job_type_code": "sample string 7",
"job_type": {
"id": "b9d47c58-75a0-404b-9368-78bea916be0e",
"name": "sample string 2",
"sales_organization_id": "33b41647-c7eb-444c-85a7-a241c7b97a81",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00",
"code": "sample string 7"
},
"job_priority_id": "f2a136fc-b1ac-4bf6-b5d1-425d1d37997e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6750c784-5315-4e6a-801c-b09f0810803c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a55c0c0c-35cc-4af8-821f-910e7e01eeec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
},
"job_status_id": "be62c214-3c4c-4caf-be1a-67041e35ad28",
"job_status_code": "sample string 11",
"db_address_id": "80efc4f6-cb5f-4e2c-9ada-ddf92902d5df",
"contact_id": "3b7dc0ac-d87c-4933-aaf7-c20a2496ab75",
"requested_by_company_id": "7d0e43b3-8961-46c8-9918-fc5c41785048",
"requested_by_contact_id": "04a6d279-f89a-45d2-8664-51e22879eacc",
"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-05-04T10:08:02.0655+00:00",
"due_date": "2026-05-04T10:08:02.0655+00:00",
"date_create": "2026-05-04T10:08:02.0655+00:00",
"date_update": "2026-05-04T10:08:02.0655+00:00",
"date_closed": "2026-05-04T10:08:02.0655+00:00",
"suggested_user_id": "02c99792-6a2e-4950-a8dd-76183c0c108c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1f76766f-03ba-49f5-8475-9266bdefaae1",
"db_language_id": "7c671025-b949-43e0-a368-76c4a09425da",
"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-05-04T10:08:02.0655+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2732abe6-e77f-4e58-95c9-6885277805cf",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "43c3dc79-003c-4410-8966-c3f93976422d",
"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": "bdd7d02e-5551-4cd4-8f23-182af8930367",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0fab9452-cbe3-4bba-99f7-f2803ca5d74b"
},
"suggested_date_start": "2026-05-04T10:08:02.0655+00:00",
"skill_id": "c2831fbc-5044-4206-a276-2a68dfc1bf5e",
"skill_code": "sample string 32",
"skill": {
"id": "dfe8b35b-bd70-4026-bab9-b25bf924a173",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7cafdfd2-1b81-4002-ac58-3abac9d86a08",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "edeb28cc-a692-4ad0-9a05-9ce7ec78998c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "807d5a0f-d82d-4f9c-89cf-4c58ebb5d569",
"db_currency_id": "c31c45a4-f72d-4728-8a26-faee9c9856b2",
"db_language_id": "4204b585-b219-49f5-b8f9-4b95a78834ff",
"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-05-04T10:08:02.0655+00:00"
},
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "43711405-5bea-4547-a4f5-ce1921fcc406",
"date_reported_by_company": "2026-05-04T10:08:02.0655+00:00",
"id2": 36,
"company_id": "5f4740b4-bc59-4d07-8522-6db59c0ac1af",
"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": "ac87a1d2-8c22-4a9e-a2e7-3d83e7794911",
"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-05-04T10:08:02.0655+00:00"
},
"work_instruction_details_id": "246d23fc-40ee-4952-9924-d13524485647",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1b16befd-5472-47a8-aa8f-fe3e595e7813",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dd69efa7-63de-47ca-9517-8b3e171283d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-04T10:08:02.0655+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": "efc2365a-f2a7-44a4-beee-19e2bec0cf62",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-04T10:08:02.0655+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.