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": "2fe41aea-d321-4e79-a46b-685d37bdf82e",
"jobs_id": "6e9fb94a-8a7b-46ca-86bf-5b788984281d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "de414dcf-8f54-4300-b66c-9122a6411b43",
"_parent_id": "2d3d98f4-9e99-4302-ab64-d23e59b5b11c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e6a7a199-5c71-49d4-b43d-ed4c65537eea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60587402-b49a-4f73-82c4-607278b97c1f",
"_parent_id": "eaa68e6e-a8ae-4e66-9356-3da40475e77c",
"root_parent_id": "8b3ea188-a338-4d1d-b0b3-55af63b7fb6c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ec0a66b7-352e-4908-863d-9fdb7e98f01f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "957003c9-0fa2-4e7e-b139-9273603b13d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1270b25-3345-4f3a-9dfb-fb9c03fd191c",
"_parent_code": "sample string 6",
"sales_organization_id": "93356517-dcad-40ad-9d45-068c58902ae1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00"
},
"equipment_model_id": "246a11b4-0591-4510-b327-cca38e1a43d6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "36e3b0c1-9b5d-42e8-aed7-5b9383167fcd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e455a96a-7388-4a69-9566-eaa20bd2a466",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e865f30b-aec9-4f57-b9c0-05674ba02dad",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "56225ad6-4837-48fa-93fb-9e18d6ca8326",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00"
},
"equipment_family_id": "f40da8b7-ad05-412a-842b-d9cd32c40d9f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "957003c9-0fa2-4e7e-b139-9273603b13d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f1270b25-3345-4f3a-9dfb-fb9c03fd191c",
"_parent_code": "sample string 6",
"sales_organization_id": "93356517-dcad-40ad-9d45-068c58902ae1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00"
},
"date_in_production_since": "2026-07-13T22:53:50.6779526+00:00",
"date_out_of_production_since": "2026-07-13T22:53:50.6779526+00:00",
"date_end_support": "2026-07-13T22:53:50.6779526+00:00",
"sales_organization_id": "03845b4e-c896-404e-964d-0458198a06f8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+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-07-13T22:53:50.6779526+00:00"
},
"project_status_id": "d0aa9a49-44e9-4f88-9301-eee0a804ea51",
"project_status_code": "sample string 10",
"project_status": {
"id": "669b466f-09bf-482d-8a48-66e676f9e411",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7e66cbbd-5e9c-4a3a-aa0b-7277ce10f9e4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00"
},
"company_id": "5350c7b0-df62-460f-ac7c-3e455fedde44",
"company_code": "sample string 12",
"db_address_id": "06c39268-92e3-42e4-9c57-594bac26f549",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f74fec21-cab4-468d-aa44-371cc243f3b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "11906c4f-1a98-4749-8d20-0491cde9155a",
"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-07-13T22:53:50.6779526+00:00",
"date_create": "2026-07-13T22:53:50.6779526+00:00",
"date_update": "2026-07-13T22:53:50.6779526+00:00",
"updated_by_user_id": "0a5ae535-5672-4730-9ec8-ad687d9f1218",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T22:53:50.6779526+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-07-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T22:53:50.6779526+00:00",
"date_last_job": "2026-07-13T22:53:50.6779526+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T22:53:50.6779526+00:00",
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00",
"is_mobile_installation": true
},
"job_type_id": "357532f0-9c5e-4dcc-b14d-8de692d568a7",
"job_type_code": "sample string 7",
"job_type": {
"id": "ddc28aac-831b-4860-9734-33026438cbb8",
"name": "sample string 2",
"sales_organization_id": "85149a98-b36c-47e0-90dc-48dc4715f20e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00",
"code": "sample string 7"
},
"job_priority_id": "db36f91b-dbc9-49ef-9b15-3d18b36a799e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8d569245-f2d5-4cc3-947f-70eaac56c166",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0843e327-2b82-41a3-8277-f1c61c6f1bf7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T22:53:50.6779526+00:00"
},
"job_status_id": "3c744332-5e21-40f2-b773-f5af12727725",
"job_status_code": "sample string 11",
"db_address_id": "f1615886-ba53-4536-a590-8a690e611e60",
"contact_id": "86cdfaac-6ae6-4dac-91ae-2d2f603a0807",
"requested_by_company_id": "200aff6d-8238-4bf2-932a-205ea5ecd590",
"requested_by_contact_id": "9c4abb3f-42a7-4a57-897b-04ca298281c5",
"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-07-13T22:53:50.6779526+00:00",
"due_date": "2026-07-13T22:53:50.6779526+00:00",
"date_create": "2026-07-13T22:53:50.6935735+00:00",
"date_update": "2026-07-13T22:53:50.6935735+00:00",
"date_closed": "2026-07-13T22:53:50.6935735+00:00",
"suggested_user_id": "ddc71dad-5ae0-464e-93a6-a19bbe688c9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e2f3d8e1-2aed-4155-af59-df91338110a3",
"db_language_id": "bf8caf6b-9c46-41da-ba8e-352ca4e88f19",
"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-07-13T22:53:50.6935735+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0be2f6ce-fef4-4a39-8639-8622a8ad69d0",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "38b14aa4-fecf-4a62-a3b9-1e5ac086be1d",
"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": "2e2ca8b5-fc50-4892-a6dc-a9372e9f061b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T22:53:50.6935735+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fac6333d-6248-4056-ace9-b05495243c8e"
},
"suggested_date_start": "2026-07-13T22:53:50.6935735+00:00",
"skill_id": "8a37d81e-3bc8-488d-9c98-3e5f95c98e75",
"skill_code": "sample string 32",
"skill": {
"id": "585ed180-b69e-4b1e-b624-03551247c0e9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5d1a0300-facf-4810-9f16-7162b3636de4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54ba87b6-f984-4b15-9955-71e8a843bef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e19adf19-d46f-48b7-9a8a-1e0cb720df76",
"db_currency_id": "e71ef63f-8871-4823-916a-077fe55be6c7",
"db_language_id": "8e5a6558-4b69-4d1f-aa21-1b2216525ef5",
"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-07-13T22:53:50.6779526+00:00"
},
"modified_dateutc": "2026-07-13T22:53:50.6935735+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "013924e7-7dc8-475f-bb06-ffd1f6697139",
"date_reported_by_company": "2026-07-13T22:53:50.6935735+00:00",
"id2": 36,
"company_id": "904ccf64-ce46-45c5-b144-1321ceb54e99",
"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": "6a234d4b-61d0-4602-92d2-376b4996195c",
"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-07-13T22:53:50.6935735+00:00"
},
"work_instruction_details_id": "de5b7346-27e2-4ccb-9868-389d1bc626b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "63c31f89-1171-493d-9af7-95e630cdd369",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6316d447-873b-4828-a9d0-7040e3071f74",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T22:53:50.6935735+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": "9752b305-a0cb-4c7f-bca5-7e9b36cfcdc4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T22:53:50.6935735+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.