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": "495dc695-8511-462e-9c04-38ea10163d3b",
"jobs_id": "9cdef114-4bdd-4b44-86c0-0ca18cd0ef5f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5b163a39-c947-4758-afa4-7c9d1e813ecc",
"_parent_id": "0681640c-55fe-4217-a51a-18a655cca067",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "841ac24d-1cdb-4352-8e78-f69031ed4203",
"project_reference_back_office": "sample string 5",
"project": {
"id": "847ba549-f183-4495-ac42-6876b7621b7a",
"_parent_id": "2728fbe1-ff13-447a-a552-b420886aaaa6",
"root_parent_id": "adb8e278-03b0-4d60-b794-3d77aa38f717",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5023c842-7886-4cad-a64e-c5a2ab364eae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "52159bb7-ffee-4d3c-8716-b1cebbdf1205",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae054349-5335-456b-93ee-8a5a245eff82",
"_parent_code": "sample string 6",
"sales_organization_id": "5389d13a-2d47-4746-a9f8-f4a63778780f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
},
"equipment_model_id": "61e0316b-661a-4ce5-861e-c9fa0baed7c4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "97cde704-c914-40c4-bfd1-c597c475f7e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1f940f5e-cf33-4e8a-9236-74c0e56fa8d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d60ec2f7-1afa-40ef-94c3-c12c57e2749f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "195ff588-0775-43c9-a4e6-5aee38877a94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
},
"equipment_family_id": "0608f029-56c0-44cc-81dc-88496a8582f4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "52159bb7-ffee-4d3c-8716-b1cebbdf1205",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ae054349-5335-456b-93ee-8a5a245eff82",
"_parent_code": "sample string 6",
"sales_organization_id": "5389d13a-2d47-4746-a9f8-f4a63778780f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
},
"date_in_production_since": "2026-04-18T03:51:36.2948715+00:00",
"date_out_of_production_since": "2026-04-18T03:51:36.2948715+00:00",
"date_end_support": "2026-04-18T03:51:36.2948715+00:00",
"sales_organization_id": "605061e7-56b6-4a67-a575-f6d9c14ff4ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+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-18T03:51:36.2948715+00:00"
},
"project_status_id": "d662c0f9-9102-4979-981c-c69127d9d7ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "758733c8-3e2e-4f32-ad05-7d90be3a29cf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "817fe104-3de6-4f22-9b8f-2b14d916c8ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
},
"company_id": "1c10fa26-abca-449a-bc57-2789cf25de0b",
"company_code": "sample string 12",
"db_address_id": "0c770d06-473c-4dc7-88c7-e2d520e6579a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7e24d4a1-6f25-4671-a427-e9e45a4fa5a6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9f38fe71-df7c-4fe7-928d-437210f8dc8f",
"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-18T03:51:36.2948715+00:00",
"date_create": "2026-04-18T03:51:36.2948715+00:00",
"date_update": "2026-04-18T03:51:36.2948715+00:00",
"updated_by_user_id": "e9f47da3-cfbe-4c14-a5c9-5cc780a6e0ec",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-18T03:51:36.2948715+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-18T03:51:36.2948715+00:00",
"date_last_job": "2026-04-18T03:51:36.2948715+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-18T03:51:36.2948715+00:00",
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00",
"is_mobile_installation": true
},
"job_type_id": "50826195-af0e-4002-a6d7-8276e2b13c6e",
"job_type_code": "sample string 7",
"job_type": {
"id": "db792b7a-526f-4c25-ab28-4817205764f0",
"name": "sample string 2",
"sales_organization_id": "16665eb9-0dbe-492f-a25d-a02c0ec9f286",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00",
"code": "sample string 7"
},
"job_priority_id": "903d8fa2-0760-4992-96ba-0bbfe84931f0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "094590d0-ca3d-44f6-a17c-55d948ffe111",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e03e2c20-ebce-4106-a010-15d10122b54e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
},
"job_status_id": "462308a2-d783-449e-8a08-8049bc23b87b",
"job_status_code": "sample string 11",
"db_address_id": "8815b7e8-5f88-41dc-af10-6517c3533614",
"contact_id": "5a44d9b7-5e6f-4971-91f9-b650a3468dfe",
"requested_by_company_id": "d6234187-8e66-455d-97a5-7cc556c66501",
"requested_by_contact_id": "9fd8303a-9295-40c0-a927-fd5dae3f7c3f",
"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-18T03:51:36.2948715+00:00",
"due_date": "2026-04-18T03:51:36.2948715+00:00",
"date_create": "2026-04-18T03:51:36.2948715+00:00",
"date_update": "2026-04-18T03:51:36.2948715+00:00",
"date_closed": "2026-04-18T03:51:36.2948715+00:00",
"suggested_user_id": "3a152edd-df5d-48c7-a739-4a50ee1c5972",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cba42709-81d5-4f23-b680-f627190c911e",
"db_language_id": "650f228b-f0f9-4594-8864-4a68a5597705",
"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-18T03:51:36.2948715+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8fc1b0a4-b133-448c-9210-43053e172ff2",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8aad9d17-ce18-4ccd-99bd-1ec536861bc9",
"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": "bb1d57f9-8258-4aa4-a138-89f49cdea954",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b51233ee-4d04-46c6-a16e-962479ce99e3"
},
"suggested_date_start": "2026-04-18T03:51:36.2948715+00:00",
"skill_id": "7d718e3c-4d6d-4337-b7ed-b3da4df6262c",
"skill_code": "sample string 32",
"skill": {
"id": "cae2077a-2522-4bdc-93d6-2a3f33389051",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ff87dc79-6143-44e8-8263-8f606b586847",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64264d29-891d-41f6-9775-f11a99de6666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9d611a8-1999-441b-a06e-d0d1fd15b89c",
"db_currency_id": "5735b6a7-8d1e-428e-a539-3d723fa21da6",
"db_language_id": "3a2a6b8a-7579-48c8-9de9-eaf19f8df36f",
"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-18T03:51:36.2948715+00:00"
},
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13024801-b40b-44df-bad9-d7965e21ab49",
"date_reported_by_company": "2026-04-18T03:51:36.2948715+00:00",
"id2": 36,
"company_id": "48a8d917-08de-4927-98d5-dd6e72c0cff7",
"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": "92651044-13ef-4258-a2ee-d2672eaf0f19",
"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-18T03:51:36.2948715+00:00"
},
"work_instruction_details_id": "cb740e32-4761-47c0-8f7c-cbcf90a671b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "52825063-574d-434f-8945-e8dc3a304ae3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c15efedf-251d-4000-8989-ef8f2aca129a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-18T03:51:36.2948715+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": "b26f9dfe-10da-484a-a886-1b953cf3cf95",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-18T03:51:36.2948715+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.