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": "6679a5f1-7d18-4c7e-90b8-18ab76e8d79f",
"jobs_id": "45aefff6-77ef-4411-99b0-1f28bbdbf2d6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2f106bb5-78c5-49d8-b979-debe13dd4070",
"_parent_id": "13fb9ffe-0e55-4676-aa97-74a440439750",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "55c2e478-6a02-41a9-9f3f-a1c11b96401c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f4fbba33-36a9-4923-a861-fb155b31f59f",
"_parent_id": "d80cb739-d918-439f-a5cc-e8bf1bcbb3e6",
"root_parent_id": "d6e378f9-1bb7-424f-b17c-1bb34a242120",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "641b742f-1249-42c6-8093-1c7f982fcce2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "93403979-9622-43a2-b272-67c554370522",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "80e9af79-707f-49c8-a738-0f452fee8b43",
"_parent_code": "sample string 6",
"sales_organization_id": "51838eb3-2dee-449a-b98d-748e263b62e5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"modified_dateutc": "2026-04-05T14:36:37.2192993+00:00"
},
"equipment_model_id": "c784b6f1-a4bd-40fc-b3ea-aab7a1d5fb0d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4f53e32d-4fdb-448e-afee-d50c2f31bc9c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "530b99cb-1fbf-4090-aa65-bb07bdb620da",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6e9b93b6-40b1-4192-bacd-933a71f48bff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "94b0c4a4-94b5-44f3-98fc-c1683bd05c5f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"modified_dateutc": "2026-04-05T14:36:37.2192993+00:00"
},
"equipment_family_id": "77599911-62ac-4fad-84be-6d3de8c339af",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "93403979-9622-43a2-b272-67c554370522",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "80e9af79-707f-49c8-a738-0f452fee8b43",
"_parent_code": "sample string 6",
"sales_organization_id": "51838eb3-2dee-449a-b98d-748e263b62e5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"modified_dateutc": "2026-04-05T14:36:37.2192993+00:00"
},
"date_in_production_since": "2026-04-05T14:36:37.2192993+00:00",
"date_out_of_production_since": "2026-04-05T14:36:37.2192993+00:00",
"date_end_support": "2026-04-05T14:36:37.2192993+00:00",
"sales_organization_id": "476619c7-91f2-436e-a560-6060a4a476b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+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-04-05T14:36:37.2192993+00:00"
},
"project_status_id": "12f100b4-43b4-41d6-b770-f06697d2c7e7",
"project_status_code": "sample string 10",
"project_status": {
"id": "9afcf746-8f5d-4f05-81e9-2d84ef4d700d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "72e38618-3e1a-4b32-bd4f-997638a04cf0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-05T14:36:37.2192993+00:00"
},
"company_id": "c1006f8b-b88d-49d7-818c-6347751b074c",
"company_code": "sample string 12",
"db_address_id": "29c36cea-ec77-4aca-b6be-c1fc6377b1c9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b09497a9-1842-4723-afe5-533ace1ca835",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95c7e639-38f1-415e-8d9d-fe93bde65128",
"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-04-05T14:36:37.2192993+00:00",
"date_create": "2026-04-05T14:36:37.2192993+00:00",
"date_update": "2026-04-05T14:36:37.2192993+00:00",
"updated_by_user_id": "3f1957e0-bcda-4e57-a1ac-74b76e8b042a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-05T14:36:37.2192993+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-04-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-05T14:36:37.2348894+00:00",
"date_last_job": "2026-04-05T14:36:37.2348894+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-05T14:36:37.2348894+00:00",
"modified_dateutc": "2026-04-05T14:36:37.2348894+00:00",
"is_mobile_installation": true
},
"job_type_id": "0fd22f86-50c2-4e5b-99bd-fc2936e657a9",
"job_type_code": "sample string 7",
"job_type": {
"id": "bdab7422-4963-4f5e-98b2-f129efe67635",
"name": "sample string 2",
"sales_organization_id": "21390c94-2a2f-4db5-bfdc-8f2e43886f12",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-05T14:36:37.2348894+00:00",
"code": "sample string 7"
},
"job_priority_id": "62e2a234-fa7b-4b1a-ad54-3b6db4ebe2fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a337c2b6-bc60-4e5a-8e8d-9c0f4f6eb188",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a99c6fc9-6dea-49aa-9592-3d034ae38a64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-05T14:36:37.2348894+00:00"
},
"job_status_id": "f3653fc5-6f99-4543-8afb-0695abe61cae",
"job_status_code": "sample string 11",
"db_address_id": "f265f7a2-e223-42f1-90ad-33406e56a0be",
"contact_id": "fd138846-9a04-4dbf-acfe-e89696d2e0ad",
"requested_by_company_id": "36a5c706-ffd3-4649-9d17-441795a0226d",
"requested_by_contact_id": "7542933f-9e70-4fc6-a4d5-9254e9c74a2b",
"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-04-05T14:36:37.2348894+00:00",
"due_date": "2026-04-05T14:36:37.2348894+00:00",
"date_create": "2026-04-05T14:36:37.2348894+00:00",
"date_update": "2026-04-05T14:36:37.2348894+00:00",
"date_closed": "2026-04-05T14:36:37.2348894+00:00",
"suggested_user_id": "2ae7bb43-5338-4e23-a11b-ca00136f804e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2ce7af05-bbc6-4c2e-97bf-e9c409ac5a33",
"db_language_id": "f00c475f-ea58-4617-94fd-fff83e8d71ea",
"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-04-05T14:36:37.2348894+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a0a08844-406c-42f5-9f0e-c7a86d3b87f9",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1daf8e9c-545d-4504-8a66-c73c0d28e5e9",
"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": "8cb1e749-e4ce-4a06-b64a-695d624fc070",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-05T14:36:37.2348894+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e85722a4-d961-4723-8e98-d65b873cb1dd"
},
"suggested_date_start": "2026-04-05T14:36:37.2348894+00:00",
"skill_id": "eca997fc-fd8a-42eb-a0f8-b75ecd238615",
"skill_code": "sample string 32",
"skill": {
"id": "37efe007-169f-4e0b-94e4-c4e4c0a83bc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0744b3b3-a500-4fc4-b534-a8d1c297c87c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe9738c3-7051-4ddc-8342-f6f7b5d27509",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52ddae89-d66e-4e59-b067-6b48b1b8a0cd",
"db_currency_id": "d88007eb-597b-4787-842d-9bc15ba9ff62",
"db_language_id": "8035562f-f477-4354-a3b0-2f49ebe4e5cd",
"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-04-05T14:36:37.2192993+00:00"
},
"modified_dateutc": "2026-04-05T14:36:37.2348894+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "54ecb57c-b7b7-4f8b-ae12-0b33d61d07a9",
"date_reported_by_company": "2026-04-05T14:36:37.2348894+00:00",
"id2": 36,
"company_id": "517c31f5-ca2d-4082-9f15-0bdaf39c16f1",
"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": "fcdb1a1b-c666-4532-acf4-c7040084aabd",
"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-04-05T14:36:37.2348894+00:00"
},
"work_instruction_details_id": "d0989a4a-aaef-4258-a5e7-ba9e07dea23b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "730f705d-3783-4783-8856-dc231ccbc013",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e6ebd73e-eff9-40aa-963d-31dfdccc183f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-05T14:36:37.2348894+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": "a6ee0bfa-09a7-458c-b944-2bc49bd6890e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-05T14:36:37.2348894+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.