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": "2322d021-5449-4439-8253-9b2c31d64266",
"jobs_id": "7dcc6ba7-ed57-4b88-856e-03869bdd3f9d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d48fd2c-af37-442e-aeb0-b5740620d5b4",
"_parent_id": "caf014b2-4e15-42ed-9f2b-4386669756ef",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "07da30fd-dadf-4f77-a586-6ab7c9802bf6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2d6aa33f-cb5c-4a41-96eb-56b887a75ffe",
"_parent_id": "be430ac1-7fa0-4bf2-9875-5022b2d43c56",
"root_parent_id": "1d31598f-467a-47f3-9cd4-87e5530624e5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e012508-cfc9-44b1-88ec-b70decdebf61",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f7448100-3e74-400b-8b14-4c9ec9b136a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d99ceb69-42ce-4e06-81fc-47c6efc71e58",
"_parent_code": "sample string 6",
"sales_organization_id": "91fd3687-7daa-48d1-b52c-96fad40ea3b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
},
"equipment_model_id": "2c69020c-c832-461a-af7e-447461936799",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a9b6fe41-2ecb-427a-a30a-9e17a2d2ef0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "96e74baa-5457-4c96-8003-9e3bf1fc825c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "498e765e-7dcc-47b9-a902-07ac663a9fc3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ab3b0ae5-a85e-4972-8c4e-9838dc622a6b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
},
"equipment_family_id": "0f1f7f09-8039-43ac-becc-3793ec73c6d8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f7448100-3e74-400b-8b14-4c9ec9b136a7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d99ceb69-42ce-4e06-81fc-47c6efc71e58",
"_parent_code": "sample string 6",
"sales_organization_id": "91fd3687-7daa-48d1-b52c-96fad40ea3b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
},
"date_in_production_since": "2025-12-23T20:23:42.5509274+00:00",
"date_out_of_production_since": "2025-12-23T20:23:42.5509274+00:00",
"date_end_support": "2025-12-23T20:23:42.5509274+00:00",
"sales_organization_id": "46e5f62a-618d-451e-b363-b72f7d7197ad",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+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-12-23T20:23:42.5509274+00:00"
},
"project_status_id": "e4f97e7c-daeb-4e5b-ab89-ee23f1d74e65",
"project_status_code": "sample string 10",
"project_status": {
"id": "27389758-90d7-4b9d-bd19-2cf962633723",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4c5d5e5f-f3cc-4170-8ccd-a1b5704dd145",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
},
"company_id": "3359cdfc-ab88-4f2e-887e-31e07ecec975",
"company_code": "sample string 12",
"db_address_id": "f139d5d3-13d9-4aca-b7d5-cc9f304e5c95",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d50a33d0-b302-4e02-94e7-38d1431d0c36",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1665719c-7270-4aa9-980c-72667f7a8426",
"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-12-23T20:23:42.5509274+00:00",
"date_create": "2025-12-23T20:23:42.5509274+00:00",
"date_update": "2025-12-23T20:23:42.5509274+00:00",
"updated_by_user_id": "b9be7267-2ef1-4e4b-befe-a60638e52abc",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T20:23:42.5509274+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-12-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T20:23:42.5509274+00:00",
"date_last_job": "2025-12-23T20:23:42.5509274+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T20:23:42.5509274+00:00",
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00",
"is_mobile_installation": true
},
"job_type_id": "68535acf-0d83-4498-8233-935f908a3928",
"job_type_code": "sample string 7",
"job_type": {
"id": "43f8f2e3-4e01-441a-832f-7aa89ed5a01a",
"name": "sample string 2",
"sales_organization_id": "2dc4f346-0554-4bc7-a782-268d9eba5a22",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00",
"code": "sample string 7"
},
"job_priority_id": "687621bc-7fa4-4dca-9f81-7878228f155c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2dc69b9d-46c3-4ffb-b4b5-aff69e277c7a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d3d0c71-5938-47c2-b2e0-ac315d4e664f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
},
"job_status_id": "26777d88-50af-430b-8f1b-4ad7af270f9d",
"job_status_code": "sample string 11",
"db_address_id": "497b184d-9736-4f3e-aea9-669298b2fbed",
"contact_id": "5b8007d5-4fa1-4220-ba2b-31d664dfc99b",
"requested_by_company_id": "b08d5e77-ee1b-4a92-a440-62694f5a56d5",
"requested_by_contact_id": "df181536-b850-452d-86c2-ddb529d8563b",
"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-12-23T20:23:42.5509274+00:00",
"due_date": "2025-12-23T20:23:42.5509274+00:00",
"date_create": "2025-12-23T20:23:42.5509274+00:00",
"date_update": "2025-12-23T20:23:42.5509274+00:00",
"date_closed": "2025-12-23T20:23:42.5509274+00:00",
"suggested_user_id": "cb580143-b495-4761-a8d7-b8342622f65e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "da7f9177-7be7-4fb9-8709-4999e4704f10",
"db_language_id": "f5db18bd-3203-4201-b31b-0ac962fd9e0b",
"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-12-23T20:23:42.5509274+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6310be1c-5bfa-4613-ae76-78b461d88724",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "88a8d99b-f1c1-4afb-840d-6c640213e3dd",
"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": "0a3ce079-697e-4fd7-b088-885431c151cf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "90e554ff-a9c5-4e8d-a1a0-638ea7eadc3f"
},
"suggested_date_start": "2025-12-23T20:23:42.5509274+00:00",
"skill_id": "a3aa8859-540c-49c0-b415-25e4f291abcf",
"skill_code": "sample string 32",
"skill": {
"id": "88cede20-fb57-46e7-92ef-803c28256aaa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d05f2b8-47e1-49c1-8c4a-d9b0360e6c6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00a6e350-6697-4e04-865a-5e158abbf44c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f65533c-3f2e-468f-96ec-f03befc923a6",
"db_currency_id": "f83c8bb2-1c57-4a8d-a718-d5d8c03c474c",
"db_language_id": "80af310c-4587-4361-8273-2f15f24532d5",
"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-12-23T20:23:42.5509274+00:00"
},
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "07ab6694-cedf-4cd1-b0a3-e5d71ff8da9d",
"date_reported_by_company": "2025-12-23T20:23:42.5509274+00:00",
"id2": 36,
"company_id": "9e995015-c963-494b-852f-7c41331c9842",
"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": "1bead397-6892-4b05-b1d2-99a2501ab4ac",
"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-12-23T20:23:42.5509274+00:00"
},
"work_instruction_details_id": "d5fdf203-b96d-446f-8c3c-032d3e9ea9fd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "875cce44-2607-4ec8-a2f4-8a6f0736bb1a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5d5c1ca2-729b-43c6-9d6e-286f58be914a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-23T20:23:42.5509274+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": "5d1bebd6-ab84-47f4-a046-be45d0852037",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-23T20:23:42.5509274+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.