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": "b8f068e4-b214-4e2c-b12b-adb400c0bdaa",
"jobs_id": "b2508cac-29ed-4c22-8284-7cb0ca68ca00",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8ef42224-e91e-45cb-9a7c-a104bc6c084b",
"_parent_id": "f28934a9-a63c-4585-8de8-3fd20a12ca77",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7ef3d892-6e29-4187-ab34-d9deab67108b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "13e97d46-1b44-4bb5-ad88-43a223682979",
"_parent_id": "ba61ee9a-5594-4083-91f8-b38f815eb130",
"root_parent_id": "05a428c0-ee88-4bc1-89d3-f5c4b120cd13",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "02056f6c-21a8-44a4-961a-40878e9a2da5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "41618408-f16b-4180-a9d5-ad5c88297a02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "435e76c3-e846-45f6-8d9f-4d2a48a3f8f6",
"_parent_code": "sample string 6",
"sales_organization_id": "684beb63-30ec-4357-8a6b-fdfd2417022b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
},
"equipment_model_id": "403c4942-cda4-4baa-aa51-bac1735b4685",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "98053a35-2d87-4d22-911d-5f50b5104cda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "68fd722c-255f-442c-9480-317b9166b6c6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "83f75773-4bd3-428c-87e2-fd30e9b2881c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "41cff7d5-56fd-4863-884f-4891eb54ebcb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
},
"equipment_family_id": "3cbe69b3-ad86-4054-8063-2a9ae8e9c05f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "41618408-f16b-4180-a9d5-ad5c88297a02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "435e76c3-e846-45f6-8d9f-4d2a48a3f8f6",
"_parent_code": "sample string 6",
"sales_organization_id": "684beb63-30ec-4357-8a6b-fdfd2417022b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
},
"date_in_production_since": "2026-06-22T13:32:25.9172263+00:00",
"date_out_of_production_since": "2026-06-22T13:32:25.9172263+00:00",
"date_end_support": "2026-06-22T13:32:25.9172263+00:00",
"sales_organization_id": "f2fb02a7-88a8-46cd-a628-2e9ddc55933a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+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-22T13:32:25.9172263+00:00"
},
"project_status_id": "942890f6-8b6e-41ba-885b-7e7af3149416",
"project_status_code": "sample string 10",
"project_status": {
"id": "0d50503d-8683-443c-b0c2-37583f0c1de0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9ec18304-5df6-41a5-ac32-331d6d82383f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
},
"company_id": "18a8b040-e141-4083-94ae-d7d54c3591f9",
"company_code": "sample string 12",
"db_address_id": "be2133ca-fe87-4a79-8956-2e5fc12f2ca6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "65e70f3c-5725-4399-9729-210571b798b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d6d95f04-00d2-4a92-8f48-b7f2a6771193",
"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-22T13:32:25.9172263+00:00",
"date_create": "2026-06-22T13:32:25.9172263+00:00",
"date_update": "2026-06-22T13:32:25.9172263+00:00",
"updated_by_user_id": "9d04902a-ab56-42ba-b30f-42441ba9833d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-22T13:32:25.9172263+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-22T13:32:25.9172263+00:00",
"date_last_job": "2026-06-22T13:32:25.9172263+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-22T13:32:25.9172263+00:00",
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00",
"is_mobile_installation": true
},
"job_type_id": "09c75b47-9e9e-4395-8ff1-6450e3d7521c",
"job_type_code": "sample string 7",
"job_type": {
"id": "bf65ba26-7f52-4e35-8fb4-f786f1292933",
"name": "sample string 2",
"sales_organization_id": "3189f1ac-1816-480e-8861-7324495ce780",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00",
"code": "sample string 7"
},
"job_priority_id": "fee928c2-4ad0-444e-976c-2c33bbb05bb3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "99e0f2c5-53c2-42be-85bc-1e97027f13a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0dede8d1-e76b-42a0-871c-915722b15c12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
},
"job_status_id": "b1397578-97ab-4c5b-9ab3-ec190fa33d97",
"job_status_code": "sample string 11",
"db_address_id": "ad7171ad-2a25-400f-a63c-d21bbcdbba9b",
"contact_id": "dd3250fc-67b7-4d54-a2e1-16a25e22562c",
"requested_by_company_id": "f631c2ce-d9c6-4516-b3af-b6a1f629eac5",
"requested_by_contact_id": "038c6bb9-68d7-4e26-bc71-1a13d522b7df",
"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-22T13:32:25.9172263+00:00",
"due_date": "2026-06-22T13:32:25.9172263+00:00",
"date_create": "2026-06-22T13:32:25.9172263+00:00",
"date_update": "2026-06-22T13:32:25.9172263+00:00",
"date_closed": "2026-06-22T13:32:25.9172263+00:00",
"suggested_user_id": "0f690991-1c63-4210-b425-8962aab386f1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "212d5efd-8215-48f1-b676-50302c544c7b",
"db_language_id": "eff8c622-f88a-4f4a-8630-eeacf5ba54cd",
"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-22T13:32:25.9172263+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a77ac534-2754-4cf2-b7a7-dd66ca71a1d9",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f055c7f6-be84-4b41-9feb-10e73c1080c3",
"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": "2ffdfc42-525f-40d5-9b56-35f538c7cc42",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5733d938-e135-4469-a917-45b2e4f3df37"
},
"suggested_date_start": "2026-06-22T13:32:25.9172263+00:00",
"skill_id": "68e7d21e-46b5-42ba-a2dd-949a7c488c80",
"skill_code": "sample string 32",
"skill": {
"id": "595093d5-f5ba-419b-b11e-eeb52546e6ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e4e28303-690f-49cd-aa70-118af0242f9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27aab3da-7945-41b5-8711-4dd3cd1602cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0304d2e6-5e63-4b7a-928c-4ca00141da91",
"db_currency_id": "1aeef9f7-7a85-42e6-b00c-2885150432ca",
"db_language_id": "727bd37b-55e6-4369-bad5-59970ef9be86",
"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-22T13:32:25.9172263+00:00"
},
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6f03f6f2-94cf-41a6-b28a-8349129eee81",
"date_reported_by_company": "2026-06-22T13:32:25.9172263+00:00",
"id2": 36,
"company_id": "52995213-cca2-45d4-ae0c-a76a3454ae2b",
"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": "43c6e6da-4bc5-4bd2-afb9-2665cf33a732",
"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-22T13:32:25.9172263+00:00"
},
"work_instruction_details_id": "e5de047f-95ee-43c2-9a50-0f5b057b72f9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f4285f99-1ac4-4d01-9863-174137936aab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4c2507d6-b765-404e-87d2-ebeba0b007cb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-22T13:32:25.9172263+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": "7f684f22-c9c5-46fe-9387-ea160447f137",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-22T13:32:25.9172263+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.