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": "0b90764a-7da7-45cc-b74d-2967fa7ff526",
"jobs_id": "268788c7-4d2d-4753-9ebb-e3343dfac239",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2c5eb8d2-dbbc-4f56-b8b0-775a0e121c60",
"_parent_id": "0809fc54-dc95-4bed-be53-6744f4744c3d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f876294a-d5bf-4e8e-b96b-fa0a8876de4d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7ce28970-6574-4a26-b68c-ec0e1cd516d8",
"_parent_id": "450c3025-64ac-4a25-90a4-564f264b659c",
"root_parent_id": "3b1aaad3-82c3-42a4-9413-99435158ad4e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b4b50cbd-b649-4b47-bc87-3e9261bcd15f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "43b2835f-e89c-421e-86ff-8f4e739ffe26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "53b81a73-8767-4288-ad9a-a13fc158412b",
"_parent_code": "sample string 6",
"sales_organization_id": "0fa3b404-8815-4905-96a2-8e9c3a07c73a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
},
"equipment_model_id": "3206a4a9-2334-47f4-bd84-4190d551dafb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b28226ad-7e2a-4355-a201-9739794f72f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d8befeeb-832a-4af6-8e06-3664ca6724df",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e1457c99-d36d-4102-8d53-f0cac35b4c02",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1841d874-dac4-4c2c-9a84-a0676d630951",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
},
"equipment_family_id": "973adec3-03da-40b6-8f86-9c5109e9b360",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "43b2835f-e89c-421e-86ff-8f4e739ffe26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "53b81a73-8767-4288-ad9a-a13fc158412b",
"_parent_code": "sample string 6",
"sales_organization_id": "0fa3b404-8815-4905-96a2-8e9c3a07c73a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
},
"date_in_production_since": "2026-06-07T06:40:51.9373954+00:00",
"date_out_of_production_since": "2026-06-07T06:40:51.9373954+00:00",
"date_end_support": "2026-06-07T06:40:51.9373954+00:00",
"sales_organization_id": "97aab346-b01f-48a2-8e34-de974343e7ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+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-06-07T06:40:51.9373954+00:00"
},
"project_status_id": "848f103b-3db9-4610-b09a-336aa721d5da",
"project_status_code": "sample string 10",
"project_status": {
"id": "f3616895-79e8-4f3f-a199-741b8310a212",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ef0f2aec-2806-45f8-b07e-814bf29111d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
},
"company_id": "d90e23de-79a4-4f9d-90cc-8e694722c7e0",
"company_code": "sample string 12",
"db_address_id": "6140a077-236f-4550-a9fc-6f26fc0c6db3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5ec46e5c-e20f-4508-8b16-7fef7ab9d971",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "86372d76-a0c8-4b1a-8ef1-8d7f195f501d",
"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-06-07T06:40:51.9373954+00:00",
"date_create": "2026-06-07T06:40:51.9373954+00:00",
"date_update": "2026-06-07T06:40:51.9373954+00:00",
"updated_by_user_id": "28ca83c1-208a-4ab6-ab79-a1410d52e494",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-07T06:40:51.9373954+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-06-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-07T06:40:51.9373954+00:00",
"date_last_job": "2026-06-07T06:40:51.9373954+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-07T06:40:51.9373954+00:00",
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00",
"is_mobile_installation": true
},
"job_type_id": "78e21ad0-ed9c-4192-b0da-be81c9470a73",
"job_type_code": "sample string 7",
"job_type": {
"id": "559d511b-f18f-46e0-891f-ac63cf31c3a9",
"name": "sample string 2",
"sales_organization_id": "7623127f-32fc-4e7c-ae50-587c27b92903",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00",
"code": "sample string 7"
},
"job_priority_id": "1a7ed202-eff2-4dbc-8771-f3116d96a1d1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "60007c14-90ff-4666-bb22-b87c5fee1d3c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6085fb2d-5e8f-45df-9f4f-006fc5408800",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
},
"job_status_id": "7fe2250a-c814-4bf6-88b3-7b9c188da732",
"job_status_code": "sample string 11",
"db_address_id": "4b56cb7e-c2a7-4218-b9a3-0d6948b1d727",
"contact_id": "b09230fb-1250-4e83-80b2-8abb99a707cc",
"requested_by_company_id": "e0a8bd48-7f39-48af-a8b6-e119264855ae",
"requested_by_contact_id": "9f9d7446-f29a-4eb5-8cac-f94ee41edd2d",
"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-06-07T06:40:51.9373954+00:00",
"due_date": "2026-06-07T06:40:51.9373954+00:00",
"date_create": "2026-06-07T06:40:51.9373954+00:00",
"date_update": "2026-06-07T06:40:51.9373954+00:00",
"date_closed": "2026-06-07T06:40:51.9373954+00:00",
"suggested_user_id": "6dc85e6d-d3d5-4376-84ea-86ec61699159",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0c8b39e3-d54e-49db-a16d-91d54b839911",
"db_language_id": "fe434840-eb7a-44c6-bc31-48ce2dfff4b2",
"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-06-07T06:40:51.9373954+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ef4a204e-e354-4d4c-8781-517a9fe49a61",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "26c18cc4-d8e2-4416-afd1-2dca6b3faba2",
"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": "b1a3bf37-f37c-430f-a285-03800f22e2ed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5fda7704-822b-479c-ad82-16ad53a71642"
},
"suggested_date_start": "2026-06-07T06:40:51.9373954+00:00",
"skill_id": "91b177cb-cb50-40f7-ae0a-f9fbf2042212",
"skill_code": "sample string 32",
"skill": {
"id": "93e5afbf-1f27-40da-a8c0-68e016b07585",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a21609d1-c5ff-4ea4-8957-cb0ad3a19d38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "42b5f214-e6cf-4e09-a4f5-06b4147a2a68",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "919494d0-0da5-40ff-9fce-4c2b6a059eb6",
"db_currency_id": "68e11be5-d134-4c1a-b3d0-0e8a9754707c",
"db_language_id": "866b5396-e618-4f0d-8a34-5c33b1eb57ae",
"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-06-07T06:40:51.9373954+00:00"
},
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "14d1316e-0d2f-43cb-928b-8af9f81e28e6",
"date_reported_by_company": "2026-06-07T06:40:51.9373954+00:00",
"id2": 36,
"company_id": "4e118992-89e7-4601-99af-4c18b8a91b0f",
"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": "5670e0fd-e7f0-402a-9a59-ebc218fba8c0",
"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-06-07T06:40:51.9373954+00:00"
},
"work_instruction_details_id": "76c10af2-61bc-45e8-8f93-425564fe5e00",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e365e54-53e7-4ee2-80c1-ca80c122bd12",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e8199426-856a-4f3f-8db4-87e12a91bbff",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-07T06:40:51.9373954+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": "0bb51c94-7c3c-4a7c-91a8-6f6a0933ab5a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-07T06:40:51.9373954+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.