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": "8bc0b398-1508-403c-b21d-e9de082faba8",
"jobs_id": "c0b9d5c5-c4e1-4ec3-a68b-3010245749aa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5a7ce646-79ce-4dab-b8a7-4033180273d1",
"_parent_id": "0915332d-adce-4917-a74b-d3f3101829bc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f69813f6-59ec-4f2a-93bc-45f2c7b3c252",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c692ccb0-aa0d-41bb-8eef-5996a6951087",
"_parent_id": "4ad38d53-5c35-4a9d-a310-d65d03ff3fb7",
"root_parent_id": "21b2f6ad-5bc8-4679-b9da-08b6d27fc64c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9732bc14-7c29-48b1-a131-05b3644dffe5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3b8d6e4c-199f-492a-afb2-25c7156b4303",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "21a68bd9-26c4-43ac-8c53-52400c414c2d",
"_parent_code": "sample string 6",
"sales_organization_id": "124d3e00-c104-4453-9699-1e4eea526d34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
},
"equipment_model_id": "91839da7-ffd2-41b8-9106-871626d0dc08",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ecad8399-9374-4e25-92d6-e03f63ae87a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2c8407b0-9a23-49fa-9568-60e9105886a3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e642dd4b-b1fc-448c-b02b-55537f3cc723",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a1a7470c-6fb0-4999-bab6-5e81ae825756",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
},
"equipment_family_id": "f1889e15-44a7-47e1-bea9-7cbe4870efa4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3b8d6e4c-199f-492a-afb2-25c7156b4303",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "21a68bd9-26c4-43ac-8c53-52400c414c2d",
"_parent_code": "sample string 6",
"sales_organization_id": "124d3e00-c104-4453-9699-1e4eea526d34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
},
"date_in_production_since": "2025-11-09T01:38:36.2467615+00:00",
"date_out_of_production_since": "2025-11-09T01:38:36.2467615+00:00",
"date_end_support": "2025-11-09T01:38:36.2467615+00:00",
"sales_organization_id": "88d693f9-cd25-4b37-a0cb-d4112040c3a2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+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-09T01:38:36.2467615+00:00"
},
"project_status_id": "4c5e16b1-f6eb-4bf3-ae6a-4e607ea7e843",
"project_status_code": "sample string 10",
"project_status": {
"id": "3af64313-ef1f-4074-b25c-1ae548b92ed1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7bdd3d21-a604-480a-871d-d72bd6bbf163",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
},
"company_id": "eb82a981-56a1-48bf-86ba-f7eaf4dfa2c6",
"company_code": "sample string 12",
"db_address_id": "89422b6e-eead-46b3-b962-a02b156a1cdb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d25fad47-f93c-46e2-9986-342e4bdefa76",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cd6e0467-9615-41ba-b797-6957e34d1f8c",
"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-09T01:38:36.2467615+00:00",
"date_create": "2025-11-09T01:38:36.2467615+00:00",
"date_update": "2025-11-09T01:38:36.2467615+00:00",
"updated_by_user_id": "667553ad-fa01-442e-a826-9e563e50c601",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-09T01:38:36.2467615+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-09T01:38:36.2467615+00:00",
"date_last_job": "2025-11-09T01:38:36.2467615+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-09T01:38:36.2467615+00:00",
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00",
"is_mobile_installation": true
},
"job_type_id": "8f4a66c0-b166-4dd8-9033-fcf0d4f1101d",
"job_type_code": "sample string 7",
"job_type": {
"id": "ffd4f129-f80c-4c8f-82f3-0fcae991fba0",
"name": "sample string 2",
"sales_organization_id": "4b21a39f-6a8f-4cf0-8e2a-c2710cc79b29",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00",
"code": "sample string 7"
},
"job_priority_id": "afb8f5e2-5962-495e-9bde-b282cf567df9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b0e0707d-8beb-441c-a5c7-7150483a7bb7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "184d464b-84cb-4257-87ad-b4eda18b887f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
},
"job_status_id": "caaad122-c706-4ce6-a88f-536988e5a824",
"job_status_code": "sample string 11",
"db_address_id": "69dbbbe1-36a2-4a80-9fcc-ad524fc087ad",
"contact_id": "87142743-514d-4d9d-9dd4-a5cd9bdfe1a0",
"requested_by_company_id": "31d74f6f-1e74-475b-a4ce-ed1e8bfdbb21",
"requested_by_contact_id": "304a3b06-91f2-45dc-8220-92ed034e80cc",
"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-09T01:38:36.2467615+00:00",
"due_date": "2025-11-09T01:38:36.2467615+00:00",
"date_create": "2025-11-09T01:38:36.2467615+00:00",
"date_update": "2025-11-09T01:38:36.2467615+00:00",
"date_closed": "2025-11-09T01:38:36.2467615+00:00",
"suggested_user_id": "c21cbc78-05f1-4955-a4aa-06f77374d36c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "287b5127-9a55-4855-8daf-a70d2bb5ba77",
"db_language_id": "a3b00e68-c2cd-46ae-972d-a2217179efc3",
"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-09T01:38:36.2467615+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "441461dd-a78b-44c0-a6c8-479bde044bbe",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "87d537cc-eff2-4e39-b4f8-e3256e9c61ac",
"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": "22a601a8-9379-4ac5-81b0-77212ad64a4e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1cf9cd28-4ea9-4755-9d6d-9c50d88076a5"
},
"suggested_date_start": "2025-11-09T01:38:36.2467615+00:00",
"skill_id": "1d04f85e-4618-4211-b2ad-64d9d8f075c1",
"skill_code": "sample string 32",
"skill": {
"id": "d1a239fe-540c-417a-9307-2b9ad6a61bcc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "354bcaed-7d52-4a87-8fe4-9b9bc84d0cb2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0a4db9b7-9142-40af-9123-f9d6d095133f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d57adb0-a5cf-497d-a410-74e84c373905",
"db_currency_id": "ae40cb46-aba6-42b1-829d-e0d9ea7fe30a",
"db_language_id": "c3dcd6f4-a721-48e4-bd1a-39600b4cff44",
"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-09T01:38:36.2467615+00:00"
},
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f28284ff-edf2-48c9-a174-c032ab48a448",
"date_reported_by_company": "2025-11-09T01:38:36.2467615+00:00",
"id2": 36,
"company_id": "c30c6133-0469-417a-880f-b0e66d913a9c",
"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": "c61043b8-0998-4eed-a338-70ea2595e94e",
"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-09T01:38:36.2467615+00:00"
},
"work_instruction_details_id": "afd89ecc-d7b0-47ec-a6d9-0176eb5d283c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "43ec8517-faad-40c4-b590-4b499125e706",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3af5babb-c428-460c-a7ab-aa48a07741eb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-09T01:38:36.2467615+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": "7b92d935-1d8c-4a68-8426-42163f7777ff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-09T01:38:36.2467615+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.