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": "3efa5737-de16-4cf4-9e9b-bd68b5b83dac",
"jobs_id": "9f33e63f-54fa-4a06-94da-d6998ba885a3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ac177dd6-de19-4c08-be90-5cc71ec8cd09",
"_parent_id": "87366f70-c2d1-4121-a3fd-6d4dc9233115",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8a78fb46-615c-4c2a-b58b-33cb2193fb82",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e2675318-ec2c-41e9-98fb-c834d5ea478e",
"_parent_id": "4c5d7074-3d29-4ddd-9324-2ec8c483d7ca",
"root_parent_id": "45bda900-320b-4052-8c7c-c784b23ffd42",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b94f79d-c5ba-43e5-b093-9a690e43af9c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d39d1f88-33f8-4a2a-beb1-b983d361302a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e2c3f425-b18a-4337-9ae7-21c9d043e7a1",
"_parent_code": "sample string 6",
"sales_organization_id": "6294e8c9-4b87-4b82-8e53-bd463aea837c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
},
"equipment_model_id": "204f6999-2cd6-4916-9a04-ec1699df13c3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2820657f-03ec-4e41-92cc-d240490199d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "403c063c-4475-4131-bfac-f9b50dc99d52",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a9da8f95-ea93-442f-b533-886226f65164",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9f72abf0-1090-4254-8fbc-b55d3ee255de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
},
"equipment_family_id": "f0347fb9-ac8c-407b-8762-8419cc9959aa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d39d1f88-33f8-4a2a-beb1-b983d361302a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e2c3f425-b18a-4337-9ae7-21c9d043e7a1",
"_parent_code": "sample string 6",
"sales_organization_id": "6294e8c9-4b87-4b82-8e53-bd463aea837c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
},
"date_in_production_since": "2026-08-11T21:09:29.5864166+00:00",
"date_out_of_production_since": "2026-08-11T21:09:29.5864166+00:00",
"date_end_support": "2026-08-11T21:09:29.5864166+00:00",
"sales_organization_id": "5f7e8a7a-8857-468b-b76c-82630a397039",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+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-08-11T21:09:29.5864166+00:00"
},
"project_status_id": "2acb0bba-01fc-4aa8-962a-07e2d3593ec6",
"project_status_code": "sample string 10",
"project_status": {
"id": "1c51d7de-4d5c-44c1-bed1-6aa231ee24c6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "25645504-7d7f-47de-b4da-c1dcb0500940",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
},
"company_id": "18d3223a-2158-4dfa-b59f-ef34c7882d91",
"company_code": "sample string 12",
"db_address_id": "c3f44209-3c13-45a3-9da4-9dc613c5460b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "da7fad0b-bd92-4b30-ac3a-fe9d77d176bf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8bb4c5a6-774d-4f7c-8617-8de8df195142",
"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-08-11T21:09:29.5864166+00:00",
"date_create": "2026-08-11T21:09:29.5864166+00:00",
"date_update": "2026-08-11T21:09:29.5864166+00:00",
"updated_by_user_id": "2d08b145-e06b-477a-b3e8-794e00b0a115",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-11T21:09:29.5864166+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-08-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-11T21:09:29.5864166+00:00",
"date_last_job": "2026-08-11T21:09:29.5864166+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-11T21:09:29.5864166+00:00",
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00",
"is_mobile_installation": true
},
"job_type_id": "f11f190a-a1eb-446b-a67b-7276edee323f",
"job_type_code": "sample string 7",
"job_type": {
"id": "107fa6f4-4825-4a18-ae24-849ae39d1deb",
"name": "sample string 2",
"sales_organization_id": "1efc384e-3b86-43e6-b06a-cfae39788c3d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00",
"code": "sample string 7"
},
"job_priority_id": "40be4060-dd41-446e-bf19-23702276e883",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5b8cf633-f0f2-48ef-b539-d0717cb4048d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cac647ed-4e68-457c-8de0-c85071bc83c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
},
"job_status_id": "7ac5442d-ed25-4c28-af8d-4fc5a4e2bbec",
"job_status_code": "sample string 11",
"db_address_id": "53199de1-9cae-484a-9869-15f983ce9015",
"contact_id": "2cb37f18-dd77-45ed-80f8-72770f04145c",
"requested_by_company_id": "75c893af-51cf-4656-b03d-6dd534441350",
"requested_by_contact_id": "b5edbf1d-bcc7-423e-8d43-718331f522e5",
"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-08-11T21:09:29.5864166+00:00",
"due_date": "2026-08-11T21:09:29.5864166+00:00",
"date_create": "2026-08-11T21:09:29.5864166+00:00",
"date_update": "2026-08-11T21:09:29.5864166+00:00",
"date_closed": "2026-08-11T21:09:29.5864166+00:00",
"suggested_user_id": "99588ae4-224d-42a5-b74a-532eab59bb4b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "31abc795-244b-4266-81b3-2d747afc1b04",
"db_language_id": "b7e7144b-991e-4f94-9d26-1464a5547952",
"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-08-11T21:09:29.5864166+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d9b98981-4e63-40ac-889b-413a4b99f5c7",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "63014c8d-c755-4a01-85ec-feab75fdd196",
"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": "fc509e7f-eae6-4ae3-80a4-de199b6f1820",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e23421e1-bc19-4496-9d0f-6d4ff79f9a3a"
},
"suggested_date_start": "2026-08-11T21:09:29.5864166+00:00",
"skill_id": "ac8e7ca8-441a-4601-a84a-cc2fa8fb453b",
"skill_code": "sample string 32",
"skill": {
"id": "072aad1c-4ca5-4f2c-b9e6-bbd7898acdcd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "76dbc44d-08a3-451c-bc40-a5c0d69a5b9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "407d46bf-6310-4065-a197-1ace45dd7a48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30f07b15-4480-4603-a24c-9b19865677cc",
"db_currency_id": "4e8c4c7b-b805-4885-9c16-f70a5a2272c5",
"db_language_id": "d6a3a20f-12c1-4e09-96cc-b4f31feeca3d",
"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-08-11T21:09:29.5864166+00:00"
},
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "90d4ac96-8eb0-429c-8ac4-d6b2809b536c",
"date_reported_by_company": "2026-08-11T21:09:29.5864166+00:00",
"id2": 36,
"company_id": "715f75da-cfd6-4a00-965f-7ec4fcec1fed",
"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": "6336d19f-25a8-4406-9675-fd73688be9e0",
"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-08-11T21:09:29.5864166+00:00"
},
"work_instruction_details_id": "4ec27cd6-e172-4753-821f-d341b9fca294",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b0c7909b-abd2-49d4-a1ae-6b07937cc296",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "826134f4-8147-4dee-b31f-d41242a630e3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-11T21:09:29.5864166+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": "d9907a98-6e9f-4ba2-a640-163ddccd19dd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-11T21:09:29.5864166+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.