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": "0e860780-8fe8-4f49-9192-68a1fff3f8b6",
"jobs_id": "5597c218-de22-422c-85b8-e6f6cad89787",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8b0d7017-e433-4ec3-a39d-311246ce3692",
"_parent_id": "162871cd-18a9-4e8d-981c-dc36a926bbf9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a7b7619a-f34b-48bc-bd3d-764758c23444",
"project_reference_back_office": "sample string 5",
"project": {
"id": "09e73d11-d826-42b6-acac-fa4bb6169eca",
"_parent_id": "5187deee-c1bb-42cd-8990-733d6b67d0d2",
"root_parent_id": "91b3539f-d930-4fd6-af9f-3d4d0d18c82b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bb863ffd-c04e-4bf6-b89c-1cf0789c711c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9346b679-82c3-4737-8469-91578f6c6ba9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad604c43-9af9-45d0-aa8c-b5718b21df03",
"_parent_code": "sample string 6",
"sales_organization_id": "2c2f87c6-8311-45f5-9fcf-4f32360975f9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"modified_dateutc": "2026-10-05T09:52:01.6802627+00:00"
},
"equipment_model_id": "34d1c13c-efab-45a6-8d58-27cb7ff5d55e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "066e9cd4-199c-456c-b4ca-2e32564c6e79",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4b40acd1-66f0-4f01-9dfe-0164aaa4872d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "618c4551-4e1b-4dfe-b792-29a9c3d9defa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5ba877a0-44b3-46d9-88d1-e73519b7caa1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"modified_dateutc": "2026-10-05T09:52:01.6802627+00:00"
},
"equipment_family_id": "16d82533-aa0b-4ebf-84ca-251d0000e004",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9346b679-82c3-4737-8469-91578f6c6ba9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ad604c43-9af9-45d0-aa8c-b5718b21df03",
"_parent_code": "sample string 6",
"sales_organization_id": "2c2f87c6-8311-45f5-9fcf-4f32360975f9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"modified_dateutc": "2026-10-05T09:52:01.6802627+00:00"
},
"date_in_production_since": "2026-10-05T09:52:01.6802627+00:00",
"date_out_of_production_since": "2026-10-05T09:52:01.6802627+00:00",
"date_end_support": "2026-10-05T09:52:01.6802627+00:00",
"sales_organization_id": "ad7acf3a-19c5-4d42-8cd2-bcd35f18720d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+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-10-05T09:52:01.6970976+00:00"
},
"project_status_id": "93bc8aba-0f6e-4c96-8f54-e29752a51a7b",
"project_status_code": "sample string 10",
"project_status": {
"id": "4c202d2f-81c4-4eff-acc5-43b073a96676",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bc3f2aeb-289e-4601-a889-3fcc24e46669",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T09:52:01.6970976+00:00"
},
"company_id": "0dfe7072-6771-489f-86a5-abf841abd29d",
"company_code": "sample string 12",
"db_address_id": "f3eb6d14-d3d9-4189-a14a-04cad018d035",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a703efd8-8858-4542-8889-79a474ffda66",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6ca0bf15-a499-4f58-86cb-d4311e2f0619",
"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-10-05T09:52:01.6970976+00:00",
"date_create": "2026-10-05T09:52:01.6970976+00:00",
"date_update": "2026-10-05T09:52:01.6970976+00:00",
"updated_by_user_id": "62c71671-00e2-4455-9725-039584758727",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T09:52:01.6970976+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-10-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T09:52:01.6970976+00:00",
"date_last_job": "2026-10-05T09:52:01.6970976+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T09:52:01.6970976+00:00",
"modified_dateutc": "2026-10-05T09:52:01.6970976+00:00",
"is_mobile_installation": true
},
"job_type_id": "fee7b184-c4e2-42e5-babe-1bea22031e1c",
"job_type_code": "sample string 7",
"job_type": {
"id": "cf1fd283-47b5-43db-82c0-0f06d4f5c73a",
"name": "sample string 2",
"sales_organization_id": "90f732a7-dd10-4dc7-9102-6a4e388fdc26",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T09:52:01.6970976+00:00",
"code": "sample string 7"
},
"job_priority_id": "40bd1950-8d9b-454e-8463-a1a4232f3791",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "19933501-228f-4c6b-aaf1-274a05ab2c66",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4a6eb0ec-5f15-48a6-a1bf-3b5621d3e1c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T09:52:01.6970976+00:00"
},
"job_status_id": "17e2bd86-e666-4349-bd2f-640f450cd28d",
"job_status_code": "sample string 11",
"db_address_id": "72953ff7-0583-46b8-a351-05213fff33f3",
"contact_id": "87185cfa-5777-45e7-87de-0de94aa639fd",
"requested_by_company_id": "c0d85cbf-3a18-4da0-a0ba-46b515eead62",
"requested_by_contact_id": "96ff9a99-909c-4ca8-b1ae-8ea97ba2af19",
"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-10-05T09:52:01.6970976+00:00",
"due_date": "2026-10-05T09:52:01.6970976+00:00",
"date_create": "2026-10-05T09:52:01.6970976+00:00",
"date_update": "2026-10-05T09:52:01.6970976+00:00",
"date_closed": "2026-10-05T09:52:01.6970976+00:00",
"suggested_user_id": "ca5711a6-0737-46dc-ac22-950797a91269",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f02e53b1-0864-49aa-9eb0-b5df83e8bd66",
"db_language_id": "57ac04be-8f7e-4408-9197-5344282b5142",
"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-10-05T09:52:01.6970976+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "272636dd-79b4-4279-a2e3-047663e61ac6",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ff6a53ba-7e71-4798-ab93-1e6097f25b93",
"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": "2eafc377-6f2b-4966-b63b-daba98ed2e80",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T09:52:01.6970976+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "15dcc418-0fd3-4623-bc2c-59c45454a086"
},
"suggested_date_start": "2026-10-05T09:52:01.6970976+00:00",
"skill_id": "4e3fd3fd-cd94-43fd-8f9b-9da1d6a5ad0f",
"skill_code": "sample string 32",
"skill": {
"id": "7462cd3f-b47a-47ed-baef-5e1a044a135c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1e0652e6-f09e-427e-ab25-3c4115e9654a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4f203c8-0593-4f02-bbd3-8934fea2d9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "35116233-9d7c-47ba-93ec-4f675d7f73ff",
"db_currency_id": "c34f98c3-65fd-4cad-a06c-0666272168b9",
"db_language_id": "259bba21-024c-4089-b533-890a506fd103",
"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-10-05T09:52:01.6802627+00:00"
},
"modified_dateutc": "2026-10-05T09:52:01.6970976+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4635de1d-d9b0-4287-b2fe-8b7479f4ffdd",
"date_reported_by_company": "2026-10-05T09:52:01.6970976+00:00",
"id2": 36,
"company_id": "252cad48-0788-41ff-88a9-f5dcc8f598b0",
"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": "e62993e8-1004-408f-9281-ea8f5e895d7f",
"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-10-05T09:52:01.6970976+00:00"
},
"work_instruction_details_id": "97e80d4c-5d7c-4fa5-b32d-11b4b51d6844",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1d696080-e62b-457c-af2c-8cbcdc47eb2b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f683f7d-29df-4489-b615-30e420ba16b0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T09:52:01.6970976+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": "62c40e03-e205-40ab-ae2d-1e7b53f26775",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T09:52:01.7272304+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.