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": "e33d3f74-63db-496d-945f-32113d1fcb41",
"jobs_id": "f22f9f81-4076-444d-b657-ef8e8e487c6d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dcd21fa9-d4b9-4d42-907c-3e79cdfe04c9",
"_parent_id": "f9887ec2-2477-4eba-ad12-d28959d14904",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c26916b1-3aac-4958-bd93-f29f7debd0b6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cee9896e-b08b-424c-94ab-e06c0ab49999",
"_parent_id": "d33bc05b-94b9-4a99-85ac-515b6f6f0205",
"root_parent_id": "88dc7c33-9736-4b0f-9006-96e912cb38e6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "14a4e803-3f48-4f69-b636-c70f41a2bccb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "78a8ecad-143f-4abf-8125-808eba26525e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a79239ee-57f6-4171-a1b9-16cd860925b4",
"_parent_code": "sample string 6",
"sales_organization_id": "a68003af-9774-47f7-9928-6e059ed3a1bc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"modified_dateutc": "2026-10-10T22:02:51.2392657+00:00"
},
"equipment_model_id": "ea13a70e-93a4-486f-a4aa-48f898534479",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2abdf955-0efb-4c4f-ba83-0ec9faba7af3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8c4cb66c-9e7d-4574-a603-46610f5f6118",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c7dd7d5e-e647-4155-bca8-91d4c9d4b86d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4cc104d3-88d6-440d-b616-207e09e3ccd4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"modified_dateutc": "2026-10-10T22:02:51.2392657+00:00"
},
"equipment_family_id": "f142f496-4c97-4fd6-ae41-6f9472256b3c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "78a8ecad-143f-4abf-8125-808eba26525e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a79239ee-57f6-4171-a1b9-16cd860925b4",
"_parent_code": "sample string 6",
"sales_organization_id": "a68003af-9774-47f7-9928-6e059ed3a1bc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"modified_dateutc": "2026-10-10T22:02:51.2392657+00:00"
},
"date_in_production_since": "2026-10-10T22:02:51.2392657+00:00",
"date_out_of_production_since": "2026-10-10T22:02:51.2392657+00:00",
"date_end_support": "2026-10-10T22:02:51.2392657+00:00",
"sales_organization_id": "5c038d96-3b29-4901-a963-c90f4562ae0d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+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-10T22:02:51.2568871+00:00"
},
"project_status_id": "b0f7d99f-5564-45f6-929c-c1d8467fdfd1",
"project_status_code": "sample string 10",
"project_status": {
"id": "1bc20b38-6f03-402a-9d06-f0bb46e2a484",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2ad08675-5705-4344-bd62-fb5063b35600",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T22:02:51.2568871+00:00"
},
"company_id": "fa1c73fe-d2c5-4bf5-aab9-c6191615884e",
"company_code": "sample string 12",
"db_address_id": "af4d54a2-ac73-418b-9963-410c5dd5a373",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "52e74344-7e34-4a0a-aa15-df961b31d19d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7bffa2b3-bed9-4d58-aff8-b653abd8d1e3",
"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-10T22:02:51.2568871+00:00",
"date_create": "2026-10-10T22:02:51.2568871+00:00",
"date_update": "2026-10-10T22:02:51.2568871+00:00",
"updated_by_user_id": "5285abaa-ea7f-4feb-84dc-01c97e1fa6c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-10T22:02:51.2568871+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-10T22:02:51.2568871+00:00",
"date_last_job": "2026-10-10T22:02:51.2568871+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-10T22:02:51.2568871+00:00",
"modified_dateutc": "2026-10-10T22:02:51.2568871+00:00",
"is_mobile_installation": true
},
"job_type_id": "0eabb412-45e9-47da-a830-54caf47e099b",
"job_type_code": "sample string 7",
"job_type": {
"id": "d153d412-1819-4cc5-a0d8-83eaa153ae88",
"name": "sample string 2",
"sales_organization_id": "967cede4-e7e6-465c-b0fe-1a5477a46d46",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-10T22:02:51.2568871+00:00",
"code": "sample string 7"
},
"job_priority_id": "01790407-66d8-443a-b6c1-73cf924c310e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6c9eafb0-2097-4c45-a24e-4fafdea8c5dc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "56c12ca6-1781-4de8-98a8-6606caf0206f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T22:02:51.2568871+00:00"
},
"job_status_id": "a7caca86-08e3-4abb-adad-1e19306f88ba",
"job_status_code": "sample string 11",
"db_address_id": "14222d33-fc3c-48df-966f-70b493a32119",
"contact_id": "a9d1304d-13de-40a5-b9e7-203d4583bb8a",
"requested_by_company_id": "41970d95-6f5d-4195-aa5c-fe4448d5fb52",
"requested_by_contact_id": "9fcc0436-6950-40b9-a2a1-27796b27293c",
"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-10T22:02:51.2568871+00:00",
"due_date": "2026-10-10T22:02:51.2568871+00:00",
"date_create": "2026-10-10T22:02:51.2568871+00:00",
"date_update": "2026-10-10T22:02:51.2568871+00:00",
"date_closed": "2026-10-10T22:02:51.2568871+00:00",
"suggested_user_id": "4d196703-666a-47e3-a8c9-c31097342e6c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0d977975-c833-4175-83df-8faa6d8b0c38",
"db_language_id": "f9c61363-c8e2-4cf6-9685-6202fb7a3f8e",
"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-10T22:02:51.2568871+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ba85f509-89ea-4a3a-964f-4fa1ad70c297",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9a5662a4-aee4-4b82-9c30-3a07f1e4f1e2",
"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": "1ecc6169-511e-4446-902c-60d9964784bf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-10T22:02:51.2568871+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d62af354-b0bd-4953-a3af-046eb9bf4a7d"
},
"suggested_date_start": "2026-10-10T22:02:51.2568871+00:00",
"skill_id": "0da3a874-ed1f-4685-b617-4ebc6a347fa9",
"skill_code": "sample string 32",
"skill": {
"id": "c6b6869d-49fd-4b45-9996-3463cad2799c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2367dac2-37ec-4983-93c1-7e9838543002",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d2936054-3872-46fc-ae15-1d61aabe7f98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277224a1-babf-4f54-9aed-886eb42aee08",
"db_currency_id": "f7a31bda-688d-4ecd-9e2c-27f2aadde60c",
"db_language_id": "b6cd061a-90e9-441a-88b8-426bb2389b56",
"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-10T22:02:51.2392657+00:00"
},
"modified_dateutc": "2026-10-10T22:02:51.2568871+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "417e5779-24ed-453d-ae91-faed6da7ffbe",
"date_reported_by_company": "2026-10-10T22:02:51.2568871+00:00",
"id2": 36,
"company_id": "88427ad0-bc50-4081-bee5-4584774b039f",
"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": "cb6ac917-4c6b-4a7f-a776-b51d961e4bff",
"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-10T22:02:51.2568871+00:00"
},
"work_instruction_details_id": "907aa3cd-987a-4b3b-9220-5407ef6228b9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cf596c1f-4fb6-41c6-b034-d3e1114582e7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0351f42a-cb2c-425e-934f-97b589396f7b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-10T22:02:51.2568871+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": "52015ca3-3d02-4c22-b699-9058b0ecf021",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-10T22:02:51.270513+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.