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": "7b27fe0a-e686-4350-9eef-0d0575783f5c",
"jobs_id": "46b559eb-6969-4f6a-a1be-d6dfb7bdf3a2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6da35ad2-4636-453c-aa86-8eb4bcede478",
"_parent_id": "f8dccbc8-ef8b-4345-b288-7054c7dbc586",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d9527d1f-29d1-4b92-b2b9-a08543862a27",
"project_reference_back_office": "sample string 5",
"project": {
"id": "177e71d9-263e-411e-9d2a-8fe4d19c42aa",
"_parent_id": "f4d122ba-db58-4690-a289-e1b14f1b8554",
"root_parent_id": "5a3edc20-f98f-4248-a89b-c355ece5667c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "08c74a19-267a-4759-a988-fe15d4de58a4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "af8f68ee-1d67-42aa-b090-b2315c80aefc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4b411d9-e593-4257-86e0-85eca2243d74",
"_parent_code": "sample string 6",
"sales_organization_id": "9c37c304-f0ef-49db-a4b3-b366f0d54884",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"modified_dateutc": "2026-10-22T01:50:36.763372+00:00"
},
"equipment_model_id": "d1788afd-60d6-4083-ab3d-403d75f29af5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6667b566-9515-45b9-a56a-725f3f998756",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1ad9805f-62b7-40b3-b4ec-e9dbf3b298be",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "90a34866-4bec-4456-a419-ea944397603a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "47b9fb87-3ff2-40e6-9167-52e033ba7242",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"modified_dateutc": "2026-10-22T01:50:36.763372+00:00"
},
"equipment_family_id": "4956c02b-6122-4f37-8474-6a077b2384c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "af8f68ee-1d67-42aa-b090-b2315c80aefc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4b411d9-e593-4257-86e0-85eca2243d74",
"_parent_code": "sample string 6",
"sales_organization_id": "9c37c304-f0ef-49db-a4b3-b366f0d54884",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"modified_dateutc": "2026-10-22T01:50:36.763372+00:00"
},
"date_in_production_since": "2026-10-22T01:50:36.763372+00:00",
"date_out_of_production_since": "2026-10-22T01:50:36.763372+00:00",
"date_end_support": "2026-10-22T01:50:36.763372+00:00",
"sales_organization_id": "636d368e-de80-4591-a9ae-158de0ecf1e3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+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-10-22T01:50:36.7789692+00:00"
},
"project_status_id": "d58e6c3c-2f04-4ac3-8baa-dc1557d57a3e",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c71613e-c9e4-44ba-89a3-4996f474e46e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "62b69a6a-0c85-4c87-9410-f9c472871b52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00"
},
"company_id": "a8b72af9-c42d-4ea7-9352-217bd494c6d4",
"company_code": "sample string 12",
"db_address_id": "c3da232b-fe76-4e19-85d0-7f9488feab0e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "94aa9105-589c-4743-9352-eb8ccdbb7db0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95c24398-83f4-4c7c-befc-ac2596ba6df6",
"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-10-22T01:50:36.7789692+00:00",
"date_create": "2026-10-22T01:50:36.7789692+00:00",
"date_update": "2026-10-22T01:50:36.7789692+00:00",
"updated_by_user_id": "8431917e-d3a4-4d8d-8e81-0debcdb6260a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-22T01:50:36.7789692+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-10-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-22T01:50:36.7789692+00:00",
"date_last_job": "2026-10-22T01:50:36.7789692+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-22T01:50:36.7789692+00:00",
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00",
"is_mobile_installation": true
},
"job_type_id": "4481034e-040b-4f9a-9e66-402fa10aac17",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f48ee9f-2ed9-4c0f-8c2d-ed7a1bea2821",
"name": "sample string 2",
"sales_organization_id": "2a91c63b-9924-486a-a9e9-6801445f7939",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00",
"code": "sample string 7"
},
"job_priority_id": "01068d02-29d9-4a76-bf33-9828b444c1aa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "408254c4-bb31-46a0-9ddd-a11342bd4685",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0d015577-2da1-41ed-a561-89df6fab0fda",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00"
},
"job_status_id": "50383887-bca4-4340-9574-97a7c265f192",
"job_status_code": "sample string 11",
"db_address_id": "4eee201f-b2aa-48ec-a315-4a22c7344d78",
"contact_id": "08b88f5d-227e-4d3a-a492-b953d5726437",
"requested_by_company_id": "da5fbc0a-38ea-4e0c-b8bb-4f85d4bd144e",
"requested_by_contact_id": "6c18d6cc-887e-4f14-80fd-a0fde8d94b4a",
"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-10-22T01:50:36.7789692+00:00",
"due_date": "2026-10-22T01:50:36.7789692+00:00",
"date_create": "2026-10-22T01:50:36.7789692+00:00",
"date_update": "2026-10-22T01:50:36.7789692+00:00",
"date_closed": "2026-10-22T01:50:36.7789692+00:00",
"suggested_user_id": "bb5741ce-1081-41a3-acfd-87961869398d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d0b599a-fd24-4847-a7fb-84a4111ea61d",
"db_language_id": "496d9f85-34bf-4bb5-942f-1ced3a9b57a3",
"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-10-22T01:50:36.7789692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e1a02e4f-d585-4a8e-b8f8-d4bfd2f1074e",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "89670b7c-7d0a-4194-a048-2241263a5602",
"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": "1d1bef9e-4eba-40b9-a8c8-3f7a086bb7ba",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e35b342a-1036-4a4d-bcd7-0705d5db0057"
},
"suggested_date_start": "2026-10-22T01:50:36.7789692+00:00",
"skill_id": "5eaa4485-e0c2-457c-b094-ccd9e3a1d1b2",
"skill_code": "sample string 32",
"skill": {
"id": "beb73e73-34df-4ef7-baf5-85bf6fcbb32f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3b7f0d21-6b7b-4e1a-959e-cee52cc4ac6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e8b9280f-b06b-45a5-9f62-05c9290ad9d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3425caac-067f-4713-8685-22f9185f712b",
"db_currency_id": "32911f0d-5369-41b1-9ee4-c18f8faad52a",
"db_language_id": "c37f69c4-a107-417d-a83c-9edfa55d740f",
"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-10-22T01:50:36.763372+00:00"
},
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "80fd4e9e-4e23-44a2-b7da-fadc35c71a85",
"date_reported_by_company": "2026-10-22T01:50:36.7789692+00:00",
"id2": 36,
"company_id": "bf447806-df0c-4988-88b4-19697091eeca",
"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": "e97b5175-f902-4d13-961e-ccfd33293819",
"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-10-22T01:50:36.7789692+00:00"
},
"work_instruction_details_id": "9e6100e0-b72d-4afa-b42b-6edd7a8d7897",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7f7bcba1-fec9-405f-97f3-ee328731c4c2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "688efb17-d555-4f8e-8fb3-0d821ce8dc74",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-22T01:50:36.7789692+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": "952d94d8-5876-445f-8d52-97846cae1413",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-22T01:50:36.7789692+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.