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": "ef9ae7dd-dcf4-4e89-84e8-1c5b886958fb",
"jobs_id": "78b470bf-40e9-431a-a3d0-5039f63b3d0c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cbba1e7c-53c6-4db6-91be-53966cf54a05",
"_parent_id": "57c4ca4a-bf5f-40b6-a763-bbd59ce169ec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ac9fe104-6ac5-45f5-8bee-54d06c035dc8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "71f2b171-b515-4999-ad01-be900451e754",
"_parent_id": "c1e34e32-4023-49c6-a703-383aa39f5217",
"root_parent_id": "c23981a9-7b98-4b80-8e0c-63e2a0b42208",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f0280fa6-6808-4130-86f0-152bee3f2c39",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "22efa1ad-d2b1-46a2-a3ae-fb7fc83dc8dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b12ba60b-7eb9-4cbd-917a-56f94f05364c",
"_parent_code": "sample string 6",
"sales_organization_id": "dd4f5750-62f8-4f48-ad2e-3391319524be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00"
},
"equipment_model_id": "b2d2ab6c-5bbc-42c6-8571-c85d9d617000",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8d8ff76f-3f0e-420d-bd2d-ec411487aa30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5de69c49-f37f-4eca-8a67-59dcc2c18073",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dda3b8a3-e60d-4eb6-9f81-6372248214c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "072c2ad2-c536-450f-bc9a-a88dd3c3e3a0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00"
},
"equipment_family_id": "124cffb8-d4d1-4252-853c-de5c9b97448f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "22efa1ad-d2b1-46a2-a3ae-fb7fc83dc8dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b12ba60b-7eb9-4cbd-917a-56f94f05364c",
"_parent_code": "sample string 6",
"sales_organization_id": "dd4f5750-62f8-4f48-ad2e-3391319524be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00"
},
"date_in_production_since": "2025-11-13T08:35:38.1117796+00:00",
"date_out_of_production_since": "2025-11-13T08:35:38.1117796+00:00",
"date_end_support": "2025-11-13T08:35:38.1117796+00:00",
"sales_organization_id": "710a591f-7411-453c-a9b7-31f68e940f21",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+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": "2025-11-13T08:35:38.1117796+00:00"
},
"project_status_id": "3b583835-c579-4441-8ef9-b22a3439ad0f",
"project_status_code": "sample string 10",
"project_status": {
"id": "b3443988-1aa9-4633-8d04-89634ecbb5c4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6a1c4cb2-5720-4ed9-81fd-43866fd0cc50",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00"
},
"company_id": "2baacf18-54d6-481e-b047-a113696c4f1e",
"company_code": "sample string 12",
"db_address_id": "e975bd4a-4c72-42b9-ba90-e2146c86a117",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "bcbc92ed-309c-4f8b-be6b-c8e4f1c72a90",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a90a9caf-fc47-46c8-b906-f589fa13d854",
"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": "2025-11-13T08:35:38.1117796+00:00",
"date_create": "2025-11-13T08:35:38.1117796+00:00",
"date_update": "2025-11-13T08:35:38.1117796+00:00",
"updated_by_user_id": "1a6d1079-789c-4688-85a9-f329005ee3ed",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-13T08:35:38.1117796+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": "2025-11-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-13T08:35:38.1117796+00:00",
"date_last_job": "2025-11-13T08:35:38.1117796+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-13T08:35:38.1117796+00:00",
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ea61a60-574d-48d2-81ff-7355f37a2700",
"job_type_code": "sample string 7",
"job_type": {
"id": "346f1a31-88fb-4d88-998a-f1be9160adcc",
"name": "sample string 2",
"sales_organization_id": "491418be-fc06-4c5b-b59c-88fd4aee4a60",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00",
"code": "sample string 7"
},
"job_priority_id": "de607c60-75d9-4263-82c7-ea0ead86762c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e839122c-9f01-4a7a-bee7-adf08b085aca",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c0a77a87-8f04-4d42-956c-840bf110e547",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00"
},
"job_status_id": "2ba5d0ba-aa05-4c71-b110-e0089fc43776",
"job_status_code": "sample string 11",
"db_address_id": "0eae341e-0dd8-4695-834b-d76b2ef75aca",
"contact_id": "e950619d-b766-4840-9e2f-ec8b43c72fe8",
"requested_by_company_id": "92246cdf-074f-4ee0-a0d6-6b29a010326b",
"requested_by_contact_id": "19a896b9-4da9-4c13-9935-74045c23f856",
"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": "2025-11-13T08:35:38.1117796+00:00",
"due_date": "2025-11-13T08:35:38.1117796+00:00",
"date_create": "2025-11-13T08:35:38.1117796+00:00",
"date_update": "2025-11-13T08:35:38.1117796+00:00",
"date_closed": "2025-11-13T08:35:38.1117796+00:00",
"suggested_user_id": "bfdf3337-881e-4f64-a4fa-57dc337a52d0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d537274b-0120-4e22-9b6b-62c2967df2ba",
"db_language_id": "47514489-9677-4bd7-afbf-474da2f51be0",
"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": "2025-11-13T08:35:38.1117796+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b74bb297-446c-4bd4-a349-70b6b28647ab",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "20bc8aea-c050-4e2d-b029-b4d570e3cfd0",
"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": "cd653718-77fb-4a1e-acdf-9437f091e7d1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c60adc7f-709c-463c-953e-759a5da8ad1b"
},
"suggested_date_start": "2025-11-13T08:35:38.1117796+00:00",
"skill_id": "7d953111-d698-4a33-befd-e8f3f5051948",
"skill_code": "sample string 32",
"skill": {
"id": "e7555a48-8afb-4496-a84f-b7839bea207d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "90e62b66-7cae-483b-ba78-60ab601ccb70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96de664f-bcdb-4fce-8fe0-1a29b3f63990",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81cec2a8-0b6b-41d4-8dc9-6908dacdc25f",
"db_currency_id": "89d313a9-3733-4a28-87cc-4087759e280c",
"db_language_id": "3749c11b-caff-4baf-983e-f10e27b41724",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"modified_dateutc": "2025-11-13T08:35:38.1117796+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bd87e517-dee3-4e15-855a-a2565f0a385a",
"date_reported_by_company": "2025-11-13T08:35:38.1117796+00:00",
"id2": 36,
"company_id": "c4c66aff-38b7-46fd-9da1-58ad90a22046",
"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": "d3bcc387-fa84-4651-84e2-689c03c86f69",
"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": "2025-11-13T08:35:38.1117796+00:00"
},
"work_instruction_details_id": "52549a52-2618-4de6-be7b-de225c655c06",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1df734f4-69f7-4c82-ae41-1f19a8dc92db",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "84b85199-0744-4d58-bb19-4bfa7ec4ce34",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-13T08:35:38.1274042+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": "a5d6a105-6711-4c51-956a-6dab682c4a78",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-13T08:35:38.1274042+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.