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
{
"id": "0c2a80f3-a35d-4e83-876a-19451eaf95b8",
"jobs_id": "c745d369-bb69-49fa-ade2-a15d24aa9a69",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9f712789-22b2-47de-907e-9042189544ea",
"_parent_id": "65496e87-7f34-4313-90c2-ee8b38197183",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "388cde02-5dcd-44aa-ac95-f785b2b660ad",
"project_reference_back_office": "sample string 5",
"project": {
"id": "75e87b6f-ed9d-4836-8590-86ba77c61654",
"_parent_id": "fcd9d0d0-a4eb-43e2-ab6a-9fa31eb6f20a",
"root_parent_id": "33ec477b-ca42-48b7-9593-c135ec903285",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4649b800-f44f-4012-ae0c-8381bafece9d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6985aa1d-3a37-4418-bcb6-87c4c1d132f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "320f52e1-4af6-4847-b7db-c9bbef9c8269",
"_parent_code": "sample string 6",
"sales_organization_id": "636af946-8fbb-45ca-b168-01c20e7b0148",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"modified_dateutc": "2026-11-18T08:42:12.7032403+00:00"
},
"equipment_model_id": "37652ab0-d3a4-4724-a02c-a3cca2212307",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "09739bc3-003e-4964-9b25-3231b2ff0dd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3522247e-7ada-41f8-8343-acda26ae5258",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7619aa7c-d1e6-42da-94e2-21d8bde94c79",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f9af2964-52b3-4555-b0ee-01c312dbff54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"modified_dateutc": "2026-11-18T08:42:12.7032403+00:00"
},
"equipment_family_id": "193da358-9b59-4f8a-a170-60a429141f1b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6985aa1d-3a37-4418-bcb6-87c4c1d132f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "320f52e1-4af6-4847-b7db-c9bbef9c8269",
"_parent_code": "sample string 6",
"sales_organization_id": "636af946-8fbb-45ca-b168-01c20e7b0148",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"modified_dateutc": "2026-11-18T08:42:12.7032403+00:00"
},
"date_in_production_since": "2026-11-18T08:42:12.7032403+00:00",
"date_out_of_production_since": "2026-11-18T08:42:12.7032403+00:00",
"date_end_support": "2026-11-18T08:42:12.7032403+00:00",
"sales_organization_id": "3557d0e5-0261-46dd-b531-35cea544bcd7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+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-11-18T08:42:12.7199288+00:00"
},
"project_status_id": "4ba00e43-c443-46a6-b3ec-ef9fa44cec4a",
"project_status_code": "sample string 10",
"project_status": {
"id": "a2ca6076-6ad8-4c74-8a99-9f06e659dd1d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e950f1a3-513a-46d4-b6e0-ca105483bcb6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00"
},
"company_id": "b18beb98-de5b-4420-b31b-ba93cd774dad",
"company_code": "sample string 12",
"db_address_id": "80f40542-3ca5-4a2a-ac8e-5b35e2b47e83",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dcddf24b-c448-43d8-9017-690abf2a0003",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b8c44bba-8820-4478-bd8e-f358ab43c755",
"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-11-18T08:42:12.7199288+00:00",
"date_create": "2026-11-18T08:42:12.7199288+00:00",
"date_update": "2026-11-18T08:42:12.7199288+00:00",
"updated_by_user_id": "0892a9e1-3e44-467b-b396-dcda4477e484",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-18T08:42:12.7199288+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-11-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-18T08:42:12.7199288+00:00",
"date_last_job": "2026-11-18T08:42:12.7199288+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-18T08:42:12.7199288+00:00",
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00",
"is_mobile_installation": true
},
"job_type_id": "d14cf939-9f2a-4501-87bd-45236f13354f",
"job_type_code": "sample string 7",
"job_type": {
"id": "aec42075-7dad-4b1a-b3ea-a01b5d8e0167",
"name": "sample string 2",
"sales_organization_id": "c9615349-896b-4022-982c-bcc8fc2a0086",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00",
"code": "sample string 7"
},
"job_priority_id": "1cb0f177-d27c-4cc9-b2b1-95435b3fbb32",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "23fe4ff3-eeb1-4811-b108-76584b90c2de",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a839d518-2a2d-4a81-858f-75db812829e4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00"
},
"job_status_id": "ce11062d-e7c7-4fd9-a185-f867cf880886",
"job_status_code": "sample string 11",
"db_address_id": "7ccf9d2e-4345-4b9d-9f3a-345a26371a72",
"contact_id": "616078f4-336c-4089-aa0c-4404039eb6cd",
"requested_by_company_id": "29427cde-7185-4153-8c6f-8370f4a5b6dd",
"requested_by_contact_id": "bd611f76-f217-447d-9889-67acfd3bf4bc",
"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-11-18T08:42:12.7199288+00:00",
"due_date": "2026-11-18T08:42:12.7199288+00:00",
"date_create": "2026-11-18T08:42:12.7199288+00:00",
"date_update": "2026-11-18T08:42:12.7199288+00:00",
"date_closed": "2026-11-18T08:42:12.7199288+00:00",
"suggested_user_id": "1563ce95-3fd2-4341-9fcf-8c96ce6f8cc0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "76ba87be-ed30-42a9-a5b5-5b2c63b185a5",
"db_language_id": "686702ac-0c70-4493-b00e-9dfaae2c4e68",
"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-11-18T08:42:12.7199288+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3339d0c0-795f-4ec6-9a38-8803c1c523f1",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "91337d0a-eae2-4577-a9b3-1240bf3c992f",
"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": "48dca6af-ff45-4939-b698-457e651eb848",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9286ff58-2d13-46d4-b815-f438de493ebd"
},
"suggested_date_start": "2026-11-18T08:42:12.7199288+00:00",
"skill_id": "80830eae-85e6-44cb-b6c6-3cddc9ce2195",
"skill_code": "sample string 32",
"skill": {
"id": "16c9bdc2-d5a0-4c5d-ba65-74fff7acf214",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b83ceb83-13de-4af9-9973-cbc96e9a5303",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f89b7813-16f7-4d9e-8fc2-85546820d92c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d3041e0-d7e0-4719-aec6-909b08ac1dee",
"db_currency_id": "c0ea3935-9451-4360-9519-99230cc07c02",
"db_language_id": "ac21cc78-1a7b-44e4-b7d7-1699d1f1053c",
"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-11-18T08:42:12.7032403+00:00"
},
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2803c925-bc56-4d66-bd39-cf73bdd13f2e",
"date_reported_by_company": "2026-11-18T08:42:12.7199288+00:00",
"id2": 36,
"company_id": "cc76f5a3-2362-4793-897d-c0078999f71f",
"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": "d54de1a8-fd69-464a-961d-548f85455b59",
"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-11-18T08:42:12.7199288+00:00"
},
"work_instruction_details_id": "652689b3-223c-47b1-b5e2-528c39bd11f7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "62de3e2d-ea0c-4c0c-a2f2-010613db9f8b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3b457670-edc1-45f2-8cae-037b74da2947",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-18T08:42:12.7199288+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": "c64c86f2-62b4-471f-a0f0-ed106ca101d8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-18T08:42:12.7199288+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.