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": "83252446-4e94-438c-bcc2-4f3040509593",
"jobs_id": "ba4573b5-1297-4389-b900-8e91d8c73140",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "41c01609-4ae5-4224-862a-498c1e5a8f4c",
"_parent_id": "1832d468-065f-4e73-b52a-2fa96f64c519",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6d7d4ac4-c020-4420-86b6-df95c731038c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "087029e6-84ef-4260-8dcb-21b8122e6477",
"_parent_id": "5f4b0755-6283-42c9-aa2a-fdefa2b7beed",
"root_parent_id": "2baf4d3b-b4b3-452b-a9ab-6bb47ff3a72f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4a8eae17-1d6e-44d1-9cc8-ada09fecd59f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7b8483d3-ba93-4aa0-9879-e1dd2bb067f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab14bbde-64b1-4f0a-b120-fd5cb037c8d0",
"_parent_code": "sample string 6",
"sales_organization_id": "d83def35-7c5d-465f-8e04-27cd66078f53",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
},
"equipment_model_id": "bd209817-ed4d-45d1-998b-230f38638186",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea407e48-9eeb-4b5b-9000-cbd0c92afbf9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0f33df80-c6ed-4b0d-8ff1-e87248c579e0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "08d9f7cd-3a70-459f-987c-828b228fda52",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c69af8a0-a1ff-4318-881d-aac0162d14ae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
},
"equipment_family_id": "299b80e2-b8da-4b1c-814b-f36f2e43230c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7b8483d3-ba93-4aa0-9879-e1dd2bb067f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab14bbde-64b1-4f0a-b120-fd5cb037c8d0",
"_parent_code": "sample string 6",
"sales_organization_id": "d83def35-7c5d-465f-8e04-27cd66078f53",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
},
"date_in_production_since": "2026-09-14T22:06:21.3252688+00:00",
"date_out_of_production_since": "2026-09-14T22:06:21.3252688+00:00",
"date_end_support": "2026-09-14T22:06:21.3252688+00:00",
"sales_organization_id": "a02a3b9b-058d-462b-8b56-390e6f49331d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+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-09-14T22:06:21.3252688+00:00"
},
"project_status_id": "848a6f9f-0d3b-437c-8b84-0cc2e1985b1d",
"project_status_code": "sample string 10",
"project_status": {
"id": "ae9ea1d2-d6de-4fc7-9c74-db5230cec1bd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "23b58836-8192-4b16-b35b-3e6fa752fe56",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
},
"company_id": "c7a8c8a2-8556-4bbb-bc67-6a68f9a7eaf0",
"company_code": "sample string 12",
"db_address_id": "dadb31c6-2781-4b48-92f6-24c1efbe7c35",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "58afe3e1-18cb-4ccb-99c9-c856fdd4432e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "758e9121-380b-4ae8-95d1-321533864025",
"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-09-14T22:06:21.3252688+00:00",
"date_create": "2026-09-14T22:06:21.3252688+00:00",
"date_update": "2026-09-14T22:06:21.3252688+00:00",
"updated_by_user_id": "0244ee48-cdb2-4907-9c2f-9c9165cfac90",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-14T22:06:21.3252688+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-09-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-14T22:06:21.3252688+00:00",
"date_last_job": "2026-09-14T22:06:21.3252688+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-14T22:06:21.3252688+00:00",
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00",
"is_mobile_installation": true
},
"job_type_id": "91bd689a-b43a-4b1d-83be-4549f87ea5a2",
"job_type_code": "sample string 7",
"job_type": {
"id": "df269c49-f19c-441d-9a88-d2b46bfa8541",
"name": "sample string 2",
"sales_organization_id": "dee37f27-2920-4e91-b59b-c4f51d145d94",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00",
"code": "sample string 7"
},
"job_priority_id": "e4067fae-c99b-4d6b-a203-e862707aaf00",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "723decac-48f2-4d3b-8235-73c7e8a72929",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1ddca1da-7de5-4fde-abe4-dfeaa62a595d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
},
"job_status_id": "7a246fa3-c254-4f49-9778-3ddea8b3d7ba",
"job_status_code": "sample string 11",
"db_address_id": "8e4ba042-9e46-4138-840a-29e559ee8321",
"contact_id": "13a12b42-a7b0-43f4-95ae-d563ecc64401",
"requested_by_company_id": "2bb38cd5-a601-4802-88db-8d098adc6d3a",
"requested_by_contact_id": "1515c073-3095-4d52-b695-1e02ec5346d8",
"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-09-14T22:06:21.3252688+00:00",
"due_date": "2026-09-14T22:06:21.3252688+00:00",
"date_create": "2026-09-14T22:06:21.3252688+00:00",
"date_update": "2026-09-14T22:06:21.3252688+00:00",
"date_closed": "2026-09-14T22:06:21.3252688+00:00",
"suggested_user_id": "9f0d79b7-6192-436d-a407-2c9b72c8735b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "938345d0-180a-4ba6-ba6b-ce11579de00d",
"db_language_id": "66db258d-cb31-4388-bc17-0e487a5d7360",
"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-09-14T22:06:21.3252688+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4f72c375-dbf4-42c4-9a92-d65968b9558d",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bfa3f6ce-25a9-4672-a30a-d010a660013b",
"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": "0ca51da0-3677-4faf-8d49-6d4a05d157ac",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6e4c48ce-e12f-4b0b-b433-fd6d0cfbfe62"
},
"suggested_date_start": "2026-09-14T22:06:21.3252688+00:00",
"skill_id": "425ba085-da6d-44fb-999b-570b5867133e",
"skill_code": "sample string 32",
"skill": {
"id": "7efe24c2-2a03-4228-b066-7e1af1802e1b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a2f45f33-5d64-415e-acb0-935c0cbc7b99",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "77047841-4fdf-47a5-aede-489aeb2745e2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "01995be3-9097-4bbb-9837-e69f5bc705cd",
"db_currency_id": "4cd2c353-e263-479e-ab59-9ab8f52a27d3",
"db_language_id": "9d589d03-a00c-4b0c-ac85-5c88a3aa93c8",
"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-09-14T22:06:21.3252688+00:00"
},
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c25df34b-7875-4d07-b0b5-8d3b32dc347e",
"date_reported_by_company": "2026-09-14T22:06:21.3252688+00:00",
"id2": 36,
"company_id": "5b978d0d-004a-42a9-be65-35328504ff6b",
"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": "56b8e0ed-5537-48e3-a8c9-2c3da0010015",
"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-09-14T22:06:21.3252688+00:00"
},
"work_instruction_details_id": "ef49b654-22b5-4eb7-a9fc-5dc54795e07f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0098cea3-08e4-4ed8-b846-5ec21e652fc9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "78f64600-47c0-456b-a7b2-32ec68aedfed",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-14T22:06:21.3252688+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": "c1a10669-48b8-4590-b419-fb0fe2156b2e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-14T22:06:21.3252688+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.