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": "da70def4-df31-4dd3-b968-d4e604eff2b4",
"jobs_id": "d6e212dc-5cbf-48fe-881c-e9e9f3e5ab31",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d9094195-27c5-4e7a-a891-cc69a8c30ebd",
"_parent_id": "bf9bcf9e-847f-465e-bb74-d41198483167",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "47a640bf-0ec8-49ed-96fa-43786449b381",
"project_reference_back_office": "sample string 5",
"project": {
"id": "20703e9e-e4a3-4b6d-b490-e93877460084",
"_parent_id": "cb7b8d3b-5dcf-4cda-af46-1aef5e901ea0",
"root_parent_id": "0fa55e94-5ba8-45af-a12c-6ab8636f9361",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0f8147e6-15be-4f8d-a540-2293d3b1e7a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "42d147d6-fe49-4d6f-90a6-50b8c03fe1ad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "62d3d220-8213-4c66-a70a-a5d88dfa50ed",
"_parent_code": "sample string 6",
"sales_organization_id": "47b1e36e-f390-4c7a-8aba-934db3c1ece0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
},
"equipment_model_id": "344232f4-37d6-413a-a0a3-dedf27885c9b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3791f33c-ccaf-4cff-b63d-3635af7a6eaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "254434db-369e-42f8-9d7f-8f1906ffddfe",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2fe9be3c-4ea5-4a3e-81bc-8373167df324",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ef375ef0-d38e-441e-831c-245a192ea3c6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
},
"equipment_family_id": "14b4160f-8c03-46f4-be77-bcb1b65a4c2e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "42d147d6-fe49-4d6f-90a6-50b8c03fe1ad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "62d3d220-8213-4c66-a70a-a5d88dfa50ed",
"_parent_code": "sample string 6",
"sales_organization_id": "47b1e36e-f390-4c7a-8aba-934db3c1ece0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
},
"date_in_production_since": "2025-09-12T08:23:25.9064757+00:00",
"date_out_of_production_since": "2025-09-12T08:23:25.9064757+00:00",
"date_end_support": "2025-09-12T08:23:25.9064757+00:00",
"sales_organization_id": "b74f0bef-6bb3-4f28-87c4-3beb826f2efb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+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": "2025-09-12T08:23:25.9064757+00:00"
},
"project_status_id": "fda2cbc7-5f69-4944-83cf-0f2c9f9c77c8",
"project_status_code": "sample string 10",
"project_status": {
"id": "756dcd75-c8de-4875-ae0d-ad5de116310e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c1fab181-4c40-42a8-880f-ad7e260f6f45",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
},
"company_id": "45aad50a-92b3-418f-b50d-9455c9251801",
"company_code": "sample string 12",
"db_address_id": "7c7b501e-df16-4df4-b371-e62184d686ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d4ebb896-f25f-4795-a2fa-0d6c4946595b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f2111b84-08bb-41a1-ad08-4a3fe2033d74",
"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": "2025-09-12T08:23:25.9064757+00:00",
"date_create": "2025-09-12T08:23:25.9064757+00:00",
"date_update": "2025-09-12T08:23:25.9064757+00:00",
"updated_by_user_id": "76c53084-0eed-4a17-8bea-99a0004f8f2b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-12T08:23:25.9064757+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": "2025-09-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-12T08:23:25.9064757+00:00",
"date_last_job": "2025-09-12T08:23:25.9064757+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-12T08:23:25.9064757+00:00",
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00",
"is_mobile_installation": true
},
"job_type_id": "529ad52e-cf9e-4193-8638-cb9d3cec2757",
"job_type_code": "sample string 7",
"job_type": {
"id": "c87473a4-72df-40ad-864f-9e4ebb34081d",
"name": "sample string 2",
"sales_organization_id": "6219b9fe-4d88-4bd6-b417-c434c836d279",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00",
"code": "sample string 7"
},
"job_priority_id": "74d4fb2e-f255-4ef3-b362-103361ac3000",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "500f91c8-f08b-4cd4-ba1f-830ca7ddd13f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "37915081-dd02-46d9-b309-293fd56ab1ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
},
"job_status_id": "f30609c9-082b-4bda-9226-6ffd3f6d83c7",
"job_status_code": "sample string 11",
"db_address_id": "454eb48c-3079-4461-bfb9-38564d7d44e1",
"contact_id": "dd1b4a0e-5e54-40f8-90f1-25045119ee3b",
"requested_by_company_id": "e4b56aa3-2759-4970-bb92-883afcb25567",
"requested_by_contact_id": "2d3da3ff-a233-4e5b-91ef-5321678274a3",
"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": "2025-09-12T08:23:25.9064757+00:00",
"due_date": "2025-09-12T08:23:25.9064757+00:00",
"date_create": "2025-09-12T08:23:25.9064757+00:00",
"date_update": "2025-09-12T08:23:25.9064757+00:00",
"date_closed": "2025-09-12T08:23:25.9064757+00:00",
"suggested_user_id": "f14f0af4-fa0c-4846-ab84-9241496c84ab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "19d84171-d0e8-4f43-8147-178a9db48c84",
"db_language_id": "619d28ec-d935-43ac-8afd-ae54df18ac48",
"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": "2025-09-12T08:23:25.9064757+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2054878a-cb2e-4a33-9b61-6655fed99087",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cd17ab2a-50fb-4b43-b163-13551d094db7",
"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": "aed20a0b-d0b4-4413-8017-8242ed706dbe",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "12b6f674-9a25-4a4c-93ed-f66490a5eaf8"
},
"suggested_date_start": "2025-09-12T08:23:25.9064757+00:00",
"skill_id": "b44db504-0062-4a3b-836e-9ded0ac8d2ac",
"skill_code": "sample string 32",
"skill": {
"id": "b27f757a-c418-4b17-becd-d0998d377d41",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "abbe2d2f-86e0-4975-86ad-eaf6e16aa7f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b32a62bf-2bb3-4808-a14e-56bde7765f3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "da4ba3ab-d3f5-4c08-90ad-c407d2dbc3d5",
"db_currency_id": "48328f5b-5d84-4963-9c13-286c33ffc924",
"db_language_id": "bda1112a-12d2-44fa-a37d-6b0ed6d04ffb",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4e89b519-8bb7-4fcc-a95e-59a4c037744c",
"date_reported_by_company": "2025-09-12T08:23:25.9064757+00:00",
"id2": 36,
"company_id": "a334437d-b2be-4d5d-8e65-3b2acf85445d",
"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": "257ddb81-a1f7-48c1-81a0-afeaea0eab67",
"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": "2025-09-12T08:23:25.9064757+00:00"
},
"work_instruction_details_id": "1808449f-0c31-4fe5-9c2c-c376e25141f3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8a089015-ffb7-459a-901a-271d72ae7a38",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b1b205b9-4c86-4dac-b37b-ea054a80dd97",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-12T08:23:25.9064757+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": "87e311da-26e1-4cf7-8f74-0995a923e7d2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-12T08:23:25.9064757+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.