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": "c54f4107-52fe-4ae1-ba92-ea5642701a25",
"jobs_id": "e22710e8-bfd8-4832-b96f-818ad516af16",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "84ae8723-4bed-4cf2-bf01-4e07f859c13a",
"_parent_id": "3bfdbbf9-7e2c-4dd0-91ce-fcf8f482d4fd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "374d61f8-d9ec-45c9-a89f-f59774889ab7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3ab6af9c-0e5b-41fe-9955-95367243e192",
"_parent_id": "f3a5f3f1-aca6-42ee-96dc-0ebba90ac1d5",
"root_parent_id": "a64b38b6-a47a-4ea7-ae8d-545b49493bf9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "947a9b02-2f13-46dc-823b-3aef65f30430",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "baeec987-b56e-4330-8b87-4b75cff72119",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ce98648b-425a-444b-9b7d-1cb0a5f49e54",
"_parent_code": "sample string 6",
"sales_organization_id": "de4cc1e8-d690-41d3-9a7f-8cef7903dd02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
},
"equipment_model_id": "4db200b2-6308-4ede-a1a6-93750caabf79",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aaa4021f-f090-446c-babc-151c5d22b6e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0898a82c-f59d-4d44-a6da-1fc413750a52",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b5ee65b2-d0f8-41da-9171-fc3a8ad1241c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "682e74a3-2757-4c1b-bf9c-9adad3c0154d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
},
"equipment_family_id": "b53e3c95-a027-4295-a308-055c2f593bfb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "baeec987-b56e-4330-8b87-4b75cff72119",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ce98648b-425a-444b-9b7d-1cb0a5f49e54",
"_parent_code": "sample string 6",
"sales_organization_id": "de4cc1e8-d690-41d3-9a7f-8cef7903dd02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
},
"date_in_production_since": "2026-09-03T21:44:03.6177932+00:00",
"date_out_of_production_since": "2026-09-03T21:44:03.6177932+00:00",
"date_end_support": "2026-09-03T21:44:03.6177932+00:00",
"sales_organization_id": "a82cdeca-319c-496b-acfe-ba180e1d2eeb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+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-09-03T21:44:03.6177932+00:00"
},
"project_status_id": "84c3153a-45a5-45a3-9cdd-655446b30835",
"project_status_code": "sample string 10",
"project_status": {
"id": "45298d4c-8761-47da-a381-6269e97d1c08",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9c8b0932-9f18-41bd-957e-65ea3fde54e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
},
"company_id": "6b19efff-fcef-4f89-b63b-aec838d78f1d",
"company_code": "sample string 12",
"db_address_id": "6883f924-2bca-4810-874e-26b47ed54c8d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "be4499a0-2cce-4a53-8c7a-589bcdc43369",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "beec451b-22e0-4b2b-ad51-81930755c4a4",
"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-09-03T21:44:03.6177932+00:00",
"date_create": "2026-09-03T21:44:03.6177932+00:00",
"date_update": "2026-09-03T21:44:03.6177932+00:00",
"updated_by_user_id": "7e8a551f-6279-4ac0-a5e9-67ad11df1021",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-03T21:44:03.6177932+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-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-03T21:44:03.6177932+00:00",
"date_last_job": "2026-09-03T21:44:03.6177932+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-03T21:44:03.6177932+00:00",
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00",
"is_mobile_installation": true
},
"job_type_id": "0a9b8171-1ee5-4ed0-85e5-26b50539a17f",
"job_type_code": "sample string 7",
"job_type": {
"id": "77f2dd7b-ab98-42de-b6e3-290f0df067b8",
"name": "sample string 2",
"sales_organization_id": "5d4e827f-ba5c-4bf1-b994-d7d79fb99b3e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00",
"code": "sample string 7"
},
"job_priority_id": "9f45275e-4e78-4369-a61c-e0d3d71e3440",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bffa7d2f-6703-49ce-9c6c-698b476f2e0a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "71c12380-e516-43b8-8c22-5252fdafd678",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
},
"job_status_id": "32243428-151d-43b6-a0cc-e1d3cc6ce4f9",
"job_status_code": "sample string 11",
"db_address_id": "f0b49879-48c8-458c-aed1-475c368218bc",
"contact_id": "64fb45b8-a565-475e-b431-b9f3aa9e78e0",
"requested_by_company_id": "302e2f52-89bb-4636-97c2-3ebc32bb7ff3",
"requested_by_contact_id": "291707ba-487d-4030-8eb8-ee3208b635fc",
"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-09-03T21:44:03.6177932+00:00",
"due_date": "2026-09-03T21:44:03.6177932+00:00",
"date_create": "2026-09-03T21:44:03.6177932+00:00",
"date_update": "2026-09-03T21:44:03.6177932+00:00",
"date_closed": "2026-09-03T21:44:03.6177932+00:00",
"suggested_user_id": "21f53940-7e32-4c2c-92e6-98ad74790646",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a8207eef-68c8-436b-95c4-d730a98db969",
"db_language_id": "e0d97524-c8d9-4c8a-8657-698f902dbfe7",
"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-09-03T21:44:03.6177932+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "516f9e0b-1cd7-4251-b925-c22a9ad219e1",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9766991a-edb1-4a77-a17e-b8d5d7acdcb8",
"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": "f72521ad-fe97-4847-889f-fd6c4a2e8bd1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c51a22ec-6b2e-4563-9e57-49ddc341da00"
},
"suggested_date_start": "2026-09-03T21:44:03.6177932+00:00",
"skill_id": "ef9ce1cf-cb25-47be-b1ad-29eab1a8ef48",
"skill_code": "sample string 32",
"skill": {
"id": "420126f8-dbc4-41d9-9483-bb91362dad43",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "56acb663-6644-49d1-b034-e8903e7d585e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "944b04c0-d385-47e8-9fdf-12a93b9734c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e426a2c-386c-4bb2-87e9-8d247d4776ff",
"db_currency_id": "c669a989-2de7-48b9-b1d7-738c87e04f08",
"db_language_id": "18f283e5-c763-48a6-a60a-6ea8ae5d01fe",
"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-09-03T21:44:03.6177932+00:00"
},
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "41f5e97a-8134-432e-b5a6-5c4c99ea7de8",
"date_reported_by_company": "2026-09-03T21:44:03.6177932+00:00",
"id2": 36,
"company_id": "ff2f180d-4a84-4b1f-acf7-e8821ef4734a",
"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": "f0224ab2-5036-45a0-8298-1d962c088afd",
"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-09-03T21:44:03.6177932+00:00"
},
"work_instruction_details_id": "a0095f02-d98a-4287-a054-de879c917bfa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "df3c4f52-c732-43a3-b3eb-3f5fc339b2a3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "15db953e-87a6-427b-a46d-a69fe6ff2cf5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-03T21:44:03.6177932+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": "be274cc5-6380-460f-bb98-d5892d1406eb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-03T21:44:03.6177932+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.