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": "20ed884d-e478-4de9-acdf-aca9f6ec265f",
"jobs_id": "2fc97323-fbe6-4ba9-917d-d42a3d5daf0d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd12a36d-0e22-452b-86ac-58d41e8e58fa",
"_parent_id": "5c55a000-3fdd-4ba2-8fdb-f35ebf09facb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "31a3031e-45a0-4ef5-8d49-41f414040090",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4050efde-fd3f-4f69-9264-e03365ff2477",
"_parent_id": "5d753d4c-af00-404b-97c4-dc9eb4065c6a",
"root_parent_id": "2b8119d6-8780-4bfd-859f-f28a7ed7dfc3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2840ad62-18fc-47fe-86aa-4d39b1685afd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c3ba69cf-3f00-4ba8-bcf1-7cd70994d120",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7dc3350-c780-4623-b33b-5fea6c6123b9",
"_parent_code": "sample string 6",
"sales_organization_id": "b1220790-5109-4134-86b1-4a1caa8c9b57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
},
"equipment_model_id": "c98d75e8-8baa-460b-a74d-8d0331344af7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "452d043d-35aa-46ea-b6af-0994a3d61dd4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1f6c7110-32f1-4c1c-b99d-081797c15761",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fc3559b7-aae2-49a1-8216-dd5808386b85",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "86c99ff5-6c88-4a7c-807b-634266665d2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
},
"equipment_family_id": "16f63536-682b-4c6c-8f8c-c5104afec8fa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c3ba69cf-3f00-4ba8-bcf1-7cd70994d120",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d7dc3350-c780-4623-b33b-5fea6c6123b9",
"_parent_code": "sample string 6",
"sales_organization_id": "b1220790-5109-4134-86b1-4a1caa8c9b57",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
},
"date_in_production_since": "2026-09-20T11:35:16.5069564+00:00",
"date_out_of_production_since": "2026-09-20T11:35:16.5069564+00:00",
"date_end_support": "2026-09-20T11:35:16.5069564+00:00",
"sales_organization_id": "85dc5be1-134f-4580-a19d-a062044136fb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+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-09-20T11:35:16.5069564+00:00"
},
"project_status_id": "6122e87c-da8f-4b0b-8817-9d76d5325913",
"project_status_code": "sample string 10",
"project_status": {
"id": "92e02ad9-f307-4270-a442-2d7fa5a2f645",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "01fd4c73-ba9c-4a6f-8745-5fef2dcc2f8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
},
"company_id": "9f2d55cb-7c8d-4d0d-b3c6-b22319cad09a",
"company_code": "sample string 12",
"db_address_id": "807eaf83-7c9d-4944-81ac-8b2c2c458060",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1d65cb76-828f-4cb9-9aef-ec2ca58fe938",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c4f317f6-f9eb-468d-89f7-962e498f04fa",
"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-09-20T11:35:16.5069564+00:00",
"date_create": "2026-09-20T11:35:16.5069564+00:00",
"date_update": "2026-09-20T11:35:16.5069564+00:00",
"updated_by_user_id": "d8a5b335-4323-4c30-9e68-16a5f0f4b536",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-20T11:35:16.5069564+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-09-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-20T11:35:16.5069564+00:00",
"date_last_job": "2026-09-20T11:35:16.5069564+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-20T11:35:16.5069564+00:00",
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00",
"is_mobile_installation": true
},
"job_type_id": "0bf26a22-aa14-4c49-8199-7fdd92bedff7",
"job_type_code": "sample string 7",
"job_type": {
"id": "74d28d0e-2c10-487e-aa43-740645a7a1fa",
"name": "sample string 2",
"sales_organization_id": "93fe308b-b36a-43b7-932d-f97d0080650c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00",
"code": "sample string 7"
},
"job_priority_id": "f6219a15-2293-46e8-9846-29339c42e454",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0d0295b3-021a-4d11-9578-5096c0f01779",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b638a0ea-5c85-45c9-bb97-d40e6f91e50f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
},
"job_status_id": "82b82b8f-267c-4bcc-a584-04779237db70",
"job_status_code": "sample string 11",
"db_address_id": "8818955f-96f0-4c0b-b765-aff2a7d06028",
"contact_id": "86ceeced-ad14-45d1-8954-164c2e466690",
"requested_by_company_id": "ab250529-cbc3-4f10-ab1c-cbed1c2b8819",
"requested_by_contact_id": "93a0cf9e-94d0-4eed-bfc1-16efb93aad14",
"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-09-20T11:35:16.5069564+00:00",
"due_date": "2026-09-20T11:35:16.5069564+00:00",
"date_create": "2026-09-20T11:35:16.5069564+00:00",
"date_update": "2026-09-20T11:35:16.5069564+00:00",
"date_closed": "2026-09-20T11:35:16.5069564+00:00",
"suggested_user_id": "7263900f-91b3-4bb8-b02b-eb94b779f104",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2aec8025-6081-4fca-b3aa-0c6b3a0f07a8",
"db_language_id": "95b90134-9e8a-4ea0-a082-bcd519304335",
"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-09-20T11:35:16.5069564+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dabfd5a1-733c-405e-b57a-a26a8fa9be62",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "caa87021-d606-4fae-a487-e3b073c2c0d3",
"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": "31756807-1a59-4259-a08a-b5b8850ea619",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b9b7a09f-e48d-43e6-9adb-21f22ac5f60a"
},
"suggested_date_start": "2026-09-20T11:35:16.5069564+00:00",
"skill_id": "ea966490-3bf3-4c71-9c9f-038e4e2b85aa",
"skill_code": "sample string 32",
"skill": {
"id": "bc6580e2-0765-43d6-99a9-6531f94a455c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "24611666-5c0e-43d8-8177-eefa9bb20a94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec3fa6de-77fb-417c-96e9-fb50d13d773f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "64f8e81f-4da9-491f-8531-fae1aa5627b8",
"db_currency_id": "4cc3e439-3103-4abc-b6d4-f272b0eb59e5",
"db_language_id": "2c50df20-f572-4d55-bf61-18c56afb088c",
"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-09-20T11:35:16.5069564+00:00"
},
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a4696060-dd6d-46b7-aafb-92858a22999e",
"date_reported_by_company": "2026-09-20T11:35:16.5069564+00:00",
"id2": 36,
"company_id": "a7b08815-bc48-411d-8721-c3970ff9c78e",
"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": "98198762-0579-450e-a7c1-e4beb4809038",
"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-09-20T11:35:16.5069564+00:00"
},
"work_instruction_details_id": "f9ae8a6c-877d-45a2-b8bd-70231e806a4a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "db59a58d-4a38-48ec-84da-b2a2a32baaed",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b45e584d-664a-438f-ae8e-ca8dc6bf406e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-20T11:35:16.5069564+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": "13dbc212-1061-44c2-af6a-b2b3e3f77595",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-20T11:35:16.5069564+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.