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": "0e1e4d64-5aba-47d9-ae2f-268c34dde6fc",
"jobs_id": "c47d4e6f-099d-405a-b67c-d3e1ecf24821",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b3e7726d-c12a-48ce-9984-73ae48c7a9a1",
"_parent_id": "f6df90a8-1dc1-41c2-bcd5-4a07d23d9b47",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c815761a-2496-4070-aa22-cff9131bf918",
"project_reference_back_office": "sample string 5",
"project": {
"id": "de811114-d903-4626-bd72-bdeab3bcdfb8",
"_parent_id": "d6663e59-364f-43be-b8c7-fb0e91415bfb",
"root_parent_id": "96d9a1c0-ebee-4a0d-b20d-d351e13712a6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4b49d626-6e69-4f2e-b278-1438ea33d184",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "460d31dc-b0c1-41a1-b6c9-d5ed45b275dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da07f25d-339a-48b4-89e8-7640aedc232d",
"_parent_code": "sample string 6",
"sales_organization_id": "064949f6-e2d4-40ff-ae89-326d2779bc98",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
},
"equipment_model_id": "5053a5da-5871-408d-a123-1e10ead9fbcd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e2dfbc76-3c37-424e-92d7-db3a6bff4296",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "be915c3b-c9d0-49b7-9c3c-96bc27c32a01",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a72067d6-99d1-4664-9ca9-5293e8573f2f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b09c1c9-e608-4f15-b0d5-3310c8403987",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
},
"equipment_family_id": "f8a2f927-15b4-47ee-9285-f30dd2123c72",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "460d31dc-b0c1-41a1-b6c9-d5ed45b275dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da07f25d-339a-48b4-89e8-7640aedc232d",
"_parent_code": "sample string 6",
"sales_organization_id": "064949f6-e2d4-40ff-ae89-326d2779bc98",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
},
"date_in_production_since": "2026-08-20T23:27:29.9615994+00:00",
"date_out_of_production_since": "2026-08-20T23:27:29.9615994+00:00",
"date_end_support": "2026-08-20T23:27:29.9615994+00:00",
"sales_organization_id": "ea06ef1d-138f-4829-a48a-c840463c4f0e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+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-20T23:27:29.9615994+00:00"
},
"project_status_id": "3fbccd39-ddae-44d0-a66d-177fb3e8e9f4",
"project_status_code": "sample string 10",
"project_status": {
"id": "2d66fb0d-c8cf-4763-a0f2-b71d88e9fbf5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3b3caf59-a908-4a29-bc48-b075ab151720",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
},
"company_id": "24264f6b-f78e-4288-8a30-b72f76ca96b1",
"company_code": "sample string 12",
"db_address_id": "307c0b8e-d096-4810-95a6-6cbca21792f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fcdcea07-f864-477b-bceb-afa7e0360bb4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "080ca599-6d27-4942-a96e-bcbbb7942638",
"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-20T23:27:29.9615994+00:00",
"date_create": "2026-08-20T23:27:29.9615994+00:00",
"date_update": "2026-08-20T23:27:29.9615994+00:00",
"updated_by_user_id": "1e74e60f-6058-4753-bb40-a9dd5752b932",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-20T23:27:29.9615994+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-20T23:27:29.9615994+00:00",
"date_last_job": "2026-08-20T23:27:29.9615994+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-20T23:27:29.9615994+00:00",
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00",
"is_mobile_installation": true
},
"job_type_id": "70c6cd01-50d6-436b-bc90-a9d7aae266a2",
"job_type_code": "sample string 7",
"job_type": {
"id": "4fc39584-ac28-46a6-8d38-e11d1d81d01e",
"name": "sample string 2",
"sales_organization_id": "b7e87d2a-a318-449c-9977-f0438019fc2f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00",
"code": "sample string 7"
},
"job_priority_id": "fbf00423-6afb-4671-8627-e18cba29c6a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "00728831-23cd-4bed-9cb1-cf47bda03286",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b2cbd6e0-c24a-48b0-8c7f-de90153b6d5e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
},
"job_status_id": "3f827955-cff3-4d88-a09d-1484db47e4ea",
"job_status_code": "sample string 11",
"db_address_id": "3356d5b5-1f53-474c-b322-7a1e8e72ced9",
"contact_id": "f6cb8a85-9fdf-4c1c-83ec-0a179f5deef1",
"requested_by_company_id": "97dc3090-e3ba-470d-90f4-7059b8fa5fcd",
"requested_by_contact_id": "d090caf0-fa14-4770-a2bb-cadc5e4cb409",
"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-20T23:27:29.9615994+00:00",
"due_date": "2026-08-20T23:27:29.9615994+00:00",
"date_create": "2026-08-20T23:27:29.9615994+00:00",
"date_update": "2026-08-20T23:27:29.9615994+00:00",
"date_closed": "2026-08-20T23:27:29.9615994+00:00",
"suggested_user_id": "bfa5c2ae-7404-4215-93fe-e8ff77a050ba",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "80b0612e-2a95-454d-9458-71a16f28d797",
"db_language_id": "e26372c9-4676-4b4d-9261-321c68285cb3",
"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-20T23:27:29.9615994+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4a84848e-e3fa-4320-8172-b742b37b39aa",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eb7feced-81d0-4019-af33-92a1a33e682c",
"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": "b96d0a4f-f5f4-4355-8074-4ec4c2c89b2f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b7247a74-44c5-4f33-b730-fecde04f4457"
},
"suggested_date_start": "2026-08-20T23:27:29.9615994+00:00",
"skill_id": "d0d5f501-bce5-4713-be67-9ce996f1a626",
"skill_code": "sample string 32",
"skill": {
"id": "9b51c42b-6f63-488f-91a2-9126c3095b23",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "38428c37-12bd-40c3-9ef6-95803eef6ab9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "db1f01f9-10d0-42f9-a32f-ff6c6571346d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72431dcc-1dd3-4fb3-929f-33fb65ff74e6",
"db_currency_id": "771fc985-4c0e-44c3-92b4-36e6f9394d2c",
"db_language_id": "af233768-0181-46e4-be92-5a550a5e5bdb",
"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-20T23:27:29.9615994+00:00"
},
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "59b0824f-dd71-4b6a-9ebb-92483a8d0994",
"date_reported_by_company": "2026-08-20T23:27:29.9615994+00:00",
"id2": 36,
"company_id": "257f1cff-9756-4751-a637-a4818efae35a",
"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": "5c78e248-59af-4cc4-805f-3e815d72d62e",
"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-20T23:27:29.9615994+00:00"
},
"work_instruction_details_id": "5aa99055-4ab3-4741-9f5a-cfe229fcc874",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6ff2c86c-c131-44ae-ba1d-2b5bdfbd6be6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cceb603b-9079-4987-b4bd-0f17ac78e17d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-20T23:27:29.9615994+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": "2c22f0a7-f752-4df5-b95e-b7e4332f143a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-20T23:27:29.9615994+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.