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": "cc196cd4-0bd4-4ea1-a301-17db9a6600f8",
"jobs_id": "9c7dab80-87f7-4304-ace5-dca8e78b6c4e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e37523ef-c7cc-4e46-92f6-5af70f3819ae",
"_parent_id": "cc56bf8b-d114-4b63-906e-c700e78796d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7bf1b070-2960-4222-a319-3e3e5b2a37bc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8a335207-e613-4cd9-a5b0-7999c6ff14a9",
"_parent_id": "93d7e489-96e6-4b86-aaba-a94176707ce8",
"root_parent_id": "4d8717d9-5f81-46fc-96b6-d326857fa805",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4f7da567-28f2-4c16-a48a-5f76153470a9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3b819a64-986c-4118-8d41-908cde86582b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29cd5280-1beb-4c2f-b5ff-02520728a5df",
"_parent_code": "sample string 6",
"sales_organization_id": "200db8e5-0100-444e-8eb6-ba4de1f3a5f3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
},
"equipment_model_id": "982247f1-a0ee-4da4-9671-83b6bb649a0d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f0e8aefa-2e1c-489e-b022-51c3dd7074cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "75386515-8526-4257-b7f3-8e9c751248ef",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2cc74a3a-bf0a-48e5-a069-0739f0bcceaa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6c464db4-b271-4222-a0c3-d4cfa4f24d54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
},
"equipment_family_id": "049492fa-8cc2-4b34-aae9-264800ddd71a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3b819a64-986c-4118-8d41-908cde86582b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29cd5280-1beb-4c2f-b5ff-02520728a5df",
"_parent_code": "sample string 6",
"sales_organization_id": "200db8e5-0100-444e-8eb6-ba4de1f3a5f3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
},
"date_in_production_since": "2025-12-25T08:18:09.1281577+00:00",
"date_out_of_production_since": "2025-12-25T08:18:09.1281577+00:00",
"date_end_support": "2025-12-25T08:18:09.1281577+00:00",
"sales_organization_id": "166c5ac8-9a91-47ad-8bf2-2e19fecc6ef6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+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-25T08:18:09.1281577+00:00"
},
"project_status_id": "00d589f1-4727-4117-b0ed-592459e0c22e",
"project_status_code": "sample string 10",
"project_status": {
"id": "0e7c3485-6f55-4fa4-bbbc-d757533e61d1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4c264cc3-cfde-4216-820c-6cf84c385e40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
},
"company_id": "e790781e-af11-43d3-af3a-9cd998b3bd1b",
"company_code": "sample string 12",
"db_address_id": "7095c045-7428-49fa-a7f3-884d1e5f8d19",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e630aade-7a8d-4827-bf40-5714a19073a8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "48d416be-8b57-4d0a-9b91-2fa6f238c925",
"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-25T08:18:09.1281577+00:00",
"date_create": "2025-12-25T08:18:09.1281577+00:00",
"date_update": "2025-12-25T08:18:09.1281577+00:00",
"updated_by_user_id": "392fb9bb-4104-4602-9215-eb607cbbee1a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-25T08:18:09.1281577+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-25T08:18:09.1281577+00:00",
"date_last_job": "2025-12-25T08:18:09.1281577+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-25T08:18:09.1281577+00:00",
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00",
"is_mobile_installation": true
},
"job_type_id": "31386cc1-b10c-4f42-bfbd-55fa3403685b",
"job_type_code": "sample string 7",
"job_type": {
"id": "841003f8-8706-4a2f-a93b-0a6dd6d4ae4b",
"name": "sample string 2",
"sales_organization_id": "fa3bfed5-c849-401a-aac7-13e3bdf77a90",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00",
"code": "sample string 7"
},
"job_priority_id": "ecea8e1b-55d4-47fc-a41e-f5547894da4f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ebdead6c-aa36-4084-ab93-f35f6f9f5911",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ad0be5ea-8eda-4a8d-8d8e-67104477bd0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
},
"job_status_id": "1b54a32a-9225-4f4b-9afa-e071fc2e5488",
"job_status_code": "sample string 11",
"db_address_id": "5aafea2e-9e70-4bd3-a23c-a1aa032a5777",
"contact_id": "d3e0ef30-1055-4522-85cc-9992af17f532",
"requested_by_company_id": "1dd8fc2a-30c7-4409-a178-d11234fba7b6",
"requested_by_contact_id": "5f0511be-7374-4e7a-936e-2d4b75a97fcf",
"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-25T08:18:09.1281577+00:00",
"due_date": "2025-12-25T08:18:09.1281577+00:00",
"date_create": "2025-12-25T08:18:09.1281577+00:00",
"date_update": "2025-12-25T08:18:09.1281577+00:00",
"date_closed": "2025-12-25T08:18:09.1281577+00:00",
"suggested_user_id": "1e2e0013-454f-4e14-bdb3-f27a8b4b3cd7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4ffb386d-3929-4cf9-8c8d-82e30a88640f",
"db_language_id": "67486556-ad13-4906-9bd3-9eb64dfddf8b",
"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-25T08:18:09.1281577+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "93e635b5-c5ce-4956-8447-6080a9834edd",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3c5b5256-711c-49bf-9594-2feeaf859a87",
"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": "6c4326d1-e143-4e93-bc45-5e10791cf680",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f585d762-3174-46c7-9e66-36dd6bf728c7"
},
"suggested_date_start": "2025-12-25T08:18:09.1281577+00:00",
"skill_id": "ad785a09-574d-446e-a5da-e2b1b3907f36",
"skill_code": "sample string 32",
"skill": {
"id": "da883e4a-8cf3-4d72-ae78-95a4fbce6ce4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "41859e6c-b4e3-4ea5-b126-fe926c4c58c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d6c60ac-4030-4e6c-a2d7-056f6058052c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afa41a1e-f713-424d-a5f1-93ee12f5b190",
"db_currency_id": "479f915a-4e7a-48da-80cd-0fc3ec20a99c",
"db_language_id": "d87178cd-ce5e-44ae-b87d-9244407455b1",
"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-25T08:18:09.1281577+00:00"
},
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e959132c-d6bb-4ee5-8646-b659ecb8dd7f",
"date_reported_by_company": "2025-12-25T08:18:09.1281577+00:00",
"id2": 36,
"company_id": "7f80b148-408f-45b6-a7a5-39cc6fc4ce7e",
"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": "a57bd53f-a192-4338-a0e5-b2bb28a36757",
"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-25T08:18:09.1281577+00:00"
},
"work_instruction_details_id": "3d1705a8-7009-4437-afe4-66c001cc410c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "298fb552-b0ee-483b-ad86-df2f142a9877",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0c157d5f-8458-45d4-8971-fd9ac7ec8146",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-25T08:18:09.1281577+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": "19c85c7c-7597-4af8-b11f-ca2c498b23ec",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-25T08:18:09.1281577+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.