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": "da22ae16-d2cf-43ba-a460-176e6bb62480",
"jobs_id": "5963d7da-5938-4f75-a07b-898fb1d91999",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "02d2ffe9-eb8d-432c-b29a-2eaaabfdf535",
"_parent_id": "d5659776-fdfc-42e7-bed6-5b9acfe57805",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4a47cd7c-4683-4c98-a385-40d690987ab3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d60970f8-c4fa-48ac-9d51-27801c0c63d2",
"_parent_id": "204d779e-e348-4fca-b795-e72b0d0b68c4",
"root_parent_id": "5bcdbae4-6aa9-4aa3-8fa5-e6995c9d0b07",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c58a0abc-3c1d-4949-804c-0c0ed6c5235a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "52545ba3-65fb-40ce-bc7f-ee69cb69601d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "285fa21d-5ddf-49fd-ac5d-ac5b0093b8c4",
"_parent_code": "sample string 6",
"sales_organization_id": "03dffb19-bdf6-4dda-b517-e8a04af8618a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
},
"equipment_model_id": "e5f2d0fa-ffad-4a84-acc5-9354941b3ac4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a8d2e6e-2acc-4a2b-9f81-28ed5062f7cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1ad59ba2-b45b-448f-bd81-77a839c30ac6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "09a37119-8f84-45c4-941d-ce0dc5a67ebe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "10f11574-8d58-480b-b61e-a55542b1f87b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
},
"equipment_family_id": "5aa72719-de0a-4ce3-8926-37518dfd7fb7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "52545ba3-65fb-40ce-bc7f-ee69cb69601d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "285fa21d-5ddf-49fd-ac5d-ac5b0093b8c4",
"_parent_code": "sample string 6",
"sales_organization_id": "03dffb19-bdf6-4dda-b517-e8a04af8618a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
},
"date_in_production_since": "2025-09-03T06:39:14.7080314+00:00",
"date_out_of_production_since": "2025-09-03T06:39:14.7080314+00:00",
"date_end_support": "2025-09-03T06:39:14.7080314+00:00",
"sales_organization_id": "9a0c909e-0357-4be1-b367-da0a59262c85",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+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-09-03T06:39:14.7080314+00:00"
},
"project_status_id": "67e2ebf5-d666-48a3-8792-4e462aa815cd",
"project_status_code": "sample string 10",
"project_status": {
"id": "e5be8a92-ba4b-402d-9323-fdb4f0402b57",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5fb20afa-910e-49cd-b075-52b10c37935d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
},
"company_id": "74944b14-d806-4bca-8480-bb38c2fe156b",
"company_code": "sample string 12",
"db_address_id": "c04faa4f-da66-4a03-9943-d2b0c7ef742a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e0d342aa-78a1-4e54-8f61-1f7c21e55afd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "37937d3f-99f9-4738-a08b-5620ac076462",
"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-09-03T06:39:14.7080314+00:00",
"date_create": "2025-09-03T06:39:14.7080314+00:00",
"date_update": "2025-09-03T06:39:14.7080314+00:00",
"updated_by_user_id": "3adc5cc3-a0d7-4f0c-b697-5fe9d31e38e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-03T06:39:14.7080314+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-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-03T06:39:14.7080314+00:00",
"date_last_job": "2025-09-03T06:39:14.7080314+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-03T06:39:14.7080314+00:00",
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00",
"is_mobile_installation": true
},
"job_type_id": "caad3454-fe5d-49a3-b439-9c43670f13c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "b1b52366-ffc1-4aeb-8208-0dd65f31b751",
"name": "sample string 2",
"sales_organization_id": "d19f29de-3529-4b48-829a-f7e421dfe4a0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00",
"code": "sample string 7"
},
"job_priority_id": "ec71b305-beda-4a2b-8d3e-975c12007f5c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a9310fed-44ec-4c1a-8d6c-8ae221bf7f44",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "86cba58d-894f-4d2b-a7be-a62593e8c962",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
},
"job_status_id": "7e064dcb-733d-4168-9fae-f830885aa45b",
"job_status_code": "sample string 11",
"db_address_id": "9178be6f-9ca3-44ec-a89b-bdc7e756c1e6",
"contact_id": "dd84934f-18b7-4755-8321-f02c0b48d5c1",
"requested_by_company_id": "b0716b18-9178-4425-abcc-640f9b4071a5",
"requested_by_contact_id": "0b20d54e-abec-459a-9037-bfcf8b0c5f61",
"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-09-03T06:39:14.7080314+00:00",
"due_date": "2025-09-03T06:39:14.7080314+00:00",
"date_create": "2025-09-03T06:39:14.7080314+00:00",
"date_update": "2025-09-03T06:39:14.7080314+00:00",
"date_closed": "2025-09-03T06:39:14.7080314+00:00",
"suggested_user_id": "2967d371-afff-4236-95ea-69f8ef12d8cc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d94c980-8f3b-415d-a7e5-4f79eb4e3e96",
"db_language_id": "fc638bab-73cc-40e5-a410-40b3492b805d",
"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-09-03T06:39:14.7080314+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a0670467-3cd6-4cb4-878e-eed20698923b",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "be001389-5cd9-4418-bc5b-e5453c87d819",
"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": "f61a0748-056a-43a7-a2bb-1e879d29faef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "464504aa-5830-481c-8f93-7a5e161e1efe"
},
"suggested_date_start": "2025-09-03T06:39:14.7080314+00:00",
"skill_id": "4097cead-310d-4cef-8933-0d6b6b1ae4e7",
"skill_code": "sample string 32",
"skill": {
"id": "d44e271b-ea95-4b0b-9b95-8c95a0f03a4a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c48c78a3-05bd-47c9-93dc-9230ec9819b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "033e19e2-b874-42d7-9b4d-c28c904817f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "59f4711d-3ec4-44ec-92c5-a32f5622ff22",
"db_currency_id": "7ee5487f-5427-4ddc-a0b0-2bfbbc8bb7de",
"db_language_id": "50ee8682-cc27-41d5-a6de-480c7ecd139f",
"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-09-03T06:39:14.7080314+00:00"
},
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "127686fd-0ddf-4454-8d57-72747898eaa3",
"date_reported_by_company": "2025-09-03T06:39:14.7080314+00:00",
"id2": 36,
"company_id": "f4d8d650-d1ec-4940-8dc8-4e26a2f4b058",
"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": "5f30936f-4b5e-4a68-b8b0-4ee30d8670aa",
"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-09-03T06:39:14.7080314+00:00"
},
"work_instruction_details_id": "6d233cf0-5230-448a-b43f-7d3cdd55a79c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e4870a21-7661-4ab0-9f25-c9aaf708abce",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "09edf3e8-71d4-45d2-8d44-b165ca711564",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-03T06:39:14.7080314+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": "959f17c9-4319-478e-9f00-e3a1c68a8870",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-03T06:39:14.7080314+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.