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": "c6dc29ca-d4cb-4cec-a1d2-cb712c4e3f95",
"jobs_id": "5a3288d4-8e20-444e-ae76-95898142c608",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3694f55e-7b5e-4746-b42d-e1c1cfbb2aa9",
"_parent_id": "997bef0c-4f46-4757-8f15-7c6e2a5752c4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d85062f0-a8de-4ddf-b76b-90eef9bec2bb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c97c3838-3b8f-46c1-994d-d9fe926ace8a",
"_parent_id": "251e0ac4-633c-4660-940d-a29da9471379",
"root_parent_id": "78906d60-4096-4100-a1b7-9e60a7368687",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c2410253-cf34-4413-b246-ddacec2117e2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a857506e-d2c5-431c-b71a-8fe078949b09",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9d43fb75-e9bd-4529-a406-cf9913aa498c",
"_parent_code": "sample string 6",
"sales_organization_id": "732e8a9f-07cc-4e24-8905-7773e5393d09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
},
"equipment_model_id": "ac18253e-231b-45cd-bbbf-d422449df558",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0f5b43b4-1578-44de-b960-f51506e0e59f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2c333f07-1ae1-41d8-ab18-1419a9114d80",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cd780ed4-10fb-4e1f-b73a-5485a42ac37d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8c6ea720-9a8b-4db1-9cec-4a02ce6c3ac6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
},
"equipment_family_id": "89bfd0d1-0b32-4413-8cc7-b796f0b3825a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a857506e-d2c5-431c-b71a-8fe078949b09",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9d43fb75-e9bd-4529-a406-cf9913aa498c",
"_parent_code": "sample string 6",
"sales_organization_id": "732e8a9f-07cc-4e24-8905-7773e5393d09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
},
"date_in_production_since": "2025-12-22T08:44:28.7866522+00:00",
"date_out_of_production_since": "2025-12-22T08:44:28.7866522+00:00",
"date_end_support": "2025-12-22T08:44:28.7866522+00:00",
"sales_organization_id": "2d5177e6-3a71-423d-b5c3-752434b07ba8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+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-12-22T08:44:28.7866522+00:00"
},
"project_status_id": "a3333553-2ea8-4aac-9f69-17560a381b4c",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c1bb327-c7c7-481c-a11a-e4f0e5f6bb84",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7242637d-fca5-4971-b43a-21ade1f08516",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
},
"company_id": "f296cd4a-6058-4758-8ad2-756dd995d668",
"company_code": "sample string 12",
"db_address_id": "a4269313-0cf8-4349-8b72-f5e26d171f31",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "77b7591d-e683-4663-bf20-43492ec1b66e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "46fe1df9-1127-4d1f-a659-7174dc611a94",
"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-12-22T08:44:28.7866522+00:00",
"date_create": "2025-12-22T08:44:28.7866522+00:00",
"date_update": "2025-12-22T08:44:28.7866522+00:00",
"updated_by_user_id": "66ff2964-658c-4765-b95c-022537aac9f6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-22T08:44:28.7866522+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-12-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-22T08:44:28.7866522+00:00",
"date_last_job": "2025-12-22T08:44:28.7866522+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-22T08:44:28.7866522+00:00",
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00",
"is_mobile_installation": true
},
"job_type_id": "daa3c3b7-527c-4aad-ab14-2e9c6d1c2d73",
"job_type_code": "sample string 7",
"job_type": {
"id": "93f6437b-3a0c-458f-8496-32f357835a01",
"name": "sample string 2",
"sales_organization_id": "b78ea000-9ecd-4cfb-b5bd-b256c41c40ff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b28c9f9-6cc5-4297-ad5b-cc22ed555cf9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6439d9f9-738e-430b-a8e8-5181a2ad48e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3469714b-5da0-41e5-a378-faae817f70d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
},
"job_status_id": "c407050a-d414-4168-9ada-b43c4748e65a",
"job_status_code": "sample string 11",
"db_address_id": "14dd8b0f-c9e6-4f97-9b98-db2db227b752",
"contact_id": "258abe91-1e73-4df8-a4c9-bff6b90c2b2c",
"requested_by_company_id": "fce849e9-80c0-43da-971c-e3ba191af91e",
"requested_by_contact_id": "50fcb658-d133-430f-abe0-1ea47b0df7bf",
"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-12-22T08:44:28.7866522+00:00",
"due_date": "2025-12-22T08:44:28.7866522+00:00",
"date_create": "2025-12-22T08:44:28.7866522+00:00",
"date_update": "2025-12-22T08:44:28.7866522+00:00",
"date_closed": "2025-12-22T08:44:28.7866522+00:00",
"suggested_user_id": "bad8f533-596c-48ed-ac20-c0a89a5dfd15",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "086a348c-b0e5-4330-9908-ab77c28d3797",
"db_language_id": "172eaa27-31e5-4923-aaa2-1affd70eb6b8",
"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-12-22T08:44:28.7866522+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "98be4e9e-a38e-42f7-a17e-0cf0bde179d2",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4e5578f1-5042-4a5e-abb5-09be39ba727f",
"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": "161ee61f-538d-427d-bb10-7d03c9d3f789",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bff5a82d-e8b7-4051-9ad3-32cec9ed80f7"
},
"suggested_date_start": "2025-12-22T08:44:28.7866522+00:00",
"skill_id": "d5206d05-dec4-4c75-aa37-2893c74c9a5d",
"skill_code": "sample string 32",
"skill": {
"id": "f9625dcc-7af4-4191-abfa-caa1ffc6d26b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "04d0c7f9-e8af-4b97-9ddc-c54eb0845556",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b3477d92-5e96-4176-9e21-1e01bb8121ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5cc280f8-5dec-4fdb-958e-ecddeff151ee",
"db_currency_id": "be60f1a8-f422-4a51-af83-cd5a41f9577a",
"db_language_id": "47b65667-3d20-439c-9521-801758c650dc",
"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-12-22T08:44:28.7866522+00:00"
},
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e13e2f4a-b0f6-4e09-910f-4de4c16d9378",
"date_reported_by_company": "2025-12-22T08:44:28.7866522+00:00",
"id2": 36,
"company_id": "814614e3-930d-484d-a3b7-be44d8b6708f",
"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": "c8b73067-a687-4152-a9d1-0810236e93d0",
"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-12-22T08:44:28.7866522+00:00"
},
"work_instruction_details_id": "a0955154-d830-41f9-a168-16d1400c01cd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8da42b07-3562-4f80-b15b-28e5ab7e62bd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9e570995-eda0-4c76-9017-adae9323aba5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-22T08:44:28.7866522+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": "e778593f-4004-4237-bd93-f310b391ba8e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-22T08:44:28.7866522+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.