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": "b72e32db-6297-44e8-ad1d-84405f5e4a86",
"jobs_id": "16996296-ace1-469d-8623-6184b0cb6929",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e5242f52-d453-4c16-a85b-2401cbd3336c",
"_parent_id": "ab646d44-4943-4557-9089-bd32b97e44af",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dff35bcd-35ac-4d99-8982-1ea0913e223b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ca63a815-f0a5-4e69-878d-a33a851c4d14",
"_parent_id": "10b91e1e-1403-46e5-b02c-3b2e23adc8b5",
"root_parent_id": "ac8c8872-2d82-4f39-b257-10aae219df5d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "84971e53-dc9e-4225-b58e-dc9f57d10e26",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0016c714-34b8-42ea-aec1-351775a01de3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe467565-b990-4c5d-b2e7-add090f913f6",
"_parent_code": "sample string 6",
"sales_organization_id": "2ec60d52-6b5e-4bd9-9722-f50604be753c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
},
"equipment_model_id": "3195952f-12ac-45dc-9982-9167627b607b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f213d002-3855-486b-8db2-4615ae8c4758",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3bfc8e6a-27c1-4da9-b682-de7f3f87e456",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4464d43c-7f61-4b57-92e9-8b9864195bac",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ce088ccf-b508-4e5f-a01d-81da95000075",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
},
"equipment_family_id": "ee9dea9d-3651-4065-aa12-804ebf091642",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0016c714-34b8-42ea-aec1-351775a01de3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fe467565-b990-4c5d-b2e7-add090f913f6",
"_parent_code": "sample string 6",
"sales_organization_id": "2ec60d52-6b5e-4bd9-9722-f50604be753c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
},
"date_in_production_since": "2026-07-08T01:27:46.0788627+00:00",
"date_out_of_production_since": "2026-07-08T01:27:46.0788627+00:00",
"date_end_support": "2026-07-08T01:27:46.0788627+00:00",
"sales_organization_id": "2a866afe-89d2-4790-af8c-eaf582efd262",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+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-07-08T01:27:46.0788627+00:00"
},
"project_status_id": "660bc35c-7f64-4a92-945d-4b7926048fc7",
"project_status_code": "sample string 10",
"project_status": {
"id": "b12e84f4-f831-48ba-98ab-2e09a50f56b3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "473cd2a0-fe25-4eff-ad10-9ce418c3c63a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
},
"company_id": "602c0427-ab49-409d-9560-a0915c0083bb",
"company_code": "sample string 12",
"db_address_id": "e3711720-5c1c-41dc-a1ea-b1425b112b54",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4c68f7f3-97f9-442e-953d-cf15f8dfc8f8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0f199de7-89a9-4475-84ba-9917bb3d3ff8",
"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-07-08T01:27:46.0788627+00:00",
"date_create": "2026-07-08T01:27:46.0788627+00:00",
"date_update": "2026-07-08T01:27:46.0788627+00:00",
"updated_by_user_id": "d710afe9-7fa5-447b-a22f-2470146772bd",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T01:27:46.0788627+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-07-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T01:27:46.0788627+00:00",
"date_last_job": "2026-07-08T01:27:46.0788627+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T01:27:46.0788627+00:00",
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00",
"is_mobile_installation": true
},
"job_type_id": "c38e406d-07dc-4b94-a3a2-5e8a2e30bd68",
"job_type_code": "sample string 7",
"job_type": {
"id": "2da76c53-cd46-4697-ab24-9e4cb876dd6f",
"name": "sample string 2",
"sales_organization_id": "1988f10f-a6bc-43b2-8b66-42d27eb3dab5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00",
"code": "sample string 7"
},
"job_priority_id": "ca8d3200-42f1-41eb-89a3-0abb4dcf2f7d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "34f97339-ba71-4599-9dc6-6ccf7a0d87d6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1c17e0d3-4a6c-46a2-8469-457611dc9e59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
},
"job_status_id": "2bbca2f0-6324-4a2f-acb6-c32b3e5047fa",
"job_status_code": "sample string 11",
"db_address_id": "3c30fac6-5a4a-4fc7-9993-04537d3d4e4c",
"contact_id": "93f32173-98d1-426b-8317-49d47567aa2a",
"requested_by_company_id": "26d97e47-1baf-455b-86a8-7e083fb8d150",
"requested_by_contact_id": "a10b0157-1294-493d-a82f-bf7852805474",
"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-07-08T01:27:46.0788627+00:00",
"due_date": "2026-07-08T01:27:46.0788627+00:00",
"date_create": "2026-07-08T01:27:46.0788627+00:00",
"date_update": "2026-07-08T01:27:46.0788627+00:00",
"date_closed": "2026-07-08T01:27:46.0788627+00:00",
"suggested_user_id": "9d4236a9-4f0b-4def-9ec5-cbdb3df12fce",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ad621e6a-3e62-47bf-bab8-0f272e5dd44b",
"db_language_id": "3c20d02f-c074-4321-8dc2-834284589375",
"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-07-08T01:27:46.0788627+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "32938e01-eb67-4e68-b4d0-90c456732cf4",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "38fa2903-5051-4d16-9a00-b67752386590",
"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": "36751183-6b48-4bb9-a94f-7607d9650159",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f7ff8eb4-6a69-4290-b8ed-2e1d369d9e08"
},
"suggested_date_start": "2026-07-08T01:27:46.0788627+00:00",
"skill_id": "f9b56a79-4b27-47ab-87ba-ff27f559514d",
"skill_code": "sample string 32",
"skill": {
"id": "e3000f47-3e21-49b4-8335-dd34edb32cfe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f5812122-9967-4f3b-b1f5-5c57bd0bca55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5d610667-90b9-4acc-8e90-33e9446eb11f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aaf4c4ed-8270-46fb-9272-fc8f58944549",
"db_currency_id": "92d73d1b-c611-4c0c-b5c6-42a325a9015c",
"db_language_id": "05aa588a-c411-4c56-acd4-c1efaf5c5f2b",
"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-07-08T01:27:46.0788627+00:00"
},
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4ece9c6-2cd3-4d96-80bf-df62b7b75d50",
"date_reported_by_company": "2026-07-08T01:27:46.0788627+00:00",
"id2": 36,
"company_id": "8e4ded38-4c6d-4e03-ae77-d76f96c11e85",
"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": "e8a8e4d8-3447-4673-ad68-0f6997ec5fd3",
"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-07-08T01:27:46.0788627+00:00"
},
"work_instruction_details_id": "41b8b67d-ba67-4088-a882-69b28ff501b9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6552f123-460b-449c-aeb4-6f0201dbd3eb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eb998dc3-80db-47e0-a262-cac2b62f6132",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-08T01:27:46.0788627+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": "97656cf3-f2b0-4848-98e1-2ff9a3804280",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-08T01:27:46.0788627+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.