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": "79587dc7-d3cb-40c8-87b1-cb4af37e73cc",
"jobs_id": "b943fd50-7914-4664-9a29-25ccb8711142",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fc5c7825-dfd0-48a5-a261-e4ee77866192",
"_parent_id": "2230aac4-62fe-47da-9435-a3bd43dc0bd2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "59455e73-a65a-43e2-affc-6d13cbba7279",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c60218e5-cdc5-4623-a8d3-f7dc5ffd1ae3",
"_parent_id": "44c35317-d816-47a6-b025-2888a9308589",
"root_parent_id": "7c6f37fa-b4c1-4764-87db-f58e77ea8975",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "59b6c16b-b1e8-43e1-84e6-07086bc78dce",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ca32bbb-9976-42a0-b379-0f6390db6538",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9165a7f5-a4ed-484b-af80-5621efb18137",
"_parent_code": "sample string 6",
"sales_organization_id": "85f1081b-eb23-4353-81ce-471d376fdc59",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
},
"equipment_model_id": "59ea6c88-6eef-490f-a8b7-156d3ea7304d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8bc80741-ab60-424e-8a8b-d72c0be4c541",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "195d5602-55c3-4652-8f59-f002459b81e1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3e5d36f3-ac66-4f97-8c24-18c83a06e099",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "799a4f08-5877-4fc5-ac10-79a1f30036a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
},
"equipment_family_id": "c3db0830-d989-4adb-9f8f-6a50818b66a1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ca32bbb-9976-42a0-b379-0f6390db6538",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9165a7f5-a4ed-484b-af80-5621efb18137",
"_parent_code": "sample string 6",
"sales_organization_id": "85f1081b-eb23-4353-81ce-471d376fdc59",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
},
"date_in_production_since": "2026-06-25T20:15:10.6783576+00:00",
"date_out_of_production_since": "2026-06-25T20:15:10.6783576+00:00",
"date_end_support": "2026-06-25T20:15:10.6783576+00:00",
"sales_organization_id": "8019d297-d36f-41e2-87b5-92a5d44414b1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+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-06-25T20:15:10.6783576+00:00"
},
"project_status_id": "6997bec6-f56c-4588-8cbb-dbc2f40f3a5d",
"project_status_code": "sample string 10",
"project_status": {
"id": "8e1bcf50-ba01-42af-9f63-d77d42379d04",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dfd7cedd-2250-4d4c-804b-660553b715d6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
},
"company_id": "f4d2a866-3fc5-4521-a35c-fe8a0e566fc3",
"company_code": "sample string 12",
"db_address_id": "8081c738-492c-4736-ab77-e7aeb0c4a9ed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f2a3432-21fc-479d-acad-e0bd18926d01",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8122641d-02f4-4ae1-83ef-396ba4f4b7c7",
"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-06-25T20:15:10.6783576+00:00",
"date_create": "2026-06-25T20:15:10.6783576+00:00",
"date_update": "2026-06-25T20:15:10.6783576+00:00",
"updated_by_user_id": "303e6fd0-bba6-4300-aeb2-9ac4b8f06642",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-25T20:15:10.6783576+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-06-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-25T20:15:10.6783576+00:00",
"date_last_job": "2026-06-25T20:15:10.6783576+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-25T20:15:10.6783576+00:00",
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00",
"is_mobile_installation": true
},
"job_type_id": "4190a969-0910-4ba4-bfaa-55cf5e839def",
"job_type_code": "sample string 7",
"job_type": {
"id": "0c36ab1a-6db0-4140-912b-369740ad184a",
"name": "sample string 2",
"sales_organization_id": "48c7c9aa-63a9-4c2e-9c0d-ac7559263275",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00",
"code": "sample string 7"
},
"job_priority_id": "f64388a8-c602-4ee1-b13d-46b0d21f7fd0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b0103939-0542-4ea9-a98c-9928af8f4bb5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b8bb0657-cfdb-404e-a846-ca6a378dd098",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
},
"job_status_id": "04620215-c4e5-45c4-aff5-878fc34a9358",
"job_status_code": "sample string 11",
"db_address_id": "2e484d20-3ae6-4b75-81e0-e2241c64ceec",
"contact_id": "ec1286c1-e3b1-4afb-951f-f528693f3844",
"requested_by_company_id": "cd1b0bf8-c891-4d58-882e-6e7b06c95afe",
"requested_by_contact_id": "60ca910e-6785-4dc1-a6c8-8feffde8dacf",
"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-06-25T20:15:10.6783576+00:00",
"due_date": "2026-06-25T20:15:10.6783576+00:00",
"date_create": "2026-06-25T20:15:10.6783576+00:00",
"date_update": "2026-06-25T20:15:10.6783576+00:00",
"date_closed": "2026-06-25T20:15:10.6783576+00:00",
"suggested_user_id": "6b8dc5b1-734e-4d19-aecf-a82bcda278dc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f93edd58-b252-4407-8ac6-78d70f3883b9",
"db_language_id": "ef0fb3f6-ae2c-4ed1-a824-aaca5478f7ee",
"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-06-25T20:15:10.6783576+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c18f1e43-5496-4a69-be17-27833659f7b0",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "be9e1b5e-8a7f-43b8-9c20-d88447cb7a02",
"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": "0ef75a97-9b59-4331-bf59-2013f13be2da",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "51e8fd1c-8686-47b4-9f90-5475a1423b8d"
},
"suggested_date_start": "2026-06-25T20:15:10.6783576+00:00",
"skill_id": "3a43b2c1-e35e-43f2-a66f-9e1011419195",
"skill_code": "sample string 32",
"skill": {
"id": "45a7b7dd-4c53-4743-b0df-270037bcecb9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "706baba3-c12c-4e23-9fb5-0a32a367830f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "88b214d1-07e6-4934-bb12-1fa7183c6f4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2dacfba4-7f3d-4b44-989b-4745deb2a5a9",
"db_currency_id": "6a1e35e5-0521-4fa1-b802-419e13b2e4bd",
"db_language_id": "ad832a56-6976-45f4-b960-ee780ceb4d5c",
"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-06-25T20:15:10.6783576+00:00"
},
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "825d8baa-3492-4ad9-b252-0be968d4c76d",
"date_reported_by_company": "2026-06-25T20:15:10.6783576+00:00",
"id2": 36,
"company_id": "ebe69b1a-9fd3-49a3-84fc-137c7b4223bb",
"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": "e2c4518b-a7d6-44bb-94b3-40592b14f3e6",
"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-06-25T20:15:10.6783576+00:00"
},
"work_instruction_details_id": "e52d0483-42d8-4553-9a1c-b72abef3641c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cd3f106e-b694-4f9e-9961-e2ce2f335d9f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3110f91f-a8ee-4010-ae8b-d7fdb0825cbe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-25T20:15:10.6783576+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": "7ea24930-b6fe-4a78-8dfc-4c3171b94aa7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-25T20:15:10.6783576+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.