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": "67327d89-f548-4f46-9e26-b421e0c07ab7",
"jobs_id": "07f108de-558b-42b0-b184-f20a54906b66",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3b80055f-c607-4e4b-aeae-6b4d12dbf3c7",
"_parent_id": "f384345a-84fe-4969-933a-c65e3f2b33e3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7256e81e-78c2-4a6b-ad36-4a17cddc290d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cc2cbd1d-bf0a-4ed3-9922-7872594871fb",
"_parent_id": "f4ba29b8-9e89-4039-9eba-495934ae3e70",
"root_parent_id": "79e34736-ebf2-4b6f-b0e7-31661bdb3e49",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1b8d44cf-c085-4569-a391-5e4e58cc3349",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cc8671b4-96d4-476a-a01f-a0b7c1cf22c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df493aca-f1a0-4b82-9ac1-190114cfd5a6",
"_parent_code": "sample string 6",
"sales_organization_id": "4101b718-73ac-489d-95c8-515934f93886",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
},
"equipment_model_id": "b2bf7815-5932-47f2-9202-d481af8ca64c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "12c3f06f-b847-4f7a-8d60-557857d250aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "763558fc-6ee8-4bda-88de-50f139cadeaf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ec278763-2c8e-4bdf-bb3c-a9a045e65f77",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a07eee19-e684-4d90-81a9-b001c357c455",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
},
"equipment_family_id": "32c864e3-3fa4-4411-b7c3-7eafee318b86",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cc8671b4-96d4-476a-a01f-a0b7c1cf22c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df493aca-f1a0-4b82-9ac1-190114cfd5a6",
"_parent_code": "sample string 6",
"sales_organization_id": "4101b718-73ac-489d-95c8-515934f93886",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
},
"date_in_production_since": "2025-11-21T17:26:21.5466295+00:00",
"date_out_of_production_since": "2025-11-21T17:26:21.5466295+00:00",
"date_end_support": "2025-11-21T17:26:21.5466295+00:00",
"sales_organization_id": "dfb7d9a7-19bc-4484-9b68-ce4fa35142e2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+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": "2025-11-21T17:26:21.5466295+00:00"
},
"project_status_id": "9a8a9cac-f56e-42fe-9daa-ba686577d25b",
"project_status_code": "sample string 10",
"project_status": {
"id": "31a8246a-7982-456c-bee8-14a0c011acf3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "64a14b56-f23b-4531-bb45-3ab03ffe6456",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
},
"company_id": "6e01f55d-8925-4cf6-8916-f2392e0de20c",
"company_code": "sample string 12",
"db_address_id": "03f14702-a0cc-4679-8999-e7d51ed0dd62",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "75fcabe0-9b39-4f36-a302-1d1056bd5b02",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5543d721-8ed7-48bf-ace0-226906eeef01",
"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": "2025-11-21T17:26:21.5466295+00:00",
"date_create": "2025-11-21T17:26:21.5466295+00:00",
"date_update": "2025-11-21T17:26:21.5466295+00:00",
"updated_by_user_id": "5e06e475-cf2b-4abc-9787-41522261cd37",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-21T17:26:21.5466295+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": "2025-11-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-21T17:26:21.5466295+00:00",
"date_last_job": "2025-11-21T17:26:21.5466295+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-21T17:26:21.5466295+00:00",
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00",
"is_mobile_installation": true
},
"job_type_id": "b806edc1-5536-4635-ae23-86f214fcb9ac",
"job_type_code": "sample string 7",
"job_type": {
"id": "b1481863-a605-4b6d-8d23-df52287cdf7e",
"name": "sample string 2",
"sales_organization_id": "295d6d4e-9512-44fc-8940-72819e907679",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb05561e-439f-4348-855d-67d3958b202d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b802758d-1f26-484e-b37e-ed5633dc66ee",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4ae8f3d3-662a-46ad-8249-49094800bdd6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
},
"job_status_id": "8195d66b-4a11-4a50-833f-5ce5f81fee78",
"job_status_code": "sample string 11",
"db_address_id": "2f695599-cf2e-4a2e-b176-54e97991834f",
"contact_id": "db6073b7-5d88-4306-977a-ff97c8d8eabb",
"requested_by_company_id": "a1de9d32-0a07-4714-b0a4-aeecd7fa2f4f",
"requested_by_contact_id": "327a36a3-8324-48cd-8229-e127ababe346",
"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": "2025-11-21T17:26:21.5466295+00:00",
"due_date": "2025-11-21T17:26:21.5466295+00:00",
"date_create": "2025-11-21T17:26:21.5466295+00:00",
"date_update": "2025-11-21T17:26:21.5466295+00:00",
"date_closed": "2025-11-21T17:26:21.5466295+00:00",
"suggested_user_id": "f1de7ab5-8a05-4e2e-b3d7-6b1661d3180b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cddc47b8-8f9d-4e63-9f1b-ab97f743c7b4",
"db_language_id": "e6282ac4-361e-4645-b550-b5f508cd0da2",
"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": "2025-11-21T17:26:21.5466295+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c3b4ecd0-10d3-40f0-bad8-1b4b49cffe7e",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fef49a6b-cd57-46e4-907b-b3d99e6b4240",
"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": "150c4daa-9584-4a84-9754-6515c8234837",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1c683f9c-c9a3-4460-92fe-f184d47c989a"
},
"suggested_date_start": "2025-11-21T17:26:21.5466295+00:00",
"skill_id": "2d7f96bd-79d0-41fd-b0a4-31f31658fcf9",
"skill_code": "sample string 32",
"skill": {
"id": "8ad0b2bf-afb0-4580-a8e3-1d11c41e39f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e6e56f54-dadd-4638-a89e-291b4dfe6981",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4444bb19-ccc3-45d8-aa41-e1f9ae42da77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4a0ccbab-f712-4a4f-95a2-83e8fe1d1bf9",
"db_currency_id": "f5c40998-7346-4cc5-b926-80b4fa51c52c",
"db_language_id": "409dda09-c516-4dd9-8f85-dac6d7cc30ef",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "09758e18-c641-4c72-858a-ad54781bb010",
"date_reported_by_company": "2025-11-21T17:26:21.5466295+00:00",
"id2": 36,
"company_id": "6e44a166-6299-49e9-8a23-418ece21b3e8",
"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": "b4f42dd4-8142-4e33-ba1a-13d1d6e53de1",
"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": "2025-11-21T17:26:21.5466295+00:00"
},
"work_instruction_details_id": "36794e6e-1af5-4a2c-a1c3-76dd2821d1e8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4cf24595-04e6-4f86-9e6d-d849dadfcaca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3dc8eb91-60f4-4ecb-9a9a-eb2990618dbb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-21T17:26:21.5466295+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": "484ea719-8f53-4456-8b73-abaa68d11374",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-21T17:26:21.5466295+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.