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": "7d6228c1-fedc-474a-97e2-664165a89bb5",
"jobs_id": "21e37576-855b-49a9-88db-84120d5da28e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b0e47bbe-f93d-48ae-a164-e4965a165391",
"_parent_id": "4b141fc9-efc7-4cbf-aa83-2bafd8f5db37",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d2c97c0e-7b13-42e0-be19-2fc98f9e56bc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ad625148-3258-47ab-97cb-bedab595d7eb",
"_parent_id": "1bfe973d-b7fb-413d-b56e-e1c7fc7b9985",
"root_parent_id": "f91b662c-4adb-45ba-a979-37e1da42eca4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "771c9d3b-1ce4-4b4d-bc77-a72de929abd5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b648bd1c-c7c1-4cfc-b7bc-800e8a9f0a44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3aa9c1f5-0965-4a0d-8a7b-bed75eac9ebb",
"_parent_code": "sample string 6",
"sales_organization_id": "5a2addc8-a3d0-49be-b498-7729e4be0db8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"modified_dateutc": "2026-03-12T01:58:47.9342759+00:00"
},
"equipment_model_id": "37b3a993-5b86-4264-a82c-dad8990e36a6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "da14b1e7-04a0-483e-9a7c-bdba4ccbcc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "87157316-354b-46ca-9d8b-c7a390bbf06a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e8569142-c8b9-468f-95c6-44527c9d0141",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b49f6df-a85e-4c19-8c9b-2da7ed8cc84f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"modified_dateutc": "2026-03-12T01:58:47.9342759+00:00"
},
"equipment_family_id": "3b48bc72-66f6-477a-9cfa-745d6f855762",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b648bd1c-c7c1-4cfc-b7bc-800e8a9f0a44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3aa9c1f5-0965-4a0d-8a7b-bed75eac9ebb",
"_parent_code": "sample string 6",
"sales_organization_id": "5a2addc8-a3d0-49be-b498-7729e4be0db8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"modified_dateutc": "2026-03-12T01:58:47.9342759+00:00"
},
"date_in_production_since": "2026-03-12T01:58:47.9342759+00:00",
"date_out_of_production_since": "2026-03-12T01:58:47.9342759+00:00",
"date_end_support": "2026-03-12T01:58:47.9342759+00:00",
"sales_organization_id": "f0faad7a-8261-41ba-b94f-b614e9b824b7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+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-03-12T01:58:47.9342759+00:00"
},
"project_status_id": "3d4b4030-ef91-44b2-a5f4-11fe513d9bed",
"project_status_code": "sample string 10",
"project_status": {
"id": "f1001488-2d79-4498-900e-365757af5bf0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "05df3aec-56f9-4944-a4f9-b110c0d5b9c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T01:58:47.9342759+00:00"
},
"company_id": "8fd23c16-ec96-4be3-aaea-40e1cb4dc31a",
"company_code": "sample string 12",
"db_address_id": "90be99b6-44ec-4e3a-9083-9b59148c75f1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ad85ffa4-3b9d-4591-b2c2-496b4ada8c93",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d46198f1-1428-4be2-b178-cb028d96ec04",
"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-03-12T01:58:47.9342759+00:00",
"date_create": "2026-03-12T01:58:47.9342759+00:00",
"date_update": "2026-03-12T01:58:47.9342759+00:00",
"updated_by_user_id": "a1ec9272-c60d-4075-b6ae-64ae99edeec6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T01:58:47.9342759+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T01:58:47.9342759+00:00",
"date_last_job": "2026-03-12T01:58:47.9342759+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T01:58:47.9342759+00:00",
"modified_dateutc": "2026-03-12T01:58:47.9342759+00:00",
"is_mobile_installation": true
},
"job_type_id": "c90b1d2b-5ca8-4ba6-9d76-78ae7bf0eacd",
"job_type_code": "sample string 7",
"job_type": {
"id": "0e75f7f8-483b-4ab1-8d6a-6dc2614b7566",
"name": "sample string 2",
"sales_organization_id": "1638a999-2f7d-40fd-a3e3-4a9af116cc19",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T01:58:47.9498989+00:00",
"code": "sample string 7"
},
"job_priority_id": "bdafe660-ca05-48a3-afc9-3d6878155dc8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e563d3ce-fda7-48b8-b786-29eb385eb5ff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d845b126-46ec-4159-a852-781a0e72cb61",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T01:58:47.9498989+00:00"
},
"job_status_id": "80f08b7a-6d84-4a61-a627-5bc7d7f059b2",
"job_status_code": "sample string 11",
"db_address_id": "a0bf1f41-7d48-4678-bd26-eea0d93774dc",
"contact_id": "3eabe66f-924d-4817-85fa-2ceb6ca44f2e",
"requested_by_company_id": "41bcbaa3-8378-4448-a728-84db7fed6d99",
"requested_by_contact_id": "29ff7824-bbbc-46ca-8823-7fa2dfa6686d",
"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-03-12T01:58:47.9498989+00:00",
"due_date": "2026-03-12T01:58:47.9498989+00:00",
"date_create": "2026-03-12T01:58:47.9498989+00:00",
"date_update": "2026-03-12T01:58:47.9498989+00:00",
"date_closed": "2026-03-12T01:58:47.9498989+00:00",
"suggested_user_id": "a44bfd09-fb6b-4de5-9086-c218eb2f3639",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e3e47180-209d-43dc-9f2f-2320efdfd05d",
"db_language_id": "80dc39e9-ae18-4c46-8a98-5e547711e81f",
"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-03-12T01:58:47.9498989+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "388c3cca-79d4-4161-badd-af088ba4d9e3",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "36aa4fe6-3567-491a-8c0b-44d1d6282998",
"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": "60a63f15-8bb9-434f-b12d-cac6303cd29d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T01:58:47.9498989+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d9ba2839-5133-467a-993a-d5ff18e2dbbb"
},
"suggested_date_start": "2026-03-12T01:58:47.9498989+00:00",
"skill_id": "2b7e79aa-f75e-42cc-a7d7-f50efbb11ccd",
"skill_code": "sample string 32",
"skill": {
"id": "bde3ca74-5983-4fd1-86a9-01ebf4398b10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "512feb02-5b40-4078-ba31-0d49cec40ded",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8672a3bc-b06b-4cbd-bce1-aa0c1044cd3d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7e288f54-32a8-48d4-8213-13f1ead54642",
"db_currency_id": "5a43c359-5a56-4c94-9c2a-7eb12b9d6433",
"db_language_id": "6405cc88-7687-42ba-b5fa-75c759c11e16",
"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-03-12T01:58:47.9342759+00:00"
},
"modified_dateutc": "2026-03-12T01:58:47.9498989+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ede98736-0113-4389-a665-7cf728048d2a",
"date_reported_by_company": "2026-03-12T01:58:47.9498989+00:00",
"id2": 36,
"company_id": "976ce520-2f82-4524-863f-caa3396ee3dd",
"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": "0477062a-dcf4-487d-ac12-1071bdf24eb5",
"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-03-12T01:58:47.9498989+00:00"
},
"work_instruction_details_id": "0b0909b8-c4e0-4d98-8576-12ccb95b2dd7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cf54761a-5aaa-41cb-98fb-7c7f9578c75e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "898fe62d-7d3e-4bd6-9822-640bb537ea4d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T01:58:47.9498989+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": "8b51f72a-80c6-4511-80e5-dc9df2a07a31",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T01:58:47.9498989+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.