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": "cc866647-5d0a-4ffe-9074-0d6b16abd929",
"jobs_id": "645e059e-ddd0-40d1-959b-216fad7b7640",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aeb6908e-3d51-4779-bd9d-7376bb5d0fb5",
"_parent_id": "5a00554d-85ea-4d4b-82d7-9a35df1cbf90",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b299f2f6-e1b2-47a3-8f27-c5fd34005244",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2f7435fa-eff1-4661-8ac3-33ef5bee75d7",
"_parent_id": "5543ebfd-d033-489e-b728-0745df78c766",
"root_parent_id": "019ac652-fcde-4ad5-89b2-7c949ef71bdd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a1b1b0cc-8932-41ff-bfaa-c835d1cb3c10",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "62c7859a-62de-4ca9-99f3-8a3856e48a0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1fd4a63-c42b-46f0-b552-aeb862d63f2e",
"_parent_code": "sample string 6",
"sales_organization_id": "b1ea65bf-c88f-472a-977e-de9f37139e31",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"modified_dateutc": "2025-12-17T00:38:18.4558254+00:00"
},
"equipment_model_id": "2a537004-8c85-4227-a455-c2c8965c0955",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bd9f265b-ce7b-497f-891e-a8d724a14468",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a11d4a6f-80d3-4336-ab56-310d762eba45",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "789ae83c-e156-402c-a2b3-1857a8bcfe10",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e0dbb982-fed2-40ea-ba51-5e0613b9dcdd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"modified_dateutc": "2025-12-17T00:38:18.4558254+00:00"
},
"equipment_family_id": "ffc9b2cd-f023-4ae8-a330-643951097477",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "62c7859a-62de-4ca9-99f3-8a3856e48a0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1fd4a63-c42b-46f0-b552-aeb862d63f2e",
"_parent_code": "sample string 6",
"sales_organization_id": "b1ea65bf-c88f-472a-977e-de9f37139e31",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"modified_dateutc": "2025-12-17T00:38:18.4558254+00:00"
},
"date_in_production_since": "2025-12-17T00:38:18.4558254+00:00",
"date_out_of_production_since": "2025-12-17T00:38:18.4558254+00:00",
"date_end_support": "2025-12-17T00:38:18.4558254+00:00",
"sales_organization_id": "412d3692-3223-4ad1-b57e-b954fc834b10",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+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-12-17T00:38:18.4558254+00:00"
},
"project_status_id": "5fd0f0f7-8e9f-472f-b357-05340086ca4d",
"project_status_code": "sample string 10",
"project_status": {
"id": "b55f99f1-c15a-447b-b345-9a8f6980287e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "100989f7-20c3-46f9-800b-4a839682ffdb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-17T00:38:18.4558254+00:00"
},
"company_id": "591500c9-fd25-4eba-92a2-6596ad71f251",
"company_code": "sample string 12",
"db_address_id": "a187c38b-499f-41b5-a670-adb449018736",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0f2a08ee-034a-41aa-a1b9-82b34d7c9867",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1a784a9f-8735-441a-a351-1692ade2e023",
"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-12-17T00:38:18.4714488+00:00",
"date_create": "2025-12-17T00:38:18.4714488+00:00",
"date_update": "2025-12-17T00:38:18.4714488+00:00",
"updated_by_user_id": "2b37a53f-8924-4a63-b8c9-c48cebe8c1fe",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-17T00:38:18.4714488+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-12-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-17T00:38:18.4714488+00:00",
"date_last_job": "2025-12-17T00:38:18.4714488+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-17T00:38:18.4714488+00:00",
"modified_dateutc": "2025-12-17T00:38:18.4714488+00:00",
"is_mobile_installation": true
},
"job_type_id": "41d64a73-deec-4564-aed4-e30fe3d7109b",
"job_type_code": "sample string 7",
"job_type": {
"id": "defe619c-1760-4cee-afa7-ebcfa800bc7d",
"name": "sample string 2",
"sales_organization_id": "058b8cb1-2902-48cc-8c04-eedbfe70da31",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-17T00:38:18.4714488+00:00",
"code": "sample string 7"
},
"job_priority_id": "b3c21c81-7f2a-4bb3-8603-166778a52041",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6120280d-3b08-4632-ac07-eac01c83af7b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "efba6eaa-5902-4a2c-929b-64cdb234c7ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-17T00:38:18.4714488+00:00"
},
"job_status_id": "30ed9773-9df9-4f73-97e2-300ed069d82d",
"job_status_code": "sample string 11",
"db_address_id": "2520b35a-1af5-4d41-9070-4afe546a2c52",
"contact_id": "a9d60584-cde9-4902-b39f-2d83a055fef0",
"requested_by_company_id": "2611aa20-68e7-4e1e-ad97-e02b1274a9f5",
"requested_by_contact_id": "b63c8a4a-3b23-48a3-b449-d7bac64ec12a",
"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-12-17T00:38:18.4714488+00:00",
"due_date": "2025-12-17T00:38:18.4714488+00:00",
"date_create": "2025-12-17T00:38:18.4714488+00:00",
"date_update": "2025-12-17T00:38:18.4714488+00:00",
"date_closed": "2025-12-17T00:38:18.4714488+00:00",
"suggested_user_id": "5b72225f-e4e3-4737-8bcf-3583122d6ee9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a88eda01-f067-49c7-8495-bd8daf4fafc2",
"db_language_id": "eba1ba34-282e-42ee-9971-8adc200bf410",
"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-12-17T00:38:18.4714488+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d56c56a9-8225-4bdd-89a1-92cc565f9c0c",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b6efe166-9fd4-49c4-9594-5725ac0ae469",
"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": "e3eef6e0-84bf-4e87-8111-ecf29a45bef5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-17T00:38:18.4714488+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "01dfc92b-9ec8-4871-a942-31d389bca98a"
},
"suggested_date_start": "2025-12-17T00:38:18.4714488+00:00",
"skill_id": "7329eeba-3fd4-4833-850c-e61667ca6d8c",
"skill_code": "sample string 32",
"skill": {
"id": "84eb48bc-f95e-460f-9ecf-2053b135f4b2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a70b8a4c-8c3e-4cc8-bb11-2f127e72d035",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa577a04-20d2-4797-b6ae-8c0fd5e35443",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec5549e8-e03d-420e-900b-32d870ee3f3c",
"db_currency_id": "5a7508d1-13b9-45aa-98a5-24b61ad56a94",
"db_language_id": "48eeaaa4-3771-4ab9-8887-c0ba873a8e75",
"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-12-17T00:38:18.4558254+00:00"
},
"modified_dateutc": "2025-12-17T00:38:18.4714488+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "58c372c8-d8c8-4a39-981b-a23fa9261380",
"date_reported_by_company": "2025-12-17T00:38:18.4714488+00:00",
"id2": 36,
"company_id": "7bea5403-e5c7-4ccb-a1ef-733808674167",
"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": "9803ab1e-e939-4799-998f-6f8c681d34d3",
"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-12-17T00:38:18.4714488+00:00"
},
"work_instruction_details_id": "48019602-0106-44ea-b2e0-dc3c09fce367",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a04afa7c-be91-426d-af8f-b5bc468ce8e4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3b268c19-fd56-486b-9d4a-b95b889e1812",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-17T00:38:18.4714488+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": "161d82f9-f501-49b4-9d11-1aacb3a6468c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-17T00:38:18.4714488+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.