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": "c8169a78-0d74-4fd2-a858-3efb7f11a249",
"jobs_id": "6cbb6c80-3bbe-4463-9c3a-bb5cadde6484",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "16003020-1715-4922-8c46-b1de8390881a",
"_parent_id": "ef94d90a-e7b8-4df0-9358-8d984fed739c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d84f8378-7c7e-4135-bb48-77b7793880c9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "31cfe062-2341-4b69-8991-8224ed1d4dbf",
"_parent_id": "c8717ad4-5216-4473-a523-e045855c0896",
"root_parent_id": "c1557971-1f63-40dc-a7cb-8ad262d25349",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e4398a17-95f1-4074-a886-f2b3dbf32914",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dbbd8ec5-7d00-47cd-acd1-1a8171cd5c39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "65d0345b-98f8-46f3-9ae9-bb3ee547ced0",
"_parent_code": "sample string 6",
"sales_organization_id": "c58896fa-0932-40f2-8bef-7e7b270f9e42",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
},
"equipment_model_id": "67ac9d2c-cd34-4cb5-97b9-5f0c4d205b34",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b92307b3-4641-48ba-b488-b586baf440e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "851e4bf7-abfb-42cb-a1c6-2305b22e90e7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "71dea7ce-e529-49ae-b822-ea9e35279c45",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b0930f40-09ff-4a03-a0a1-14f77c6a0ab4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
},
"equipment_family_id": "4b346e85-9c53-4de6-80bf-f6a773f0a5da",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dbbd8ec5-7d00-47cd-acd1-1a8171cd5c39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "65d0345b-98f8-46f3-9ae9-bb3ee547ced0",
"_parent_code": "sample string 6",
"sales_organization_id": "c58896fa-0932-40f2-8bef-7e7b270f9e42",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
},
"date_in_production_since": "2026-09-12T18:07:52.0607563+00:00",
"date_out_of_production_since": "2026-09-12T18:07:52.0607563+00:00",
"date_end_support": "2026-09-12T18:07:52.0607563+00:00",
"sales_organization_id": "823ec4e7-cd1f-495e-a978-7301b907dd6f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+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-09-12T18:07:52.0607563+00:00"
},
"project_status_id": "3104b6fd-1253-4475-a412-bdea4a72ba54",
"project_status_code": "sample string 10",
"project_status": {
"id": "703a0d48-6ca6-4666-aa8e-9d69f8aeb1d9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "baba8f37-8b66-4fbf-a696-f5246d4bfb2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
},
"company_id": "db99ef2b-cf29-4cde-9e4b-e07a430dab7a",
"company_code": "sample string 12",
"db_address_id": "046c51d4-3e78-4651-8fde-eb66e6f6331a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8dbb6771-1f9d-4f67-96ba-622905a8f2e0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "999bf643-7a49-47e3-a1ff-0b3595fad308",
"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-09-12T18:07:52.0607563+00:00",
"date_create": "2026-09-12T18:07:52.0607563+00:00",
"date_update": "2026-09-12T18:07:52.0607563+00:00",
"updated_by_user_id": "530fcab5-4d88-45fb-bacc-86a8d533b631",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-12T18:07:52.0607563+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-09-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-12T18:07:52.0607563+00:00",
"date_last_job": "2026-09-12T18:07:52.0607563+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-12T18:07:52.0607563+00:00",
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00",
"is_mobile_installation": true
},
"job_type_id": "886c8e78-841e-409d-beef-bb7422501749",
"job_type_code": "sample string 7",
"job_type": {
"id": "6efca98a-a8de-45db-8593-15ecae2dc922",
"name": "sample string 2",
"sales_organization_id": "36bb35ba-405b-4983-b06a-ec08e27a6665",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00",
"code": "sample string 7"
},
"job_priority_id": "da09c006-de46-43d8-b861-17eebc443c57",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "407af3a1-6259-4266-9230-76369f83bd91",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d2c21af0-1c2e-4cac-8566-a940ed84fa2c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
},
"job_status_id": "8c06fcb4-6d17-42ae-a819-50ff825e8c9b",
"job_status_code": "sample string 11",
"db_address_id": "96472645-d8c4-4530-8b16-ed775b7e0c4a",
"contact_id": "1c21c913-9e4a-41bd-bd06-3b4f15e07259",
"requested_by_company_id": "c32ddc51-d3d3-4d50-8537-ddf14d80ac53",
"requested_by_contact_id": "9062fa9a-9f4d-4085-826c-d86ea16e24f2",
"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-09-12T18:07:52.0607563+00:00",
"due_date": "2026-09-12T18:07:52.0607563+00:00",
"date_create": "2026-09-12T18:07:52.0607563+00:00",
"date_update": "2026-09-12T18:07:52.0607563+00:00",
"date_closed": "2026-09-12T18:07:52.0607563+00:00",
"suggested_user_id": "dec72288-1057-4f85-ab71-2bed1b5db1fc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cd452112-1f62-4e9c-946e-659cfdeb2686",
"db_language_id": "475c9fd7-22e3-4a3f-bd00-12cb54ea43c8",
"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-09-12T18:07:52.0607563+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "05167db4-df76-4d62-bad0-e51bfae8db32",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "10606012-e84b-41d7-b669-ebccc25b87c1",
"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": "a3787b6f-1dc4-4d3a-9222-6620e23bd1ed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "18909e27-2cf1-4734-9a30-b8963d90c2f0"
},
"suggested_date_start": "2026-09-12T18:07:52.0607563+00:00",
"skill_id": "ac9ccb6b-b621-4eba-8455-d91b4b9d469e",
"skill_code": "sample string 32",
"skill": {
"id": "dc63c283-543a-4c9f-8f06-df47d5afd04a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0d10f16f-6c62-4e2d-9305-23a086c453f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91b7329a-981a-4937-8a33-3deab3f79cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fdb0f73-d732-4ed5-9a2b-50d6cef04ba2",
"db_currency_id": "d99c005b-43bc-4020-9d96-de61cb480a6f",
"db_language_id": "66eeae28-35e2-4246-9b15-9075d942ebbc",
"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-09-12T18:07:52.0607563+00:00"
},
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "258bdd7a-470e-49a0-a353-e9989a98f054",
"date_reported_by_company": "2026-09-12T18:07:52.0607563+00:00",
"id2": 36,
"company_id": "a3847350-1315-462b-8e1f-63e13783243f",
"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": "40b29da8-76b4-4f3d-b760-fba0eea50dea",
"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-09-12T18:07:52.0607563+00:00"
},
"work_instruction_details_id": "bace6d5d-1aeb-4304-bf8a-38e3c9459976",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5cfeceac-d7af-49d4-9c74-c2644cff8a44",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7d5efc69-4702-43d9-b264-eb2a7107724e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-12T18:07:52.0607563+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": "f87bbca1-afc6-41e0-8823-2d3e2faa830e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-12T18:07:52.0607563+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.