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": "4ab6e29e-972a-4f81-a39c-623d96f7204c",
"jobs_id": "dafda91a-eab0-4210-ab82-b90bc9fa5129",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "baeae122-4512-42f6-94da-4c20985f7b1a",
"_parent_id": "dc2f238a-6ad0-4d29-a205-402a3a5179ff",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8cd0c941-adaf-4ab3-aa88-1b6817c0631b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6ffb15b7-9e14-4004-b7f9-5f8cd40945b1",
"_parent_id": "abfee134-1071-4d78-a3b3-1dd73f9f0ce1",
"root_parent_id": "1f613508-de49-41cb-a7fe-3ca0d27e75bb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d6303a38-3a7e-4ea7-b837-16be0a5aa16c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4a940368-c7ec-4ca3-80af-a6d58b97a988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7abde618-f8bb-4cda-b8f7-defe95c2b0e9",
"_parent_code": "sample string 6",
"sales_organization_id": "54b7de23-4d8d-4db3-889c-f015b30b735b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
},
"equipment_model_id": "07c54f03-872a-4fb8-8ba8-751c90ffb04b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "02a259f7-3a2f-49b1-a313-2325f6a23a2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e76391bc-868d-4e80-8da1-bb84546df43c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fa926aca-9038-4aa2-ae92-81e5bb4f0c50",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "61645fbd-c048-4bd2-9765-70c6d706a425",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
},
"equipment_family_id": "debbb196-fbd9-4c5b-ba2e-7d734cb46246",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4a940368-c7ec-4ca3-80af-a6d58b97a988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7abde618-f8bb-4cda-b8f7-defe95c2b0e9",
"_parent_code": "sample string 6",
"sales_organization_id": "54b7de23-4d8d-4db3-889c-f015b30b735b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
},
"date_in_production_since": "2025-08-11T11:38:26.7078517+00:00",
"date_out_of_production_since": "2025-08-11T11:38:26.7078517+00:00",
"date_end_support": "2025-08-11T11:38:26.7078517+00:00",
"sales_organization_id": "36355053-950e-4fd3-977e-08c740bf8217",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+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-08-11T11:38:26.7078517+00:00"
},
"project_status_id": "37ee075d-a38d-4447-a8d0-fd8597fcefa9",
"project_status_code": "sample string 10",
"project_status": {
"id": "c0333e97-4dd8-41e9-a50e-16afe405385a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "49474292-fd97-458e-aef4-4f7f6a129022",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
},
"company_id": "3418cb32-89d1-4ea3-b6fa-62139b60334f",
"company_code": "sample string 12",
"db_address_id": "b37fe7f0-c022-41b4-9cb5-50abcb9581fc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "433b6c86-07fb-459f-b914-cad30cd73505",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ef662208-7e11-4dfd-ae60-b38f33830ca1",
"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-08-11T11:38:26.7078517+00:00",
"date_create": "2025-08-11T11:38:26.7078517+00:00",
"date_update": "2025-08-11T11:38:26.7078517+00:00",
"updated_by_user_id": "739f3209-4a93-46e0-ac81-23e5bb8f95e9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-11T11:38:26.7078517+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-08-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-11T11:38:26.7078517+00:00",
"date_last_job": "2025-08-11T11:38:26.7078517+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-11T11:38:26.7078517+00:00",
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00",
"is_mobile_installation": true
},
"job_type_id": "c894f25f-c88a-4f11-973d-08b1d2f5a417",
"job_type_code": "sample string 7",
"job_type": {
"id": "98aba8ab-30c0-4ef7-8ab4-5da387a549cb",
"name": "sample string 2",
"sales_organization_id": "9c2b2218-adce-4a3d-901a-8be62180f3d8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00",
"code": "sample string 7"
},
"job_priority_id": "b2181d87-0174-40f6-a34d-098b759418ae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ebb1fe7d-bedd-4a92-a3ff-db27f56caed5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fc5f665d-02e5-4101-9009-7c0255775e23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
},
"job_status_id": "0489dd48-947d-47bf-bd43-b343a13e0549",
"job_status_code": "sample string 11",
"db_address_id": "ec8950bf-24bc-4b43-8b3a-54710b33c8e8",
"contact_id": "7ed94333-cc97-4e29-9cf4-db0949d37502",
"requested_by_company_id": "332749c3-d30b-4c28-beb1-cf6229f5b0e7",
"requested_by_contact_id": "9d5f3a62-1571-43fd-a668-0d5336eef26f",
"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-08-11T11:38:26.7078517+00:00",
"due_date": "2025-08-11T11:38:26.7078517+00:00",
"date_create": "2025-08-11T11:38:26.7078517+00:00",
"date_update": "2025-08-11T11:38:26.7078517+00:00",
"date_closed": "2025-08-11T11:38:26.7078517+00:00",
"suggested_user_id": "9501bb00-1538-4e01-845e-34d9837eab61",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d9746aec-1620-4864-b093-6dee81d64541",
"db_language_id": "ef7e44bb-f7e8-4712-a543-ac00531ca0e2",
"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-08-11T11:38:26.7078517+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ed2021d2-ba50-4fa3-8daf-3444e892b678",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "073fe952-f249-418a-a43b-3c8aed029917",
"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": "fe40c261-5622-45e4-9995-60d80f4342e7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c6e87288-9a77-4a97-b85b-ce46e22edca7"
},
"suggested_date_start": "2025-08-11T11:38:26.7078517+00:00",
"skill_id": "da052892-71a3-4c85-b4c6-10f17e048db7",
"skill_code": "sample string 32",
"skill": {
"id": "f36dcd7d-eb5f-484a-bf29-41cf1dc5e811",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cb875536-eee8-4fa4-90d7-8d2af89e1b8b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55024b1e-cb91-40ec-b327-9a8b7b7c830d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73f8ce41-dba6-41c8-abc3-409923697efb",
"db_currency_id": "19957d36-9975-4c7f-a318-7ff867a22b1f",
"db_language_id": "43d2c598-8995-45b6-9976-a6dfc4f6e38c",
"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-08-11T11:38:26.7078517+00:00"
},
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d06e2f18-2c09-420b-9a95-0122d699e6f6",
"date_reported_by_company": "2025-08-11T11:38:26.7078517+00:00",
"id2": 36,
"company_id": "1478b102-9ac4-4f0a-b211-5da0d5852059",
"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": "e28f2cfc-0fea-4860-911d-2f8a9c6eabfe",
"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-08-11T11:38:26.7078517+00:00"
},
"work_instruction_details_id": "7c1570bc-436a-4084-ad0e-e594ce9c0d1e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5469b39b-1928-4810-b4f4-5fa0f33a669d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e64f1b1c-6f95-44be-8f7a-252bc48361a2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-11T11:38:26.7078517+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": "7e9ab6b1-db5a-4db7-a1d7-4fed4f1bbf96",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-11T11:38:26.7078517+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.