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": "f21d56ef-c3d1-43d6-a859-aa7696869863",
"jobs_id": "27f323db-d8a4-4881-a798-99a0ba0e9e27",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c4fca82d-aae8-425f-9d1b-0ba4006cba84",
"_parent_id": "47aff8af-b384-4920-ae15-a8caa57a77f8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "072f184f-3d30-4b9c-92bc-c89b1666181a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60192aa6-67b6-4c2e-8393-e9d74e34aa92",
"_parent_id": "ce125aaf-5bc3-4158-9cfb-82ce98aecb07",
"root_parent_id": "a9dd33c1-417a-47f9-81db-f67e52caebf2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0516806c-7ada-4c6c-908f-17d358b30b2f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5cb5455b-b15d-4e9a-85ec-7fbf46858ae2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a6b69094-a97e-4a93-87af-f919cd17ae94",
"_parent_code": "sample string 6",
"sales_organization_id": "933de4a0-f82a-4fe1-ae50-e70378bfb6bc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
},
"equipment_model_id": "493603e7-2567-451b-b555-42360f93ea9c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b9d2347e-5f4e-459d-972a-1e466e7853a3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "66ec0644-6f1d-40a1-8114-68fa4d3fa459",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "633dab19-b49f-43a7-a449-4d23fe07f80f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0853bc44-d3be-4476-ab06-3f63b65727af",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
},
"equipment_family_id": "52c4ff9e-86b8-46b2-904a-edd137f19d32",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5cb5455b-b15d-4e9a-85ec-7fbf46858ae2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a6b69094-a97e-4a93-87af-f919cd17ae94",
"_parent_code": "sample string 6",
"sales_organization_id": "933de4a0-f82a-4fe1-ae50-e70378bfb6bc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
},
"date_in_production_since": "2026-05-08T13:27:42.3742552+00:00",
"date_out_of_production_since": "2026-05-08T13:27:42.3742552+00:00",
"date_end_support": "2026-05-08T13:27:42.3742552+00:00",
"sales_organization_id": "0c28292c-fbb4-475e-abc2-aa3bf908b4e6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+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-05-08T13:27:42.3742552+00:00"
},
"project_status_id": "86458513-c8ba-42fa-8893-93a51b38712e",
"project_status_code": "sample string 10",
"project_status": {
"id": "80effaac-9f5b-4f88-abe7-84834d729693",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "665b695d-e3f7-42a4-8381-2746e4d1c0e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
},
"company_id": "3f850e73-6252-4047-97d2-148094a76ba9",
"company_code": "sample string 12",
"db_address_id": "a43ebab4-bf0c-426b-b3a0-bc5ae30a128d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "66086d2f-c6e2-40f7-a216-29264569a57b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8431a32f-8c9c-452e-811f-be82afb2efb9",
"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-05-08T13:27:42.3742552+00:00",
"date_create": "2026-05-08T13:27:42.3742552+00:00",
"date_update": "2026-05-08T13:27:42.3742552+00:00",
"updated_by_user_id": "0d0de5e1-0fc9-4834-bcbd-0ddeb404077c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-08T13:27:42.3742552+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-05-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-08T13:27:42.3742552+00:00",
"date_last_job": "2026-05-08T13:27:42.3742552+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-08T13:27:42.3742552+00:00",
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00",
"is_mobile_installation": true
},
"job_type_id": "5b1f1ef7-7f4d-42a7-aadc-0679c7c9e275",
"job_type_code": "sample string 7",
"job_type": {
"id": "0fa702a0-1a61-4069-ab0f-b2b8d94ff5e0",
"name": "sample string 2",
"sales_organization_id": "77a80f55-ba49-4cb8-b569-cd36479edfbf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00",
"code": "sample string 7"
},
"job_priority_id": "d4fe5c26-3346-4b8b-94f2-385cd614ec24",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "61cfc266-dec1-47df-87ff-42fcaae7bd94",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c8b2a09e-6aca-4259-bb3b-03f45a957100",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
},
"job_status_id": "25d9eb2a-40f7-4f16-84a8-25e98d193818",
"job_status_code": "sample string 11",
"db_address_id": "64653347-9afb-45dc-95b7-4a8c376379a9",
"contact_id": "b88ab439-e6e6-46da-acf1-5df055b395a9",
"requested_by_company_id": "66a4b06b-52b2-4f27-8bbb-6344207ec166",
"requested_by_contact_id": "a5a75597-ebe4-426d-8a47-d4d39b40ce30",
"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-05-08T13:27:42.3742552+00:00",
"due_date": "2026-05-08T13:27:42.3742552+00:00",
"date_create": "2026-05-08T13:27:42.3742552+00:00",
"date_update": "2026-05-08T13:27:42.3742552+00:00",
"date_closed": "2026-05-08T13:27:42.3742552+00:00",
"suggested_user_id": "2ec4ef01-96b3-46c3-920b-0717a877e6bc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0e19bfd5-2c4a-4fe6-9497-854f0e9994fd",
"db_language_id": "99646344-89bb-4f6a-ae67-5640ec06959f",
"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-05-08T13:27:42.3742552+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "124d04f3-7c85-4ce7-b1e7-3d92be6e50c0",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "12e5e0a3-a463-4af9-a616-d9c1d066bb70",
"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": "cbb4a37d-c860-4e03-90fe-1e1b34530e92",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9ee6f6e0-23ad-4d46-87eb-2bbea9ddaa88"
},
"suggested_date_start": "2026-05-08T13:27:42.3742552+00:00",
"skill_id": "d6493f24-a3ca-437c-b12a-f8421c8e4d68",
"skill_code": "sample string 32",
"skill": {
"id": "49b8eccb-adf8-4d89-a99c-bd5acb20d0c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0f6d0cc9-d8db-44b8-85bd-2570775954dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "868ed95b-8f50-4b75-964e-a7b45db7e23c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f193e34e-6cb7-4fb1-ae75-0d4d576b8436",
"db_currency_id": "9ab1138c-a172-45e7-9d8d-68f38fb60bd8",
"db_language_id": "58fea625-81f7-49f8-b1d6-0e87deaff62b",
"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-05-08T13:27:42.3742552+00:00"
},
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b40ba8e5-da1a-4269-b6b5-f0ae37ee7c3e",
"date_reported_by_company": "2026-05-08T13:27:42.3742552+00:00",
"id2": 36,
"company_id": "c33abb16-4f34-4965-b8e7-a5d3e15d115e",
"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": "93dcf342-dc5f-4429-93db-70df03a8c6c8",
"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-05-08T13:27:42.3742552+00:00"
},
"work_instruction_details_id": "0085dcc6-bb43-4871-8222-b48610bd0f75",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "41abf22a-ad30-4649-9de0-57aab2ef6fae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1f493bd0-f13d-4ac1-a422-41295939c3d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-08T13:27:42.3742552+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": "3656380c-6206-4340-b9a8-e10653c095f6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-08T13:27:42.3742552+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.