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": "e036e1af-b4d7-4c03-8bf3-3e6bbd0c3d95",
"jobs_id": "23fedcb6-c1e4-4d7e-874a-588bfa82e0a0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f359ac3f-990b-44e7-bc63-59d7cc0bc398",
"_parent_id": "a9d92caf-c24d-4fc3-a78c-fdbb8900a261",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c7a1c650-94ca-439a-81a2-b04e548b4be1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "723fde8b-ae6e-4878-905f-a47f13b7f837",
"_parent_id": "75a922c5-df67-4652-b707-1299343914a9",
"root_parent_id": "8148c2af-1765-42a5-bb93-32649d6fcf68",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "162ecac1-3c13-47d1-870f-dc2b5fd781c4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b375ea3f-5813-4a30-bfb2-f0c016f64142",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17a031cc-3549-44f7-8b84-60c9552548a0",
"_parent_code": "sample string 6",
"sales_organization_id": "72eb758b-56b4-4081-8bbb-a8b8857da74f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"modified_dateutc": "2026-09-18T02:55:26.2209415+00:00"
},
"equipment_model_id": "0ae764a3-0a93-4936-aed3-435184fd1f22",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "69f17d70-d0ff-4bf2-91d9-23790092d748",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a424375d-a636-45cb-a078-83fc45d3d761",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "964b41af-88df-47ba-b744-0cc3043f0769",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c113fb9-5369-417e-ac42-145a93a2658d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"modified_dateutc": "2026-09-18T02:55:26.2209415+00:00"
},
"equipment_family_id": "db52171c-ff71-4606-b405-ef4720765af3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b375ea3f-5813-4a30-bfb2-f0c016f64142",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17a031cc-3549-44f7-8b84-60c9552548a0",
"_parent_code": "sample string 6",
"sales_organization_id": "72eb758b-56b4-4081-8bbb-a8b8857da74f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"modified_dateutc": "2026-09-18T02:55:26.2209415+00:00"
},
"date_in_production_since": "2026-09-18T02:55:26.2209415+00:00",
"date_out_of_production_since": "2026-09-18T02:55:26.2209415+00:00",
"date_end_support": "2026-09-18T02:55:26.2209415+00:00",
"sales_organization_id": "d2250ac3-d849-4f94-be5c-75a2065d524b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+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-18T02:55:26.2209415+00:00"
},
"project_status_id": "756d3472-b147-4339-963c-eb46205aae5a",
"project_status_code": "sample string 10",
"project_status": {
"id": "27e959dd-83dc-421c-90a7-1ed2076d8bbf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d6023b13-90a5-46dc-9e18-ff4f2687918e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T02:55:26.2209415+00:00"
},
"company_id": "fd99188d-4030-47b5-a95c-ff3ce21d8598",
"company_code": "sample string 12",
"db_address_id": "f104e2cf-aae4-4ee6-a6bb-4fde11f032dc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c20b62cb-c26f-4b4f-b790-75d47b49c707",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43ddeb3a-5d46-4c15-8b9e-18fd45f148e1",
"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-18T02:55:26.2209415+00:00",
"date_create": "2026-09-18T02:55:26.2209415+00:00",
"date_update": "2026-09-18T02:55:26.2209415+00:00",
"updated_by_user_id": "5c3d4510-5515-4739-828e-dd7c311bbaed",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T02:55:26.2209415+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T02:55:26.2209415+00:00",
"date_last_job": "2026-09-18T02:55:26.2209415+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T02:55:26.2209415+00:00",
"modified_dateutc": "2026-09-18T02:55:26.2209415+00:00",
"is_mobile_installation": true
},
"job_type_id": "56480f07-2eca-4a00-8370-6801a9c59f0b",
"job_type_code": "sample string 7",
"job_type": {
"id": "b33756af-23fb-4ea7-9d4c-cb8e93b4e001",
"name": "sample string 2",
"sales_organization_id": "86f98895-119f-4ba8-a60d-76a6e924b598",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T02:55:26.2365686+00:00",
"code": "sample string 7"
},
"job_priority_id": "5be72ea8-3f8f-4865-a04c-915bcec0a4d0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0c51a2cb-e1fa-4c95-a023-128e19a4e16e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3cdcd80e-8807-40ef-8f3c-8858a3559771",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T02:55:26.2365686+00:00"
},
"job_status_id": "67d3b554-c36d-4caa-9a54-730bb9ce5a92",
"job_status_code": "sample string 11",
"db_address_id": "26378d19-e7ea-4f4c-8ff8-e7da9e8483e1",
"contact_id": "5633cae0-32a2-4902-9b47-84e816f89be0",
"requested_by_company_id": "b58c432d-ce02-434a-9f1c-09cd03f3c309",
"requested_by_contact_id": "e5a81420-d5ff-4aef-9a8e-ca31a9437763",
"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-18T02:55:26.2365686+00:00",
"due_date": "2026-09-18T02:55:26.2365686+00:00",
"date_create": "2026-09-18T02:55:26.2365686+00:00",
"date_update": "2026-09-18T02:55:26.2365686+00:00",
"date_closed": "2026-09-18T02:55:26.2365686+00:00",
"suggested_user_id": "7f23ede0-844f-4ccb-b803-33f9a81dea72",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "162d8e5f-23c2-48cd-bc4b-164fc07b5043",
"db_language_id": "ee691521-a748-4fc0-86b4-9d5af8235e75",
"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-18T02:55:26.2365686+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "781b467a-1966-4331-ad5b-0de5c0f7c6ab",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c401b3a7-75aa-4cad-8eae-2497f24fa6a0",
"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": "ce378aac-325d-48be-90fc-f318b1cc0d46",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T02:55:26.2365686+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d1290de4-5647-4a14-97c3-934938d7458c"
},
"suggested_date_start": "2026-09-18T02:55:26.2365686+00:00",
"skill_id": "7ca19a41-6e44-41fc-99ec-b17f557f3882",
"skill_code": "sample string 32",
"skill": {
"id": "d51e129e-c78a-4d9a-9331-8a9f0f9c7216",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "79971593-d0a8-4832-8fe1-0fd2ee79d1f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "24bc004a-e492-4bae-a125-53f2d1f7f996",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "583b16ed-1e04-4974-b2fa-d143f034eca7",
"db_currency_id": "bcbcbbd4-b205-466d-8ac3-21723259ba0c",
"db_language_id": "1d35b860-91e8-4e82-a38a-2a9d81e2f125",
"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-18T02:55:26.2209415+00:00"
},
"modified_dateutc": "2026-09-18T02:55:26.2365686+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "82d9abe2-a963-4e8b-94a2-63fee4401ca4",
"date_reported_by_company": "2026-09-18T02:55:26.2365686+00:00",
"id2": 36,
"company_id": "b3efdfcc-55f6-42cb-a11b-d67d5991799e",
"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": "6d578d07-2119-48b4-8d83-82afcf7dfbf4",
"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-18T02:55:26.2365686+00:00"
},
"work_instruction_details_id": "a5f2a9e5-dda0-47d6-b4bf-691b304b7042",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fb4f7c37-da62-4cda-b5f9-73c100458875",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f8b1970a-04cc-4c5f-b207-cc45fafe6548",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T02:55:26.2365686+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": "9f438c6e-92cc-4334-83c4-597272a1520b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T02:55:26.2365686+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.