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": "030ec8d1-7d53-46f7-836c-5d1d3adcce5a",
"jobs_id": "037a2899-a692-4f9e-baf0-6046939ceb3d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1a762ef0-4597-4891-b8d3-abc986bb4af6",
"_parent_id": "3d7c5314-c86a-466f-9723-47f2c5feeb7e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6dae87ff-9142-470c-83cd-e5e1bda34228",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0a31202e-96e3-4fe3-9cba-9f77dafee5fc",
"_parent_id": "2266f58b-08c4-45cb-85da-5df4586bd8e1",
"root_parent_id": "d7e218c1-eae6-45e8-b57c-ca785d367cfe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f1091cd1-4dd8-46c8-a98c-f800bd640b2d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "499d6d4f-17c9-4e87-91fb-e7a3b17608b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "228ebdee-5124-4902-bc2f-0c66086b3fd5",
"_parent_code": "sample string 6",
"sales_organization_id": "66acf73d-2781-4e24-a429-563fb8b61039",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"modified_dateutc": "2026-01-24T18:16:02.5468666+00:00"
},
"equipment_model_id": "264a06cc-20a3-4563-8648-9a5dc6bc04fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "962cd58d-fb0a-471c-a1e0-92d9aa4a34ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a1a4d4a7-47b5-459c-a61f-98688234bd06",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b03f569c-285f-461d-abb6-70e977071716",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7a98cdee-be24-4c28-be11-f7ce5fd22c72",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"modified_dateutc": "2026-01-24T18:16:02.5468666+00:00"
},
"equipment_family_id": "a49f21e0-d7a2-4cf9-8e2a-c1f908c64c32",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "499d6d4f-17c9-4e87-91fb-e7a3b17608b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "228ebdee-5124-4902-bc2f-0c66086b3fd5",
"_parent_code": "sample string 6",
"sales_organization_id": "66acf73d-2781-4e24-a429-563fb8b61039",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"modified_dateutc": "2026-01-24T18:16:02.5468666+00:00"
},
"date_in_production_since": "2026-01-24T18:16:02.5468666+00:00",
"date_out_of_production_since": "2026-01-24T18:16:02.5468666+00:00",
"date_end_support": "2026-01-24T18:16:02.5468666+00:00",
"sales_organization_id": "f7a63bea-ca2a-4fcd-969c-41239084e391",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+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-24T18:16:02.5468666+00:00"
},
"project_status_id": "e4df44aa-56ea-4859-9e83-f21537d1690a",
"project_status_code": "sample string 10",
"project_status": {
"id": "b8567908-0d53-4041-9c12-29ccd232fb68",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3d2b863d-8a69-44bb-85cb-5c8e52e69f37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T18:16:02.5468666+00:00"
},
"company_id": "3491ca01-8ab4-4103-90a3-04f6621a007e",
"company_code": "sample string 12",
"db_address_id": "31fa0674-0f92-410d-83a6-f093587118aa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ee3ff673-d7ab-4bc2-9e6f-49be7c6cfc93",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0b546d3a-1458-4f05-bde8-5eb6877e0768",
"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-24T18:16:02.5468666+00:00",
"date_create": "2026-01-24T18:16:02.5468666+00:00",
"date_update": "2026-01-24T18:16:02.5468666+00:00",
"updated_by_user_id": "8a1b5053-1640-4ced-8057-914f63ae9280",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-24T18:16:02.5468666+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-24T18:16:02.5625064+00:00",
"date_last_job": "2026-01-24T18:16:02.5625064+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-24T18:16:02.5625064+00:00",
"modified_dateutc": "2026-01-24T18:16:02.5625064+00:00",
"is_mobile_installation": true
},
"job_type_id": "e87416d6-84dd-40b9-a049-25557eab1f59",
"job_type_code": "sample string 7",
"job_type": {
"id": "cd7827cc-e651-47ef-9ecb-5be8c6e1b66b",
"name": "sample string 2",
"sales_organization_id": "d1ff7ea9-f572-4d87-97eb-131e8e5df0ad",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-24T18:16:02.5625064+00:00",
"code": "sample string 7"
},
"job_priority_id": "349ff345-a8e4-4787-83aa-951d081273ac",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "89456a9b-0e80-4935-ad39-b8dc6112a98f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1265107c-a503-4296-9603-5a1fc058b82a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-24T18:16:02.5625064+00:00"
},
"job_status_id": "6a854bb8-e041-4196-9bea-cbe8ccc555cc",
"job_status_code": "sample string 11",
"db_address_id": "231d0801-67e4-494e-9fd1-60d31f4a7499",
"contact_id": "b2bf43d9-5f3f-403b-9e12-5b8f6e8859a0",
"requested_by_company_id": "fc800cfc-8ea8-4f62-8e12-12dc895b011f",
"requested_by_contact_id": "e372518a-1142-4bc1-a5ad-4ff82d316ac6",
"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-24T18:16:02.5625064+00:00",
"due_date": "2026-01-24T18:16:02.5625064+00:00",
"date_create": "2026-01-24T18:16:02.5625064+00:00",
"date_update": "2026-01-24T18:16:02.5625064+00:00",
"date_closed": "2026-01-24T18:16:02.5625064+00:00",
"suggested_user_id": "ab312a9c-98e4-412a-ae11-0dc577607842",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fd6c2bf4-4138-4bae-8ff1-c6d0c28f3e98",
"db_language_id": "f5bfafbb-1b0c-4cbb-97a3-db4545d57a1b",
"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-24T18:16:02.5625064+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aa1682c8-4ea8-456f-aef9-c21fbc0df0b8",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73ceb91e-ddb4-4d18-84ca-864ecd424d61",
"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": "f096cf53-db0e-480e-be6c-d55f79e7fa54",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-24T18:16:02.5625064+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "227834e6-a152-4a1a-b286-964800d80032"
},
"suggested_date_start": "2026-01-24T18:16:02.5625064+00:00",
"skill_id": "0190aeab-72bd-434b-8fff-c7c3c7d9a69a",
"skill_code": "sample string 32",
"skill": {
"id": "891bc907-bc96-4d4d-ab27-bbdfae3b4f8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b1ed1a05-7c81-458e-80ba-dc856c909a01",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4b8b230a-4c4d-4fc9-8ba2-2322cefb3db8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35bd94d-37fa-4de6-b1ee-f7b19cd1b0e6",
"db_currency_id": "876c809b-7b69-459c-b325-0478dd387704",
"db_language_id": "f68cf4d5-f551-4303-80ca-00e80e43b2d2",
"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-24T18:16:02.5468666+00:00"
},
"modified_dateutc": "2026-01-24T18:16:02.5625064+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "93666d20-3c2b-4bb5-8caf-5b78f1ec198a",
"date_reported_by_company": "2026-01-24T18:16:02.5625064+00:00",
"id2": 36,
"company_id": "6c4e0b66-0c61-4f3a-8de3-d31a08fec5df",
"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": "a7877e86-d848-4dd4-8ffe-1ae263639ab6",
"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-24T18:16:02.5625064+00:00"
},
"work_instruction_details_id": "a00dc8c8-53ec-4fc7-b10a-13b00ef2d55d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d5558b8a-28ee-4e31-b8f2-ee303b5184e6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e4f99275-cf47-4bdd-bcbc-7359115f2530",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-24T18:16:02.5625064+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": "3eec6fa6-633c-4bca-931f-c7387ce8519c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-24T18:16:02.5625064+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.