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": "eefee76e-ec6e-436e-9aef-397bff8f0e55",
"jobs_id": "e1638836-74a1-4dd4-bca0-e8e23db964df",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "92ec31f7-289b-4486-a720-a681418cdb14",
"_parent_id": "c785f206-c5ea-4654-9bf5-d1ee8f681d29",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "60783251-af2d-4985-9fc1-f15dd7760d76",
"project_reference_back_office": "sample string 5",
"project": {
"id": "124c7dd1-2822-4efe-b63c-057ed4381147",
"_parent_id": "032f48b3-c9db-47a9-8014-bdbb273c72d5",
"root_parent_id": "4256a73d-4bf3-4c42-9964-1160b05eee27",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "72aca006-2423-468f-a83a-2b38ee04796d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "91c043e5-7e54-46c7-ba51-600511062c01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17c18813-52f4-4802-b5bd-e38435bb5b45",
"_parent_code": "sample string 6",
"sales_organization_id": "47212e2b-eea8-41ff-80ec-1df0870df990",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"modified_dateutc": "2025-11-22T18:01:05.3070881+00:00"
},
"equipment_model_id": "832191ac-ac60-417a-a0e4-62c82fd0e4bb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "213215bd-3a40-4f8e-a3ff-48617294b76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c000e6ea-d4a8-4ec7-a8a7-cb858dcbd1ed",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3502a385-75a7-474f-8239-dbec0b45d3d3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e18b5712-e6fa-47bf-b609-ad61ba8ccd2c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"modified_dateutc": "2025-11-22T18:01:05.3070881+00:00"
},
"equipment_family_id": "9ceda905-a018-4f3b-8337-1cadb54dbf67",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "91c043e5-7e54-46c7-ba51-600511062c01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17c18813-52f4-4802-b5bd-e38435bb5b45",
"_parent_code": "sample string 6",
"sales_organization_id": "47212e2b-eea8-41ff-80ec-1df0870df990",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"modified_dateutc": "2025-11-22T18:01:05.3070881+00:00"
},
"date_in_production_since": "2025-11-22T18:01:05.3070881+00:00",
"date_out_of_production_since": "2025-11-22T18:01:05.3070881+00:00",
"date_end_support": "2025-11-22T18:01:05.3070881+00:00",
"sales_organization_id": "fc962724-05db-44d4-a34a-a0b057bd2901",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+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-22T18:01:05.3227402+00:00"
},
"project_status_id": "924c5d8c-d814-4087-9410-763904afde49",
"project_status_code": "sample string 10",
"project_status": {
"id": "9600f222-23c8-41d0-af7e-d83ac720f0a9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5ee66f6b-38e9-49b7-aa98-5f8dff7a5ac6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00"
},
"company_id": "a64eac13-e786-4954-969d-7ebd319c6d92",
"company_code": "sample string 12",
"db_address_id": "aa21350f-3f12-4370-949f-77906008b0e8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "85a88675-72a0-412d-9f9e-69c742b38092",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e85992e9-f388-46e8-9da8-074de2387887",
"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-22T18:01:05.3227402+00:00",
"date_create": "2025-11-22T18:01:05.3227402+00:00",
"date_update": "2025-11-22T18:01:05.3227402+00:00",
"updated_by_user_id": "98fa6904-d026-4cd1-903e-133b57d386b4",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-22T18:01:05.3227402+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-22T18:01:05.3227402+00:00",
"date_last_job": "2025-11-22T18:01:05.3227402+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-22T18:01:05.3227402+00:00",
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00",
"is_mobile_installation": true
},
"job_type_id": "f3dd5996-bd9e-4ea3-89d0-a7fd24463d9d",
"job_type_code": "sample string 7",
"job_type": {
"id": "248577ba-a7bb-4f6f-9e0d-dea4e7e9b1f4",
"name": "sample string 2",
"sales_organization_id": "05b15955-7e82-4fb6-88c3-b5dc824c2e2d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00",
"code": "sample string 7"
},
"job_priority_id": "c2fe3fe5-21f6-4978-ab94-6a40bc00ebb8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "34f5dfd5-f4dd-40d0-82d1-96a08e95b6a1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0f10ecfb-2134-4088-b124-a87954c1498c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00"
},
"job_status_id": "2e54ef6f-d097-4c42-9f30-24687759c2b5",
"job_status_code": "sample string 11",
"db_address_id": "382c9bd8-5463-4a45-826d-9d33e18e9a01",
"contact_id": "754898b1-8bed-4e44-a668-bee509ff2fd4",
"requested_by_company_id": "b914f622-cabf-40b6-ba4a-483ffd5426d2",
"requested_by_contact_id": "c356b3a7-fa4e-4980-bca9-6dbc11509c91",
"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-22T18:01:05.3227402+00:00",
"due_date": "2025-11-22T18:01:05.3227402+00:00",
"date_create": "2025-11-22T18:01:05.3227402+00:00",
"date_update": "2025-11-22T18:01:05.3227402+00:00",
"date_closed": "2025-11-22T18:01:05.3227402+00:00",
"suggested_user_id": "82e48f63-c3a7-46cd-80eb-aeb412727bfc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "016b92ac-f27f-42b1-b491-69201cba8151",
"db_language_id": "e77c8e1b-1557-476b-9c95-83cb1bed2998",
"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-22T18:01:05.3227402+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc84c562-9ba5-4fe6-9771-97533b4b3dff",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0af27971-ecfb-4f1e-963e-608d8a23fd23",
"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": "762c0b76-b350-412a-b566-8bd0b81a0948",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a49468ce-e682-484b-9dbd-1367e9d2a760"
},
"suggested_date_start": "2025-11-22T18:01:05.3227402+00:00",
"skill_id": "622d1f9b-c9c1-46be-8d23-21f5504916b0",
"skill_code": "sample string 32",
"skill": {
"id": "89470f09-9de0-432c-8ba5-74fa3eb2717d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "219eb12a-52c4-4198-9c0b-d9e9935a20fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c2f8bc4d-fd50-46e7-8416-0a2be2b1ebb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4668e32c-40cd-421f-89ce-c57f734a3153",
"db_currency_id": "3ff5bb2c-9844-4e42-b149-4433c3f8cf38",
"db_language_id": "0e568bf9-ae96-46c5-af9b-eb4061aacfe7",
"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-22T18:01:05.3070881+00:00"
},
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6fdfb1c3-62e0-4176-a8f9-f1b9832deea3",
"date_reported_by_company": "2025-11-22T18:01:05.3227402+00:00",
"id2": 36,
"company_id": "3925ace4-7d26-438e-a61e-4634ad47f8da",
"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": "f50ef29d-d1a5-455d-b5fc-808c0d928f0b",
"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-22T18:01:05.3227402+00:00"
},
"work_instruction_details_id": "bb5e5ff6-e510-4ca6-aa82-22b525d6e76a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ca958d5b-92f3-4d72-afcf-1effd3e94c00",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "357a2c24-d94d-41ea-ae3b-feff0d9d806f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-22T18:01:05.3227402+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": "35a848c3-240d-44a9-9dfd-46d4a9c315a6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-22T18:01:05.3227402+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.