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": "d456a642-4a38-44d0-ba37-97ff2d978b03",
"jobs_id": "1f4ff514-363f-41a8-8089-41a1e0124ead",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7b68cb9d-22a1-454c-9420-028e19077894",
"_parent_id": "09809314-17fc-4b16-b070-c0c198b5cc1b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dfaf0aa8-6fb4-4cec-b88e-ea93cf511e44",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b5737cea-0e14-4b54-88c1-f0fa646a2bef",
"_parent_id": "129b9a12-8b32-47bc-994a-c79990d36031",
"root_parent_id": "2c8f05ae-2808-4cfd-b3dd-6515c39ad305",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "138ed75a-796c-4a79-83fa-139826172c4f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a826e9b7-6537-4b32-a8ce-23aa5f80bf6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "491e0ac3-3e4d-4d70-9b3d-22fe3abbdf28",
"_parent_code": "sample string 6",
"sales_organization_id": "4dc4a8f0-1887-468c-936e-e0b06848e960",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"modified_dateutc": "2026-10-05T06:08:53.0320663+00:00"
},
"equipment_model_id": "2a323a29-1bb2-4e3d-8428-326b8a9856a4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9b1f2eec-712c-40ab-bf1c-13aecbcc5ea7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5305b5f6-3540-45e8-b2c4-edcad60112da",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6254fb56-7eba-4513-827a-0ff59e177cdb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "10d8a21e-f0cc-49d0-8b44-b0ca141689df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"modified_dateutc": "2026-10-05T06:08:53.0320663+00:00"
},
"equipment_family_id": "97295eae-b0ef-45e2-b8ad-feecad6b6158",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a826e9b7-6537-4b32-a8ce-23aa5f80bf6f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "491e0ac3-3e4d-4d70-9b3d-22fe3abbdf28",
"_parent_code": "sample string 6",
"sales_organization_id": "4dc4a8f0-1887-468c-936e-e0b06848e960",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"modified_dateutc": "2026-10-05T06:08:53.0320663+00:00"
},
"date_in_production_since": "2026-10-05T06:08:53.0320663+00:00",
"date_out_of_production_since": "2026-10-05T06:08:53.0320663+00:00",
"date_end_support": "2026-10-05T06:08:53.0320663+00:00",
"sales_organization_id": "898e3c95-d2b2-4bab-9d54-020e433a7466",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+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-10-05T06:08:53.0320663+00:00"
},
"project_status_id": "88e30495-4cfe-4a95-bee9-48cff61f3293",
"project_status_code": "sample string 10",
"project_status": {
"id": "3ce04a0b-a039-4b53-abe6-baa3d86dd341",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b9c71ea2-c6da-4379-a8c6-6e6ac0b081cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T06:08:53.0320663+00:00"
},
"company_id": "a9b1738b-f0df-47c3-9de4-ff9762b7dec1",
"company_code": "sample string 12",
"db_address_id": "89a5ba28-e966-450d-8c5e-55320355b5e6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ff609c2d-b5d0-4700-ada9-6915e537a896",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b86fa47d-f174-4162-a082-9bae31e0fed8",
"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-10-05T06:08:53.0453676+00:00",
"date_create": "2026-10-05T06:08:53.0453676+00:00",
"date_update": "2026-10-05T06:08:53.0453676+00:00",
"updated_by_user_id": "9478c312-1c82-45db-bc19-7909573d4624",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T06:08:53.0453676+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-10-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T06:08:53.0453676+00:00",
"date_last_job": "2026-10-05T06:08:53.0453676+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T06:08:53.0453676+00:00",
"modified_dateutc": "2026-10-05T06:08:53.0453676+00:00",
"is_mobile_installation": true
},
"job_type_id": "2001693e-5fb1-4f25-ae7e-cb7dc46471c4",
"job_type_code": "sample string 7",
"job_type": {
"id": "42e46a51-32ff-4b1d-a6d8-37088c12472c",
"name": "sample string 2",
"sales_organization_id": "dbe92fbe-1116-4154-ad50-afe31ec6e1a7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T06:08:53.0453676+00:00",
"code": "sample string 7"
},
"job_priority_id": "f86a0245-1c46-4dca-a84b-3bfcf1a5c167",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7ae5c65a-4259-4fa5-a3b1-2c662b90656b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "04fbfed5-ae0b-4bf9-aaf0-b8ffca142a80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T06:08:53.0453676+00:00"
},
"job_status_id": "14baf985-9aa9-49b5-90f0-829fad3e89d7",
"job_status_code": "sample string 11",
"db_address_id": "e33be45e-03a8-4445-9af4-c040b40cf3be",
"contact_id": "3564ed0b-4bb7-4e5f-bebf-1c4cee4448aa",
"requested_by_company_id": "825a3eeb-557d-450c-80b2-06dfee78aeee",
"requested_by_contact_id": "694f7914-84d1-40af-81a3-39252f8b8020",
"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-10-05T06:08:53.0453676+00:00",
"due_date": "2026-10-05T06:08:53.0453676+00:00",
"date_create": "2026-10-05T06:08:53.0453676+00:00",
"date_update": "2026-10-05T06:08:53.0453676+00:00",
"date_closed": "2026-10-05T06:08:53.0453676+00:00",
"suggested_user_id": "04f427e1-c1b9-4f83-b021-c5c0a5235b37",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a937b3e2-6d71-4159-bfbd-a51b3de36aaa",
"db_language_id": "834ee0ff-f4f7-49a7-834d-2b9457ac2b91",
"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-10-05T06:08:53.0453676+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "36193824-48d2-4394-8b38-e6889c288264",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1843e1ab-535b-4981-9819-5a37b7a895ad",
"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": "47c17ed4-2a75-4e6d-93ea-b21bb91c1532",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T06:08:53.0453676+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "549b4881-4583-4599-ad7b-af8eb80fe709"
},
"suggested_date_start": "2026-10-05T06:08:53.0453676+00:00",
"skill_id": "18cc05ca-16ad-4a50-9e3b-df38d9afa7ad",
"skill_code": "sample string 32",
"skill": {
"id": "3ab0edf5-b877-4e45-b3c8-75ad2c62e58b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "941f8c67-837d-42e1-94ec-870ab8edf7bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f979c80f-b523-4465-80e6-6014eef44b46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0745f93-187c-48b9-ad2f-488f492788ae",
"db_currency_id": "2733d533-0bc7-4d8a-9cbe-98043e86095a",
"db_language_id": "63cc6ffa-dda9-4480-ba57-1c3942907837",
"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-10-05T06:08:53.0140762+00:00"
},
"modified_dateutc": "2026-10-05T06:08:53.0616279+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ddfab57b-bb6c-45f5-9353-4d5a04e1ddec",
"date_reported_by_company": "2026-10-05T06:08:53.0616279+00:00",
"id2": 36,
"company_id": "00e300ff-fe35-4b26-bd9d-26c7ad4c1e97",
"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": "194b6bf7-2ebd-41c9-af9d-1e950755e229",
"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-10-05T06:08:53.0616279+00:00"
},
"work_instruction_details_id": "bd4e5dd2-c4ca-4f7b-89d0-f17eb515f2af",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e164bd61-6b9a-4d47-91aa-c97fb64aef89",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "899d661c-c93d-40f9-9ec5-659f73852021",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T06:08:53.0616279+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": "5ae41551-2249-4464-9e2d-a581c6edf522",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T06:08:53.0616279+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.