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": "d77c236a-14f9-4baa-8243-5bd5dfa8efa0",
"jobs_id": "866d9429-8110-4e98-92ca-8b0fa6436376",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "52507066-8a84-483b-a012-69f67a2bde04",
"_parent_id": "ad58a301-19b3-4053-8f3b-03dfd474ea53",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bb1a518d-a5f4-4535-90ca-8385ad19cdf6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0ce100d0-201e-40df-aeac-7078d1a466d3",
"_parent_id": "9cabd08f-4b29-47b1-978c-071fd8dfa382",
"root_parent_id": "6e7d9370-29c1-472f-acab-d92686d2c9f0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2fa570f2-769c-40e6-8d0b-ec4d177c7230",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7d13fbf1-9f4f-4e04-94c7-b7ec41a09154",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7c59b1e3-db7b-4e9e-a5f2-d3e0fb5fa1c0",
"_parent_code": "sample string 6",
"sales_organization_id": "83e9e7b4-841b-4dcb-bb44-ce1c17154956",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"modified_dateutc": "2025-11-10T07:45:30.4989521+00:00"
},
"equipment_model_id": "8acde472-1c88-438b-8d54-0eb813dfc1ce",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1bbba84b-cafd-437a-bf7a-0b98275711a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "20c7acea-53dc-4705-8767-2aebba7ca404",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8772cd13-3572-4fde-aaa7-8665cb28a720",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ff9498c6-1684-4f54-9847-2073a60db121",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00"
},
"equipment_family_id": "890af11e-771a-4d59-8269-1e2a63c5d52f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7d13fbf1-9f4f-4e04-94c7-b7ec41a09154",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7c59b1e3-db7b-4e9e-a5f2-d3e0fb5fa1c0",
"_parent_code": "sample string 6",
"sales_organization_id": "83e9e7b4-841b-4dcb-bb44-ce1c17154956",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"modified_dateutc": "2025-11-10T07:45:30.4989521+00:00"
},
"date_in_production_since": "2025-11-10T07:45:30.5145763+00:00",
"date_out_of_production_since": "2025-11-10T07:45:30.5145763+00:00",
"date_end_support": "2025-11-10T07:45:30.5145763+00:00",
"sales_organization_id": "291de765-a691-4306-90fd-2454ef6cb795",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+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": "2025-11-10T07:45:30.5145763+00:00"
},
"project_status_id": "d37ade3a-988f-42f7-9379-f60904cda812",
"project_status_code": "sample string 10",
"project_status": {
"id": "edda1555-1313-4511-b977-d85b8f417a1c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1dff8fe0-2d1b-4295-ba7b-1e8efc577c36",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00"
},
"company_id": "69eaeaf3-768e-45a2-adcf-b3e705f695c0",
"company_code": "sample string 12",
"db_address_id": "05f9ea53-a396-48cb-ac5d-e43335dc389e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ecddd2c9-1459-4997-8f57-2bcb5cd19e8f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c03dbc4e-2b76-4a19-a162-80e5059ee90a",
"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": "2025-11-10T07:45:30.5145763+00:00",
"date_create": "2025-11-10T07:45:30.5145763+00:00",
"date_update": "2025-11-10T07:45:30.5145763+00:00",
"updated_by_user_id": "cb565f7c-cc8a-47c5-a1fa-887618f34af9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-10T07:45:30.5145763+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": "2025-11-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-10T07:45:30.5145763+00:00",
"date_last_job": "2025-11-10T07:45:30.5145763+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-10T07:45:30.5145763+00:00",
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00",
"is_mobile_installation": true
},
"job_type_id": "c5dcba18-6173-4761-bf1b-0eea59e7bf43",
"job_type_code": "sample string 7",
"job_type": {
"id": "65495799-1cd0-42a4-993e-a6f003f04fbe",
"name": "sample string 2",
"sales_organization_id": "1e2a2f29-194d-4484-a081-f154f4b555a1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00",
"code": "sample string 7"
},
"job_priority_id": "1d772abd-a97c-40b7-afe2-fa9ecca8aeb4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ffe0ced6-b513-4733-8141-3883063276d4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "76d03121-c4f4-4cfb-8e60-3ed1e98c2f9f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00"
},
"job_status_id": "df3f0fda-9ed6-49b9-8266-ac408945ebdb",
"job_status_code": "sample string 11",
"db_address_id": "798069b1-c7d1-4088-a38c-f4e3b611d0ba",
"contact_id": "5a2e64c8-832b-4750-abd7-822daca6cc13",
"requested_by_company_id": "654ff465-4f24-4b79-8bf1-5201d408127e",
"requested_by_contact_id": "b286aa66-4fec-49ac-93f0-9c12922a9696",
"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": "2025-11-10T07:45:30.5145763+00:00",
"due_date": "2025-11-10T07:45:30.5145763+00:00",
"date_create": "2025-11-10T07:45:30.5145763+00:00",
"date_update": "2025-11-10T07:45:30.5145763+00:00",
"date_closed": "2025-11-10T07:45:30.5145763+00:00",
"suggested_user_id": "871aadff-3874-4940-83d0-a0f7e7ecb991",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fc01139a-acf5-45d8-a555-1789d4bd997e",
"db_language_id": "c590a664-037d-42f7-8f02-39f906b6d9e7",
"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": "2025-11-10T07:45:30.5145763+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "21c42a86-5f11-431b-8c05-9e52223ea24c",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f848692e-30b4-423a-9f6a-244b015c773b",
"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": "e1b36bd7-34f5-4d8d-8763-edd20aef4525",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8ec95d5f-641b-4dbf-a0d5-cdcdf7fb77b8"
},
"suggested_date_start": "2025-11-10T07:45:30.5145763+00:00",
"skill_id": "f89ab8d2-1fea-4f4a-a37a-cfe9c1ca23d0",
"skill_code": "sample string 32",
"skill": {
"id": "879dd056-96cf-4518-9727-7de8fa393c36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b47bb34a-1ef3-4265-a108-3bc42a15db44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aff40b31-a549-4b5a-9a3c-972d0e0c7354",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c902508-35ae-4587-bc3c-d6e796fead7c",
"db_currency_id": "ebd40bbb-5b93-4dc8-ae42-70cff3df54e1",
"db_language_id": "df9e36c5-ac6c-46ce-a943-f0d54c120f4b",
"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": "2025-11-10T07:45:30.4989521+00:00"
},
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f16b0e5b-ff07-4fa3-a95f-aef7204499b1",
"date_reported_by_company": "2025-11-10T07:45:30.5145763+00:00",
"id2": 36,
"company_id": "1030a554-eff9-4cc2-a62f-737cae3a11b4",
"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": "5b8d730a-28a7-44b8-94db-fc283fff314d",
"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": "2025-11-10T07:45:30.5145763+00:00"
},
"work_instruction_details_id": "c34eb560-a33a-4660-b2dc-630fd43c5c17",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8f1e9a9b-bb1d-4f35-81c1-032d5e02c0d0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1c83937c-16b1-440a-8de9-c7c17c2c1b10",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-10T07:45:30.5145763+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": "ddeae92d-9a2c-4acd-aab8-3cbb88941614",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-10T07:45:30.5145763+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.