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": "07f2c32d-4100-402e-ab52-f1edad1715a2",
"jobs_id": "5bbd8169-e683-4f84-991d-1bf3a9059c32",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20ed7e79-4450-4294-9200-deacc2db46e9",
"_parent_id": "422e3160-0c4f-4c64-9b97-d16093237699",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "920efa40-a286-4f5a-89be-363a364b4c96",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e8b34aad-4564-4cab-b5ae-960bfbb3c89d",
"_parent_id": "99379b1c-06c1-4856-9fe2-0eaca2e6f1c8",
"root_parent_id": "67f39edc-934f-4b47-8183-2c5cd8b905f8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5934cf50-ca3a-4465-8e66-5255e1de39e2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aaecc267-5895-4277-b152-6429f9bc962d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac0f8842-dba9-4147-a787-c3ae12f4fcac",
"_parent_code": "sample string 6",
"sales_organization_id": "26b17ab9-e1d9-44e6-8a32-2d93bd6a2de5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"modified_dateutc": "2026-10-06T19:56:11.5798049+00:00"
},
"equipment_model_id": "590ab88f-c666-4b1a-95dd-54e7d9e0134f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a186f5df-80c7-4f86-9164-6edb004fdf91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c4326bd-2c14-4b4d-b509-118583e12abf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "031fb295-c59f-4b9a-89ca-843bf73e8756",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dad87796-4a5d-4081-b6da-732ca4eb9f1b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"modified_dateutc": "2026-10-06T19:56:11.5798049+00:00"
},
"equipment_family_id": "b84be76f-07fa-46c3-83c7-84d26433f745",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aaecc267-5895-4277-b152-6429f9bc962d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac0f8842-dba9-4147-a787-c3ae12f4fcac",
"_parent_code": "sample string 6",
"sales_organization_id": "26b17ab9-e1d9-44e6-8a32-2d93bd6a2de5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"modified_dateutc": "2026-10-06T19:56:11.5798049+00:00"
},
"date_in_production_since": "2026-10-06T19:56:11.5798049+00:00",
"date_out_of_production_since": "2026-10-06T19:56:11.5798049+00:00",
"date_end_support": "2026-10-06T19:56:11.5798049+00:00",
"sales_organization_id": "e0ad0ba2-e7b4-490c-9ee3-c3a5b8e2b708",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+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-10-06T19:56:11.5954356+00:00"
},
"project_status_id": "abb7c193-da6e-497e-97e2-3d0cae9fc732",
"project_status_code": "sample string 10",
"project_status": {
"id": "00408e21-9df2-4ec5-bf98-4d347674c16f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "891bc013-adf9-4358-a986-01f66e84c6ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T19:56:11.5954356+00:00"
},
"company_id": "2d13211b-1298-4f63-8e1e-5754b8bd1863",
"company_code": "sample string 12",
"db_address_id": "9b464d7a-1c75-48c0-9905-aabc4ffebe3a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "92bf8169-564f-469d-93e7-367a79f9e915",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9b4d3cdd-e81c-4c63-919b-91d3f2b3ec2a",
"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-10-06T19:56:11.5954356+00:00",
"date_create": "2026-10-06T19:56:11.5954356+00:00",
"date_update": "2026-10-06T19:56:11.5954356+00:00",
"updated_by_user_id": "1a67dadc-885b-452f-a1f1-c7c707aaa1a5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-06T19:56:11.5954356+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-10-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-06T19:56:11.5954356+00:00",
"date_last_job": "2026-10-06T19:56:11.5954356+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-06T19:56:11.5954356+00:00",
"modified_dateutc": "2026-10-06T19:56:11.5954356+00:00",
"is_mobile_installation": true
},
"job_type_id": "4e681fc8-ed61-4383-a845-a473b79ca1e2",
"job_type_code": "sample string 7",
"job_type": {
"id": "83be80c9-387f-43a8-b019-ad5e615165e0",
"name": "sample string 2",
"sales_organization_id": "f2eb3221-6d8c-4162-bdfa-9190a7dd9800",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-06T19:56:11.5954356+00:00",
"code": "sample string 7"
},
"job_priority_id": "3b3b0f17-5dfc-4b82-b74f-2a1b55413603",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f6acd202-b58b-4dfa-86de-31dc0486a044",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ada6eead-bcbb-4d29-9f3f-4350c0a479c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-06T19:56:11.5954356+00:00"
},
"job_status_id": "ded9975a-1b76-4337-9428-c9015f686ad3",
"job_status_code": "sample string 11",
"db_address_id": "0bea91e3-7760-4c52-a635-f6f8c53a4c80",
"contact_id": "03babc68-da63-4eff-9c4e-dd85dd733fd3",
"requested_by_company_id": "3af1ed44-2eb5-4f2c-a057-0bd589edc0e9",
"requested_by_contact_id": "e5a67cd5-04d6-445e-b31c-694cba19de4e",
"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-10-06T19:56:11.5954356+00:00",
"due_date": "2026-10-06T19:56:11.5954356+00:00",
"date_create": "2026-10-06T19:56:11.5954356+00:00",
"date_update": "2026-10-06T19:56:11.5954356+00:00",
"date_closed": "2026-10-06T19:56:11.5954356+00:00",
"suggested_user_id": "eb7ea983-e439-484f-a354-ec00eb3b4aab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6ca650dd-f743-442c-af29-453b0b9a980f",
"db_language_id": "ec241956-99a7-421b-9c32-84433839ce77",
"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-10-06T19:56:11.5954356+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "93c14007-3026-421d-8073-34973a073447",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6afa1556-64fd-405a-a9a0-5d10a77c5166",
"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": "0325e02f-c2e3-4336-87e9-826901487563",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-06T19:56:11.5954356+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "43cf8125-c1c0-448e-909c-a76ba19680b1"
},
"suggested_date_start": "2026-10-06T19:56:11.5954356+00:00",
"skill_id": "e21ee1bb-18da-4a34-8b87-004bce380199",
"skill_code": "sample string 32",
"skill": {
"id": "5c9ccbe0-a0cd-4816-8c1c-f8f2916c177e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aa43e29a-bea7-40ff-b18a-0a876ed17ebd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a743f6ac-691d-424c-8ca8-18a22838a8d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c44cf0e-4872-4a5f-8af7-343ed30cb637",
"db_currency_id": "e5acce84-5ffb-4b89-b5de-ebc25cbfdbb8",
"db_language_id": "aa623f22-1868-4d5a-accd-966f0f4af2f6",
"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-10-06T19:56:11.5798049+00:00"
},
"modified_dateutc": "2026-10-06T19:56:11.5954356+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "97288eda-bc8c-4f0c-81b8-2edee21857e3",
"date_reported_by_company": "2026-10-06T19:56:11.5954356+00:00",
"id2": 36,
"company_id": "a8b13d82-629e-4950-9fc5-166e747d131a",
"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": "ea484663-85b6-4378-af79-a759f0b3ff3d",
"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-10-06T19:56:11.5954356+00:00"
},
"work_instruction_details_id": "0e6a5252-e5f2-4caa-b1eb-7a7e7876fa28",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5a144741-861b-4d33-9d98-5fc5a76ddac6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "814ede87-728c-4cc2-94bc-2f85ad22f02f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-06T19:56:11.6124204+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": "557a35e5-029e-46fd-b6d0-6d50b189504a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-06T19:56:11.6124204+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.