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": "c686e2dc-ac4d-4eac-9a47-49e69f0ecda6",
"jobs_id": "a30ac64e-2919-4d28-ae98-de4b894951e0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "32401cfc-db82-4b93-8b87-49addaf3f073",
"_parent_id": "0cf654e8-6bc1-474f-98e2-adc9dca8143d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c31b336d-c674-4555-8c08-6c170badd593",
"project_reference_back_office": "sample string 5",
"project": {
"id": "70fa9f46-b1d7-42e9-a05b-b2fc7d5d81d7",
"_parent_id": "2bd38b7b-523a-4cfe-917e-d89d636a5f55",
"root_parent_id": "10dcaf85-3a2d-4021-b7ac-b51bb0e2e169",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ebf3cd4f-60fa-4c7a-94be-458f17a695e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "80a99984-2a52-4986-bc7c-63ceb4c0d61c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb29dbee-a721-41ce-82fe-b53a7ac24b95",
"_parent_code": "sample string 6",
"sales_organization_id": "24a6b636-d5e5-4441-84a2-f30860370974",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
},
"equipment_model_id": "d78f20a5-fd3d-4f03-9c7c-da6a9ca875cb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8e34fcdf-69b5-4315-b544-8e817b34f999",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "36c08299-b1c0-422a-8a5d-5640ebf154b8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5d88a8a8-3a6d-4c8a-aa91-331a9a271c5c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7071974d-ef51-42bc-9845-9c5fd0cb3e50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
},
"equipment_family_id": "1ffd305e-4cee-4270-856a-64939d1a67a8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "80a99984-2a52-4986-bc7c-63ceb4c0d61c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb29dbee-a721-41ce-82fe-b53a7ac24b95",
"_parent_code": "sample string 6",
"sales_organization_id": "24a6b636-d5e5-4441-84a2-f30860370974",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
},
"date_in_production_since": "2026-01-07T08:34:10.9204929+00:00",
"date_out_of_production_since": "2026-01-07T08:34:10.9204929+00:00",
"date_end_support": "2026-01-07T08:34:10.9204929+00:00",
"sales_organization_id": "1f4251e0-56d6-47e6-ae4c-5eaa1aef9cf9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+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-01-07T08:34:10.9204929+00:00"
},
"project_status_id": "dcdefdcd-e890-42bb-80d6-ed23a9f0ed13",
"project_status_code": "sample string 10",
"project_status": {
"id": "77ab83f5-cf49-4dc6-8175-bfcbe2a8806a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "71d054d6-0f65-4be4-8f05-a87f961bf230",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
},
"company_id": "dc304e71-c776-4baa-8b1d-db895a249d2f",
"company_code": "sample string 12",
"db_address_id": "96ac1151-9443-4c16-9a79-4e01817b9efa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f8db485c-3297-4951-b736-2c8221fa0193",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fe85197a-cd95-48de-90e5-ef5d16083184",
"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-01-07T08:34:10.9204929+00:00",
"date_create": "2026-01-07T08:34:10.9204929+00:00",
"date_update": "2026-01-07T08:34:10.9204929+00:00",
"updated_by_user_id": "8e73fadb-89cc-4cf5-9dc1-7047705c9910",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-07T08:34:10.9204929+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-01-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-07T08:34:10.9204929+00:00",
"date_last_job": "2026-01-07T08:34:10.9204929+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-07T08:34:10.9204929+00:00",
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00",
"is_mobile_installation": true
},
"job_type_id": "4730e955-a606-4d7b-879d-746fa2bb7656",
"job_type_code": "sample string 7",
"job_type": {
"id": "05bc33b1-e69d-47b5-836d-1c299b27c339",
"name": "sample string 2",
"sales_organization_id": "23b1869a-f037-46d8-a6d5-d1705fcee51e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00",
"code": "sample string 7"
},
"job_priority_id": "f57da247-1435-403d-ac07-8d1bff01584e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "669e3884-b203-44df-8abc-01f9e27283d9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e71f9f1d-4a2c-462f-8819-8aba8f74b4a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
},
"job_status_id": "19fc529d-1a21-4ddf-bb89-1640e630562d",
"job_status_code": "sample string 11",
"db_address_id": "4b931a24-8fc8-4453-8a06-b120c0b0fb1e",
"contact_id": "b905f9e0-83f5-474c-972e-ff04aa3c7ab8",
"requested_by_company_id": "d335cb94-1fb6-4c98-9d5e-4e6f39d7b03a",
"requested_by_contact_id": "b912940b-9b27-4f12-bf5f-df4de4721342",
"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-01-07T08:34:10.9204929+00:00",
"due_date": "2026-01-07T08:34:10.9204929+00:00",
"date_create": "2026-01-07T08:34:10.9204929+00:00",
"date_update": "2026-01-07T08:34:10.9204929+00:00",
"date_closed": "2026-01-07T08:34:10.9204929+00:00",
"suggested_user_id": "7e255f54-f3e7-40eb-b298-b215fd72e7af",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b466cb9c-fc19-41e3-9e2a-61a604cd10b9",
"db_language_id": "188ed20a-9e68-4c6f-b4c2-86e15e87b12b",
"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-01-07T08:34:10.9204929+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "483690cf-67e0-436d-a892-233b63fa38d2",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b4f56ab1-1925-4151-b12c-e81b1065680c",
"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": "14a92f66-cc25-407d-b9ff-c5ce379e46d9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "52588f41-a9ad-4f80-9c88-63352dc83d0a"
},
"suggested_date_start": "2026-01-07T08:34:10.9204929+00:00",
"skill_id": "888602c3-a079-417a-ad6b-5634bdb7dcd4",
"skill_code": "sample string 32",
"skill": {
"id": "ee4bf9a9-88f7-4d77-b45a-6b193d1c6e3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b352740a-6c88-4113-8b5b-e22c7b06ea6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26180d12-4522-4d79-b44a-c3c93eb67a16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82bd2251-e955-4df3-84fe-2fd1273c1352",
"db_currency_id": "02d510b7-f85a-4e1b-b42b-c1fcf603dbca",
"db_language_id": "53ebcf2b-7b22-45ef-a853-426ec2c28ba3",
"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-01-07T08:34:10.9204929+00:00"
},
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aa53c6d9-9497-4fb3-9769-9e95e0615be5",
"date_reported_by_company": "2026-01-07T08:34:10.9204929+00:00",
"id2": 36,
"company_id": "01c45250-93b9-4e47-9cdc-2a3f0af3d8ad",
"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": "2a4a2cbe-02ed-4de3-b4b0-1ffe96438358",
"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-01-07T08:34:10.9204929+00:00"
},
"work_instruction_details_id": "906e775b-870a-40ec-82ec-6fc85444e170",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0e846efa-26d7-4540-8091-26d629451c76",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c93227bc-60b8-4a96-9871-13bd47be6fa5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-07T08:34:10.9204929+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": "758ff663-0e9a-4bda-a002-5953b8fd391a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-07T08:34:10.9204929+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.