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": "60e14d3e-a50b-469e-a2c3-000ea8be6994",
"jobs_id": "c90653dc-356e-435f-827e-e96c7773120c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cd902ac6-cff2-4e51-a442-dab95f753cd7",
"_parent_id": "651ea725-88f7-4897-bebf-e2ce36834ccb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "de11ff9a-efa4-42a8-9d95-01e2e7e8041c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "47c9b9da-b03b-4fb4-bbf2-4e4f3a118c85",
"_parent_id": "03616649-1b0c-497c-a1a8-29706b31059b",
"root_parent_id": "e5b36ae3-bed3-44e6-8ddc-89a351f16570",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5b8bf36b-8684-4d2a-a781-bfecd9206c42",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7af679d0-6863-4545-81ff-8b9073236165",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edd368ea-63c6-4e43-8e28-e56cb74f8720",
"_parent_code": "sample string 6",
"sales_organization_id": "5c642a0c-2bcb-49d6-9e5b-03dc7bd2a95e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"modified_dateutc": "2026-04-03T04:42:15.5143555+00:00"
},
"equipment_model_id": "e50ce5c0-faa5-4f72-a2b5-347a6066347f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6c93f43e-734c-49f0-bb2d-937e24593bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "09196925-c8db-4cf4-9b9f-2f905ced07ad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b4b1dddd-3123-4f1a-996d-198229840d84",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0bdab9f8-397a-4d20-a501-85d4fcbbdc80",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"modified_dateutc": "2026-04-03T04:42:15.5143555+00:00"
},
"equipment_family_id": "9441a0c9-77f2-4f57-b187-e574f02d7139",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7af679d0-6863-4545-81ff-8b9073236165",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edd368ea-63c6-4e43-8e28-e56cb74f8720",
"_parent_code": "sample string 6",
"sales_organization_id": "5c642a0c-2bcb-49d6-9e5b-03dc7bd2a95e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"modified_dateutc": "2026-04-03T04:42:15.5143555+00:00"
},
"date_in_production_since": "2026-04-03T04:42:15.5143555+00:00",
"date_out_of_production_since": "2026-04-03T04:42:15.5143555+00:00",
"date_end_support": "2026-04-03T04:42:15.5143555+00:00",
"sales_organization_id": "1e42d5c0-6609-49ea-a0eb-c90ad280ad93",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+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-04-03T04:42:15.5143555+00:00"
},
"project_status_id": "f9f8c77b-30da-4ed4-8bde-345ff59be644",
"project_status_code": "sample string 10",
"project_status": {
"id": "ebbe9a60-1dc8-4df4-86da-f37da823b5f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c4827c77-11fc-4d48-9913-cb9f09755baf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T04:42:15.5143555+00:00"
},
"company_id": "3ae76c58-6d87-4d07-9ac5-89e78e56d350",
"company_code": "sample string 12",
"db_address_id": "64c10f56-418f-40ad-9100-559a4048ed42",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7aa3dc86-b4f9-45b9-94ee-b0f0c4c02727",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1991454b-9f34-4f3d-aa7b-dc7eca52a27d",
"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-04-03T04:42:15.5299139+00:00",
"date_create": "2026-04-03T04:42:15.5299139+00:00",
"date_update": "2026-04-03T04:42:15.5299139+00:00",
"updated_by_user_id": "ae86c2a4-ba46-4698-bf86-e2f2fa123ff5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-03T04:42:15.5299139+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-04-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-03T04:42:15.5299139+00:00",
"date_last_job": "2026-04-03T04:42:15.5299139+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-03T04:42:15.5299139+00:00",
"modified_dateutc": "2026-04-03T04:42:15.5299139+00:00",
"is_mobile_installation": true
},
"job_type_id": "1c781f69-94bb-4121-9410-b74559d217cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "4284e65e-0c78-417d-94ac-c84631a8d9ea",
"name": "sample string 2",
"sales_organization_id": "50353f31-645f-432d-8e98-9de3e4004f5b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-03T04:42:15.5299139+00:00",
"code": "sample string 7"
},
"job_priority_id": "1cca69a8-57e7-4c96-bf12-29178c08585e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "512777c1-0547-4f7b-ae14-36e30ffdbe58",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6b46bcbf-31f9-4e71-83c9-ed6f35213bc8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T04:42:15.5299139+00:00"
},
"job_status_id": "4c4de34c-3d11-4212-ae98-b199621b44de",
"job_status_code": "sample string 11",
"db_address_id": "9af1ae81-4939-407a-88fe-70840312004e",
"contact_id": "935eefdc-8a48-4a9d-8be8-6485f9f2e20c",
"requested_by_company_id": "33b2acc6-847e-4675-926f-3e58797761d8",
"requested_by_contact_id": "017d11e8-03f3-4563-bbbc-179dd2fb400c",
"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-04-03T04:42:15.5299139+00:00",
"due_date": "2026-04-03T04:42:15.5299139+00:00",
"date_create": "2026-04-03T04:42:15.5299139+00:00",
"date_update": "2026-04-03T04:42:15.5299139+00:00",
"date_closed": "2026-04-03T04:42:15.5299139+00:00",
"suggested_user_id": "ac259189-fe61-4857-a3d0-75ab1b43192c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "844c6f86-342c-4bc2-b2a3-4a5a1ae47082",
"db_language_id": "6363aadc-98fd-40fd-99fa-bb1c77bf7df4",
"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-04-03T04:42:15.5299139+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e32780ff-7613-4d05-a91e-1725cf84c8f8",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "10f6556d-9285-4bdb-a846-30eeaa28a97a",
"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": "9988ca9a-79e6-4f87-9e2a-02eabedffb22",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-03T04:42:15.5299139+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "44aded9d-a392-4aa2-b095-64d9b7f90cce"
},
"suggested_date_start": "2026-04-03T04:42:15.5299139+00:00",
"skill_id": "e40dc1ba-809e-4cfc-ab67-1fa0d884e8a1",
"skill_code": "sample string 32",
"skill": {
"id": "e97bea2e-edde-4a19-8035-e945303b39f5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6c70ab10-4ca3-410f-9b61-a92a97f0bb13",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a68ce2b-8434-4225-accb-4551775401fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bccb050f-bba5-4b51-b856-79ebbe73fbc4",
"db_currency_id": "a4f3d5b9-0a33-4ba8-94f4-769563114d48",
"db_language_id": "25135855-91d8-4b6b-a6f2-4661b0e3adc1",
"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-04-03T04:42:15.5143555+00:00"
},
"modified_dateutc": "2026-04-03T04:42:15.5299139+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5d8eaacb-4e83-4963-a8f8-e22fe7069f57",
"date_reported_by_company": "2026-04-03T04:42:15.5299139+00:00",
"id2": 36,
"company_id": "73b42577-2f72-45ed-b11f-6ec090797a0c",
"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": "1dbe39c8-4138-4c29-be0c-140dee25249a",
"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-04-03T04:42:15.5299139+00:00"
},
"work_instruction_details_id": "9b69fe29-d58c-4111-92f4-3ac58485d56d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bdf843dc-73a4-43ca-acc6-d1482b21e594",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4b52eb10-3898-47d6-bbed-72c5a3cf4ad8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-03T04:42:15.5299139+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": "cab3684a-6ad1-489f-933b-cf80bea67ce3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-03T04:42:15.5299139+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.