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": "f9777482-c8f5-4a27-ae09-6a3dfb2dd465",
"jobs_id": "0a080ea8-61d2-4e34-9509-bd9ea5a6d756",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9340806d-5222-4f9f-b431-657990f6022a",
"_parent_id": "183d4d1e-6133-4d3d-b404-ba5d0d40ef09",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8258711e-0c80-436c-9c79-7ef6b6f518ca",
"project_reference_back_office": "sample string 5",
"project": {
"id": "27626a4c-61c6-4105-ac27-966f43e63309",
"_parent_id": "903a9ff5-51ea-4801-a944-66cefbfa6a82",
"root_parent_id": "10d71044-b6cd-4b88-ab7d-2b0ddc1e3698",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fd53cd6a-a26f-4ff0-a847-f9164553d7b4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d4df964e-056c-469a-9974-b766f340bb09",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9eccfa13-87b7-4b53-a2ac-2cb8e927c490",
"_parent_code": "sample string 6",
"sales_organization_id": "031868a6-126b-466f-b7ca-a9944baaab2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"modified_dateutc": "2026-01-25T12:30:24.7292236+00:00"
},
"equipment_model_id": "9f512805-21f9-49ce-abc9-297185ef007e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2ae8d023-2cdb-42ea-a47d-77e5be5608ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "642ea0d8-1c10-4c39-afd8-c63f68882a91",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3a57b7ab-7300-4784-97e4-81e15bf30c51",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f484b1f6-f8c4-4cbd-bc3e-f87a7dcac537",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"modified_dateutc": "2026-01-25T12:30:24.7292236+00:00"
},
"equipment_family_id": "6e71a4e0-5dcb-42e2-91ea-f27fd6b181fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d4df964e-056c-469a-9974-b766f340bb09",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9eccfa13-87b7-4b53-a2ac-2cb8e927c490",
"_parent_code": "sample string 6",
"sales_organization_id": "031868a6-126b-466f-b7ca-a9944baaab2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"modified_dateutc": "2026-01-25T12:30:24.7292236+00:00"
},
"date_in_production_since": "2026-01-25T12:30:24.7292236+00:00",
"date_out_of_production_since": "2026-01-25T12:30:24.7292236+00:00",
"date_end_support": "2026-01-25T12:30:24.7292236+00:00",
"sales_organization_id": "a980730e-c497-4526-a685-596df60bfbca",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+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-01-25T12:30:24.7292236+00:00"
},
"project_status_id": "98ccf79f-19ad-461d-a5ef-636b56b70377",
"project_status_code": "sample string 10",
"project_status": {
"id": "3080517b-2887-425a-91f4-2b92de5c3af8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "91792e48-db8e-4da5-be3d-04d65d991ff7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T12:30:24.7292236+00:00"
},
"company_id": "4b99dc54-b9d2-470f-a511-8459aed0af95",
"company_code": "sample string 12",
"db_address_id": "ffaeefee-f5bf-4ec3-a8b8-7846092c71f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a74168cd-4fed-43e3-b808-245155f7db2d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ae9529d1-8f36-4a43-9438-63201997505b",
"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-01-25T12:30:24.7292236+00:00",
"date_create": "2026-01-25T12:30:24.7292236+00:00",
"date_update": "2026-01-25T12:30:24.7292236+00:00",
"updated_by_user_id": "26cb17fd-81e5-4bc6-adc6-fc5cff52a040",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-25T12:30:24.7292236+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-01-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-25T12:30:24.7448483+00:00",
"date_last_job": "2026-01-25T12:30:24.7448483+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-25T12:30:24.7448483+00:00",
"modified_dateutc": "2026-01-25T12:30:24.7448483+00:00",
"is_mobile_installation": true
},
"job_type_id": "fd0881bd-4363-406d-baa8-8c9d6b66caf6",
"job_type_code": "sample string 7",
"job_type": {
"id": "30015551-2db9-47c6-b217-360048ffcf96",
"name": "sample string 2",
"sales_organization_id": "b4938433-528d-4768-9718-fc05c034d18c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-25T12:30:24.7448483+00:00",
"code": "sample string 7"
},
"job_priority_id": "44a8f08d-66dc-4e1e-ad8d-da6981988691",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d627e91d-e1c0-459e-b1f9-2037c7b5742a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d19c16a5-f1fe-4b06-b88a-c5aae9039560",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T12:30:24.7448483+00:00"
},
"job_status_id": "39bb2ed0-2c2e-480c-8517-f5ce911274c4",
"job_status_code": "sample string 11",
"db_address_id": "a8895047-b04f-43b6-b9d3-893867092094",
"contact_id": "60a72bf4-a061-4d90-b96d-97d705d656f8",
"requested_by_company_id": "a7c695b4-a4f0-4d2c-8715-986088244207",
"requested_by_contact_id": "88716677-655b-4b48-a395-9d31602c5b8f",
"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-01-25T12:30:24.7448483+00:00",
"due_date": "2026-01-25T12:30:24.7448483+00:00",
"date_create": "2026-01-25T12:30:24.7448483+00:00",
"date_update": "2026-01-25T12:30:24.7448483+00:00",
"date_closed": "2026-01-25T12:30:24.7448483+00:00",
"suggested_user_id": "efb42fd2-3aa1-4c40-a505-6df94a90ae92",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bd4030c3-2a5a-4914-ad2f-074c5553c774",
"db_language_id": "84614def-0945-41a4-bfff-d53fb6ca801f",
"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-01-25T12:30:24.7448483+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a3427ddb-6ef5-462b-a442-3848674ec5ee",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cb88fd28-9f35-47e9-8364-25e253197ce8",
"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": "d6e532a2-0902-49e9-afe8-89452bd8f6e5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-25T12:30:24.7448483+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ef403271-e8c0-46ae-9202-3a68c5846bca"
},
"suggested_date_start": "2026-01-25T12:30:24.7448483+00:00",
"skill_id": "826f4aad-d657-42e4-925d-fc621ddb88ad",
"skill_code": "sample string 32",
"skill": {
"id": "143947af-c93f-4913-a557-276b5cf3775f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b4605795-b1c5-4910-8b7a-fe87f1dc03e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f33f95a4-ca23-476c-84cd-4cd119a655f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99f0303-721f-4b94-9081-9d35095f1f0e",
"db_currency_id": "ab72ce1a-26d3-49ae-9c9f-3cae7b735a36",
"db_language_id": "3309091e-39c8-4ca4-9f09-6989a9a17b99",
"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-01-25T12:30:24.7292236+00:00"
},
"modified_dateutc": "2026-01-25T12:30:24.7448483+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "acd19d3b-c2a7-4c3b-84a5-f927d8f0423e",
"date_reported_by_company": "2026-01-25T12:30:24.7448483+00:00",
"id2": 36,
"company_id": "d61233d4-2d9b-499e-bfa3-b1258493a82e",
"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": "c4987c0c-1cee-4b4d-b091-097d039db1a2",
"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-01-25T12:30:24.7448483+00:00"
},
"work_instruction_details_id": "8fb13f11-8537-4646-8e44-aa53f1bc3f45",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "976345ac-471e-4076-9093-205b940ca960",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5189307c-445f-435b-97cd-52baa05307d8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-25T12:30:24.7448483+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": "ae5b5bcb-649d-4367-b751-a3008e2c782b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-25T12:30:24.7448483+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.