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
{
"id": "f435894c-acb2-497b-b733-eefeb10cb09a",
"jobs_id": "f85bc62a-e1d3-4bf1-9916-ae5befa16c0d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "daba7b94-369b-4da2-b613-16ff06f748bb",
"_parent_id": "f058c418-8fd0-40b7-bc98-eb81441f2b2f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db566ae1-5034-40a1-89e6-2d892db8c724",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6c88561c-1487-400d-820d-52eee4ea60e5",
"_parent_id": "43021ba9-9695-46a5-92a6-984fd2a53728",
"root_parent_id": "bdb6a433-ce8a-462a-a33c-fbd0491d110c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "55f4a7a2-7a67-457d-a216-771eb5ff03f8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f1220cf-4649-45eb-a45b-bea66b2dbe99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d4b76178-6b11-4e48-aa13-c5cd65d0b78b",
"_parent_code": "sample string 6",
"sales_organization_id": "0a93f096-5dcc-4dfe-aed0-098d1f59740e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"modified_dateutc": "2026-11-22T19:04:21.8994503+00:00"
},
"equipment_model_id": "704d50a8-a1db-43ed-b7f6-73a830f15f50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dbb04f9d-1d0d-4a9d-940a-75fff0a04a71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "deb21f87-b296-415e-beaf-9ff0ef867e7a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ff803e58-4769-4299-b788-0626d81da63e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ae8d92ad-77d7-47aa-9d6c-48db704a5a74",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"modified_dateutc": "2026-11-22T19:04:21.8994503+00:00"
},
"equipment_family_id": "64c7f470-70a0-4a26-a2d2-f76e1b61fe57",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f1220cf-4649-45eb-a45b-bea66b2dbe99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d4b76178-6b11-4e48-aa13-c5cd65d0b78b",
"_parent_code": "sample string 6",
"sales_organization_id": "0a93f096-5dcc-4dfe-aed0-098d1f59740e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"modified_dateutc": "2026-11-22T19:04:21.8994503+00:00"
},
"date_in_production_since": "2026-11-22T19:04:21.8994503+00:00",
"date_out_of_production_since": "2026-11-22T19:04:21.8994503+00:00",
"date_end_support": "2026-11-22T19:04:21.8994503+00:00",
"sales_organization_id": "d0075106-87af-4d12-b6f0-3ad0d3e9426d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+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-11-22T19:04:21.9170145+00:00"
},
"project_status_id": "984fec0a-495a-4f30-8bb2-c26e6fcb387c",
"project_status_code": "sample string 10",
"project_status": {
"id": "79691729-b4fe-4e8b-9f46-d78593677d77",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "32841855-5be3-4b2f-8055-c0f4e873c600",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00"
},
"company_id": "02239a24-d094-426b-9a13-d48e24a1928e",
"company_code": "sample string 12",
"db_address_id": "15410458-868a-4cfe-a6a2-cf27c98333c7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ad1d612a-e57a-4ba2-9db2-b622b7b5a704",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a194bec7-671b-4df9-986e-36a7130bbcd2",
"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-11-22T19:04:21.9170145+00:00",
"date_create": "2026-11-22T19:04:21.9170145+00:00",
"date_update": "2026-11-22T19:04:21.9170145+00:00",
"updated_by_user_id": "3fe71efb-572a-4ff4-a353-761e88953704",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-22T19:04:21.9170145+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-11-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-22T19:04:21.9170145+00:00",
"date_last_job": "2026-11-22T19:04:21.9170145+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-22T19:04:21.9170145+00:00",
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00",
"is_mobile_installation": true
},
"job_type_id": "21e15b1d-3dd4-4ac5-bc9e-936fd4e7cf71",
"job_type_code": "sample string 7",
"job_type": {
"id": "863b548a-011c-4c27-bcea-6d6582ac4336",
"name": "sample string 2",
"sales_organization_id": "56ccecaf-1dd5-4e0a-9c5b-338b931ad8a6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00",
"code": "sample string 7"
},
"job_priority_id": "b6b0d731-992e-475c-9065-5183731ca3f0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8c0e911a-5258-4ffd-9541-72ad49d838c9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "68d84fba-4736-4a00-a85f-142a2f628e53",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00"
},
"job_status_id": "7bf443be-f1ff-4d05-8e42-1f28e6d472c3",
"job_status_code": "sample string 11",
"db_address_id": "7297c420-78ad-4338-84b5-44536f47fd80",
"contact_id": "874a8203-ca6e-42f2-868f-747176a8a95e",
"requested_by_company_id": "c3d86e29-26cb-4e2e-8146-e930a4daa560",
"requested_by_contact_id": "40fa7bab-0a69-4d78-a52e-b5e753da5e39",
"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-11-22T19:04:21.9170145+00:00",
"due_date": "2026-11-22T19:04:21.9170145+00:00",
"date_create": "2026-11-22T19:04:21.9170145+00:00",
"date_update": "2026-11-22T19:04:21.9170145+00:00",
"date_closed": "2026-11-22T19:04:21.9170145+00:00",
"suggested_user_id": "0dcb9a54-c7e5-4383-b76b-7abd797c46d5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "24590986-d87b-4abf-ad9e-c381c332993d",
"db_language_id": "67aeb5ec-5c12-4071-827c-a77730cf1e33",
"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-11-22T19:04:21.9170145+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cd940248-68fe-4663-ba80-3ff3e0e39680",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9c586ccb-f6f3-4795-b563-19d71d8055b5",
"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": "2aa59fe1-6ab5-4cf3-aa74-1029dbbfe94e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c382487a-1199-4f1f-9048-4996beadc931"
},
"suggested_date_start": "2026-11-22T19:04:21.9170145+00:00",
"skill_id": "a29bff4b-81e6-4a6e-8ca4-45879189cae8",
"skill_code": "sample string 32",
"skill": {
"id": "fbdd6f79-4fda-466b-884e-e76301ea29c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "04c9b7c4-3ec6-43e5-8fac-3eaaee7e83d7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3956a0ad-8b15-4007-87ab-e3b833f091ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4c88f236-1240-444e-b983-cf249d47f4a6",
"db_currency_id": "05576dbb-8213-44a1-8af7-305556af117a",
"db_language_id": "5956af34-47b5-4262-9673-28a756c08d31",
"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-11-22T19:04:21.8994503+00:00"
},
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "94a0d315-19cd-4c44-afac-a7363ca6493e",
"date_reported_by_company": "2026-11-22T19:04:21.9170145+00:00",
"id2": 36,
"company_id": "d02ba802-b9e8-4d2d-94e6-dd2c4ed68041",
"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": "b4792501-f7eb-4ddf-9ae0-c5ab6a86098a",
"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-11-22T19:04:21.9170145+00:00"
},
"work_instruction_details_id": "047fa9e0-56d7-406d-814e-94877421a78c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b703eb32-3379-41a8-a91b-36e16f838816",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fb18d86a-99b7-485f-979a-a40aac79da7a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-22T19:04:21.9170145+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": "12ec1ed9-3a7f-4bc4-b2ea-600ef35321f4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-22T19:04:21.9170145+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.