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": "7da8f721-fd5e-4ce3-9fe4-460caee8ea03",
"jobs_id": "9e1469ff-9cfd-4701-8894-edbe2cc19959",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0286a266-1edc-4d76-b28f-58b42acb7b85",
"_parent_id": "20016ea5-01ac-41dd-80f4-fbcd6898722c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9563cdba-f36f-4fb5-a8bb-741386937032",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fa2378ba-319e-4da8-b981-5a12c5531e5c",
"_parent_id": "65a9cefb-e4ea-4db8-9175-65fd908ce558",
"root_parent_id": "8b7a93fb-4f0d-482a-9307-5e323bc9ca07",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "52559343-63b7-4b32-b698-279ead612cf3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "16495eb7-4f80-46fc-b375-83edef298598",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9838348b-0ee4-4176-b51a-1d0a3594898e",
"_parent_code": "sample string 6",
"sales_organization_id": "17dae50a-62cb-43df-bc86-04202715bd85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
},
"equipment_model_id": "64ec52c4-5d64-48b3-9bf8-84f9a56459e9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2962e33f-71cc-400d-bcb7-1413d2f89f07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "23b5b240-2e76-4bb2-9b1b-ac11abccd8f2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "147695c2-e7ac-44f2-8d9a-23714d884b8e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cad43a0b-bba1-48a9-995c-c9016c5cbd8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
},
"equipment_family_id": "41e9c209-204a-4410-9253-a7e077754c6c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "16495eb7-4f80-46fc-b375-83edef298598",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9838348b-0ee4-4176-b51a-1d0a3594898e",
"_parent_code": "sample string 6",
"sales_organization_id": "17dae50a-62cb-43df-bc86-04202715bd85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
},
"date_in_production_since": "2026-02-04T10:09:59.56741+00:00",
"date_out_of_production_since": "2026-02-04T10:09:59.56741+00:00",
"date_end_support": "2026-02-04T10:09:59.56741+00:00",
"sales_organization_id": "03023b89-3fdf-48b6-b771-0b00d73bf4c6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+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-02-04T10:09:59.56741+00:00"
},
"project_status_id": "bbdd1157-b0bc-4868-9a98-8284e99cf3c4",
"project_status_code": "sample string 10",
"project_status": {
"id": "6c288920-5439-49ab-9030-8691fb14b1da",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8f476d82-34c6-47f2-83e7-ee923ee8f976",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
},
"company_id": "2abb43ca-6faf-46e3-a3fc-02bffdc7d4fc",
"company_code": "sample string 12",
"db_address_id": "a67738b1-a69f-4aab-bf9a-df8b7e571f80",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d4b38cbd-3f9b-4ea4-b3f9-003d52a64b6b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "224f6deb-0ed0-414d-91b8-686645bbd161",
"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-02-04T10:09:59.56741+00:00",
"date_create": "2026-02-04T10:09:59.56741+00:00",
"date_update": "2026-02-04T10:09:59.56741+00:00",
"updated_by_user_id": "b035d4de-8ac1-47c2-a61c-4b844b2fec38",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-04T10:09:59.56741+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-02-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-04T10:09:59.56741+00:00",
"date_last_job": "2026-02-04T10:09:59.56741+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-04T10:09:59.56741+00:00",
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00",
"is_mobile_installation": true
},
"job_type_id": "de1cb377-77d7-4310-a779-9bdb6a2552b1",
"job_type_code": "sample string 7",
"job_type": {
"id": "560183f8-b33c-4770-b04f-3e912f96ef50",
"name": "sample string 2",
"sales_organization_id": "ff20a2fb-b3f3-459a-bb93-76a4f60a7d84",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00",
"code": "sample string 7"
},
"job_priority_id": "eaacabfd-3c57-4c40-91a9-c3e0c6e131dd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f0d4c41c-617f-43cf-b1cc-fa6e2bf5792b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "263f7292-d224-4675-9108-3d28e319b41a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
},
"job_status_id": "bab9cf16-22cc-4896-9ad8-da9181420b52",
"job_status_code": "sample string 11",
"db_address_id": "95b15e3f-9a08-4c20-9f9b-a0081a3bbab4",
"contact_id": "0b1fa781-c0be-48ba-8781-1ed4e630779e",
"requested_by_company_id": "6fd06384-358a-46b0-9fb8-dbb8a5a0d072",
"requested_by_contact_id": "dd21f826-7cbc-4c5b-ab2d-7f3b7471fca5",
"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-02-04T10:09:59.56741+00:00",
"due_date": "2026-02-04T10:09:59.56741+00:00",
"date_create": "2026-02-04T10:09:59.56741+00:00",
"date_update": "2026-02-04T10:09:59.56741+00:00",
"date_closed": "2026-02-04T10:09:59.56741+00:00",
"suggested_user_id": "8bb98f3b-70d9-4ecb-9714-8145b00eef78",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "78dfc35a-05b7-46eb-a238-cd19093ca970",
"db_language_id": "474e5513-5523-4fb6-a795-c54bcec34040",
"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-02-04T10:09:59.56741+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5e4ffad5-724b-4d4b-bb28-53a541cc720d",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bb34cbd9-3a55-4002-95b8-c713e4321280",
"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": "31e2344d-3c17-436b-b3c3-e3738b2c1e25",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ee426727-9277-4931-bdba-4a924362ced8"
},
"suggested_date_start": "2026-02-04T10:09:59.56741+00:00",
"skill_id": "a76eca12-7eba-4613-a6aa-bc2b26e22357",
"skill_code": "sample string 32",
"skill": {
"id": "2831e7a2-6c7e-44cf-93ea-21552fb7eb48",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c9d9da64-06a8-4096-93fc-7655836f54a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42be8d41-551b-47f9-a436-84a71dc293c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94cfe1f6-4cb8-4305-84d4-7c0b32ed520c",
"db_currency_id": "f2801192-bdde-401a-8049-54e0af483ae4",
"db_language_id": "367889ce-27cc-4239-a377-43d4df4b90da",
"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-02-04T10:09:59.56741+00:00"
},
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4e6c0c00-a2c5-4394-8279-c2d579a399de",
"date_reported_by_company": "2026-02-04T10:09:59.56741+00:00",
"id2": 36,
"company_id": "82bff454-5891-4786-9fea-940dc80bb4eb",
"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": "bca88b1b-8855-4676-bc44-a6619c319683",
"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-02-04T10:09:59.56741+00:00"
},
"work_instruction_details_id": "64998dc9-3b86-4d13-829e-0c6d9dbfb6ce",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9cc21ba2-7da0-473b-9c7f-8b81111ab717",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eaf13103-f3b0-4d4e-92a7-d7a50a292f41",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-04T10:09:59.56741+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": "26f2fcaf-ad8f-4bb0-a408-a8329bcb3516",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-04T10:09:59.56741+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.