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": "5bf95478-37ec-4e1e-9cd4-5d580c4fdc34",
"jobs_id": "bd0d3b26-b172-486a-a715-bdf90ee277c1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eeccce05-2c00-486f-a9ad-31c90d7c8902",
"_parent_id": "274a0dc6-781a-474a-ae2c-03ab43ec34e7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8e14ea54-1379-470e-9368-b0d64aafdd96",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04981994-35b2-410a-b2bc-31fa6dce5f71",
"_parent_id": "f862a94c-a42d-4061-ad99-813647ece5d1",
"root_parent_id": "27c0e0d4-07d5-4c3f-9aae-276d33e122f5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "778fe319-1d58-481b-9f0d-10ef7a890123",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f53b3185-5e4a-4267-985d-cf651df8448d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e0495a1-f8ab-4169-a725-bbee307bbe0e",
"_parent_code": "sample string 6",
"sales_organization_id": "0f906326-c3de-449a-9ec7-e54d8b6a9c32",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
},
"equipment_model_id": "dc788214-56d1-436b-854b-b5d217045a78",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b97dd609-47e1-4c14-89e3-ba47d20d31f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b92471e4-3fba-4674-8897-aaf3da5cb8ba",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "018170fc-91f1-42d9-8a76-d0319e7be4bc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d8ba58d7-d1a9-403d-8f37-7aa8c3c41e0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
},
"equipment_family_id": "82fed704-7437-47fc-9e1c-e31f1e2e282b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f53b3185-5e4a-4267-985d-cf651df8448d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e0495a1-f8ab-4169-a725-bbee307bbe0e",
"_parent_code": "sample string 6",
"sales_organization_id": "0f906326-c3de-449a-9ec7-e54d8b6a9c32",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
},
"date_in_production_since": "2026-08-04T23:13:43.0470385+00:00",
"date_out_of_production_since": "2026-08-04T23:13:43.0470385+00:00",
"date_end_support": "2026-08-04T23:13:43.0470385+00:00",
"sales_organization_id": "84296f89-22b8-4407-9bf8-aa43ddf0064e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+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-08-04T23:13:43.0470385+00:00"
},
"project_status_id": "56cd8e28-8ff1-4962-b9e7-8f0c1abcfba8",
"project_status_code": "sample string 10",
"project_status": {
"id": "f8e973a1-9811-4f85-a0ac-da0e6d402d05",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6226e873-c2a2-455c-ae50-dacac9eaf786",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
},
"company_id": "bbf437e9-50e3-499f-93e6-5fec7a8a1ce9",
"company_code": "sample string 12",
"db_address_id": "3d43cbd9-827b-4a98-a9a2-d699831da759",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "53603342-245d-4db9-9f9b-747c6409c169",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f06002e4-8093-4460-a19d-d4cd4b74ad2a",
"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-08-04T23:13:43.0470385+00:00",
"date_create": "2026-08-04T23:13:43.0470385+00:00",
"date_update": "2026-08-04T23:13:43.0470385+00:00",
"updated_by_user_id": "b3cc85e2-6429-4b88-a9fb-1e4663f1b902",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-04T23:13:43.0470385+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-08-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-04T23:13:43.0470385+00:00",
"date_last_job": "2026-08-04T23:13:43.0470385+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-04T23:13:43.0470385+00:00",
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00",
"is_mobile_installation": true
},
"job_type_id": "868b3f65-7317-4f7f-96aa-06557f35a228",
"job_type_code": "sample string 7",
"job_type": {
"id": "38402c8b-921e-491d-bacd-07621444f67d",
"name": "sample string 2",
"sales_organization_id": "bbf13f69-ebb4-40f3-bc78-d23bf4243c17",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00",
"code": "sample string 7"
},
"job_priority_id": "635076ea-1b75-4c9e-ad83-fc698dc381bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "edfb4de8-6676-4866-8438-857dab35d358",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8b3aae31-bc08-487b-b326-4464df92e139",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
},
"job_status_id": "67f41d10-edb6-42e0-b2b1-bca2f42f5696",
"job_status_code": "sample string 11",
"db_address_id": "25df369a-05d9-4fff-b249-f60aea5f7074",
"contact_id": "73efd146-d3e9-462a-8587-c91bb98f73cf",
"requested_by_company_id": "595fded2-387b-4dac-bc80-2c5cefad6249",
"requested_by_contact_id": "e8c59c27-598a-49fe-9b99-3bafe943495f",
"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-08-04T23:13:43.0470385+00:00",
"due_date": "2026-08-04T23:13:43.0470385+00:00",
"date_create": "2026-08-04T23:13:43.0470385+00:00",
"date_update": "2026-08-04T23:13:43.0470385+00:00",
"date_closed": "2026-08-04T23:13:43.0470385+00:00",
"suggested_user_id": "6a119845-432d-4c32-a4ff-693c97b9ec6f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "259ce526-95f9-41ea-a54c-2eb86f349e58",
"db_language_id": "1f97f1f9-814f-496a-8bbd-852035624691",
"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-08-04T23:13:43.0470385+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1733cafc-9be4-4670-b7a3-9978ca147d0e",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "855d95f8-afd2-4cca-b3bf-60b80da09a34",
"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": "eb3e225f-0ae0-4676-ac05-f6ce3590e7ab",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "53cb51d6-7b54-4ecd-ab39-4d9e941510ff"
},
"suggested_date_start": "2026-08-04T23:13:43.0470385+00:00",
"skill_id": "5c208e7a-56e3-4536-94b0-d240406b473a",
"skill_code": "sample string 32",
"skill": {
"id": "cdda1790-8c09-4469-921a-55eeea8a1500",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c436f310-c812-4fcc-93f6-c6a149f6e985",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3ac65884-ce5e-4759-b7b3-a221be8c188c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b97632e-eae4-44d6-bca6-7514f5700ccf",
"db_currency_id": "afe1aa5c-e58a-430a-ac88-eeb748b238ea",
"db_language_id": "bba976a8-3beb-4dd3-860a-36a683adce45",
"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-08-04T23:13:43.0470385+00:00"
},
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "25631194-27d4-4096-a758-75b54adadc9e",
"date_reported_by_company": "2026-08-04T23:13:43.0470385+00:00",
"id2": 36,
"company_id": "cbb5361b-0fda-4879-aef2-4f3816d8b5b1",
"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": "7563b27e-30cd-4c4e-9bfc-8d4cb30ffd43",
"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-08-04T23:13:43.0470385+00:00"
},
"work_instruction_details_id": "88f822f8-f02d-44f6-97b2-94ef34f1028d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cf973b90-c13a-4973-ae41-0e41f47d03ae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0062caf9-2928-4a56-bee5-84cb38e18c6d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-04T23:13:43.0470385+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": "e7b52c7e-58c5-4eb7-944e-3c4f3f7f1ba9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-04T23:13:43.0470385+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.