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": "5b021712-1ffa-4f49-b798-3f275b29c237",
"jobs_id": "df30f470-16e8-4fff-9fdc-f157b8426176",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d616b7b6-bbbc-4f51-bcd0-85b16528b5fd",
"_parent_id": "267d3be4-116f-4d25-9608-7b8b0f3ba19e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9198e4ea-6ae4-42ce-a769-4b46901c704d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1fef07a5-19a2-46db-bda6-b42b36fd284c",
"_parent_id": "837dca81-05c1-4916-9ca7-20ff4c7b705e",
"root_parent_id": "53307457-3f0d-40db-9cc1-d7b0ae239854",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a4a0fa4b-1502-4123-8bf6-12a0a1b3b4e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8b0f416f-77b9-406d-9668-853e8f8fefc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "651ceada-c006-40da-932a-9df1f50cdd38",
"_parent_code": "sample string 6",
"sales_organization_id": "2c5c9f97-a30f-417b-9176-a445ae113408",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
},
"equipment_model_id": "58602151-49c6-4385-a062-36de5d4dfb3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d9a633bc-0971-4576-8e1c-f0a0c1ba49c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e19f5c97-c4c7-4087-801f-1518e22c9759",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "db4f1421-ad5a-480c-8d97-7df68cd9c39a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2db81a34-3d4f-4ed8-9e4b-21de277e9d6b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
},
"equipment_family_id": "03f061e4-bad8-4772-9d8d-7ff461f06fdf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8b0f416f-77b9-406d-9668-853e8f8fefc2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "651ceada-c006-40da-932a-9df1f50cdd38",
"_parent_code": "sample string 6",
"sales_organization_id": "2c5c9f97-a30f-417b-9176-a445ae113408",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
},
"date_in_production_since": "2026-02-08T16:13:20.1382078+00:00",
"date_out_of_production_since": "2026-02-08T16:13:20.1382078+00:00",
"date_end_support": "2026-02-08T16:13:20.1382078+00:00",
"sales_organization_id": "37d9ef8e-b741-4d6c-97f7-04ba0ea37c2a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+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-02-08T16:13:20.1382078+00:00"
},
"project_status_id": "9bd74f84-38dd-4820-9a42-98d10e16f95f",
"project_status_code": "sample string 10",
"project_status": {
"id": "66004cbd-0690-4e42-a534-684e6c152d3a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ba6e900c-2ed7-44f2-8794-2906de43adc5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
},
"company_id": "6a6ec4b8-e8fc-4eac-b8f9-487668d7bed6",
"company_code": "sample string 12",
"db_address_id": "4ec6ca63-fb71-484a-b033-bee89fdf749e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "02bc2d77-b6be-4737-95e5-9aa93ea96a2c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "19217c75-808b-4fe5-a7b3-4b6c8e40627a",
"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-02-08T16:13:20.1382078+00:00",
"date_create": "2026-02-08T16:13:20.1382078+00:00",
"date_update": "2026-02-08T16:13:20.1382078+00:00",
"updated_by_user_id": "5cc6939c-214a-46b9-9a36-aae38a736e16",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-08T16:13:20.1382078+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-02-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-08T16:13:20.1382078+00:00",
"date_last_job": "2026-02-08T16:13:20.1382078+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-08T16:13:20.1382078+00:00",
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00",
"is_mobile_installation": true
},
"job_type_id": "80bbd3ba-4dcf-4f72-9dca-eae1d0d0553e",
"job_type_code": "sample string 7",
"job_type": {
"id": "872b1568-3c84-4ec4-ab37-80a85b8f8938",
"name": "sample string 2",
"sales_organization_id": "7d7b3b2c-5abc-4c2e-87fb-4f40ed9e44d8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00",
"code": "sample string 7"
},
"job_priority_id": "248e4bda-6240-4c46-83e2-24e7fe4912d1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e5deb1e3-0e93-485a-9371-8a331b19ac56",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "85a7f859-7450-4f08-930a-0decd8c06cad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
},
"job_status_id": "35031a63-4da1-4db8-b649-a44412fe209f",
"job_status_code": "sample string 11",
"db_address_id": "3303f810-3ad4-4805-bd77-ba03f0029ccc",
"contact_id": "136df711-e13b-4d89-883f-eb7022fb1fa0",
"requested_by_company_id": "667ad334-018f-4d5b-866d-62be3ea5895e",
"requested_by_contact_id": "f0816910-2e88-4244-bd73-a2860d5a8352",
"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-02-08T16:13:20.1382078+00:00",
"due_date": "2026-02-08T16:13:20.1382078+00:00",
"date_create": "2026-02-08T16:13:20.1382078+00:00",
"date_update": "2026-02-08T16:13:20.1382078+00:00",
"date_closed": "2026-02-08T16:13:20.1382078+00:00",
"suggested_user_id": "a9d4ebb6-1592-419d-a4e2-2a83247dad9b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3bfbb23b-b530-4bae-bc31-9a4df2d70c7b",
"db_language_id": "d329c1ba-21b8-4b2e-9a36-b85c5bec71eb",
"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-02-08T16:13:20.1382078+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e3c95f1e-b3db-4ce5-8226-0df74830ec31",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "493ebde3-316f-4df6-9ea0-be94cb30719a",
"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": "0cf33bed-f205-4896-8546-de2e744458f3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "320b4718-37ca-4313-91e2-411a5545802e"
},
"suggested_date_start": "2026-02-08T16:13:20.1382078+00:00",
"skill_id": "769bd4bf-d1ac-47de-9070-15067b7e0585",
"skill_code": "sample string 32",
"skill": {
"id": "78d59378-785f-40be-967c-f0ebcda74184",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e611b747-172b-4e14-91b6-10455c30d20e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9599048d-563e-4f66-a7c4-8ce4b658e516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6851e2da-8f00-49bc-802f-8c09e5d49a90",
"db_currency_id": "5f704be0-8833-4e68-a823-92a3b17f783e",
"db_language_id": "de05b6b0-12e0-4ab1-babd-a991b9458065",
"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-02-08T16:13:20.1382078+00:00"
},
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f28d237-1ec2-46ee-a600-38dd483f0771",
"date_reported_by_company": "2026-02-08T16:13:20.1382078+00:00",
"id2": 36,
"company_id": "59ccba28-680c-4406-b4e5-a2153eb60b29",
"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": "d8d4e3d2-2f6d-4838-8177-b7329d38dd0e",
"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-02-08T16:13:20.1382078+00:00"
},
"work_instruction_details_id": "929169b1-4ac1-448f-ba93-3a37d8ff8bc7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4bc1bbd4-e5f6-49f9-9eb3-42de528fa633",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0b7b6dff-7a8a-4cab-8381-7ad382e32a47",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-08T16:13:20.1382078+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": "13d00b03-0375-4721-8516-641d22c297b5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-08T16:13:20.1382078+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.