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": "99f842b3-0512-4587-a1cc-37777c90d676",
"jobs_id": "6cf61ac4-10be-485c-8c22-a57e0d470f8c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dd30be99-1758-43cb-bb7a-62136adedf7e",
"_parent_id": "8001644b-f3b0-4958-a154-5fe91fbe19e9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2fa8b686-0e99-4982-91e8-0bc98fd5dae2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2ca8f583-b02a-4aa7-9f33-8b637bea2feb",
"_parent_id": "74b71975-91ef-4449-ba2c-6342516826f5",
"root_parent_id": "9fa5cd1d-8397-4d4c-9eca-6e7fa416263f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "00cc0553-1688-4ff0-aac3-dca9af1027ed",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7946bddb-d917-40e2-b6dd-67591641d187",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c23d7e0-aa02-414f-8a5d-aac5f183e765",
"_parent_code": "sample string 6",
"sales_organization_id": "00b4f637-7ef4-4930-b68c-bbfc652cc485",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
},
"equipment_model_id": "a8d3a759-aa9e-40c0-871a-ae873e9be6da",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fe9d5a88-51e8-4fa8-960e-f2cc5bab6d18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "94a643f5-11ed-422a-8232-53f433be6237",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ac0634e2-7ea7-4c1d-a479-73abbcb3c43c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5f137c4a-4211-4829-971f-80d6f9f636dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
},
"equipment_family_id": "2a7de050-8f1a-496b-9567-8619c6fea679",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7946bddb-d917-40e2-b6dd-67591641d187",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c23d7e0-aa02-414f-8a5d-aac5f183e765",
"_parent_code": "sample string 6",
"sales_organization_id": "00b4f637-7ef4-4930-b68c-bbfc652cc485",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
},
"date_in_production_since": "2026-08-29T00:23:43.4240486+00:00",
"date_out_of_production_since": "2026-08-29T00:23:43.4240486+00:00",
"date_end_support": "2026-08-29T00:23:43.4240486+00:00",
"sales_organization_id": "5ab7dfc6-d922-4e11-b21a-6462874cf7c7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+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-08-29T00:23:43.4240486+00:00"
},
"project_status_id": "88a4ed93-c45d-4a9c-836b-a7d676784a60",
"project_status_code": "sample string 10",
"project_status": {
"id": "3ad8e46f-be62-4e60-a613-6486ae6dd3d9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1f04b1a7-0c50-4960-ade9-8e2face59da0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
},
"company_id": "b88902f2-3aef-4469-be9f-103f7bae09c1",
"company_code": "sample string 12",
"db_address_id": "d05bad72-7027-40fd-8d59-557bfa0ac17e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "93c729c6-48d9-4789-9e41-cc6d6925c289",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e60e396-eb97-4309-9b30-0f8d33295a84",
"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-08-29T00:23:43.4240486+00:00",
"date_create": "2026-08-29T00:23:43.4240486+00:00",
"date_update": "2026-08-29T00:23:43.4240486+00:00",
"updated_by_user_id": "3e3018e4-ef9b-4bcb-b887-d80a3796fd1e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T00:23:43.4240486+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-08-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T00:23:43.4240486+00:00",
"date_last_job": "2026-08-29T00:23:43.4240486+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T00:23:43.4240486+00:00",
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00",
"is_mobile_installation": true
},
"job_type_id": "81a4d3ec-caae-46e9-a483-545f9da1548b",
"job_type_code": "sample string 7",
"job_type": {
"id": "201de09e-1ac3-4f6d-88ae-7f847cddbe7e",
"name": "sample string 2",
"sales_organization_id": "62537905-f9c2-43ea-9dbd-f369ca441dc1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00",
"code": "sample string 7"
},
"job_priority_id": "274a9719-0009-4fb0-b005-963b90578336",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cbf1ee57-f565-4c1d-8cdf-1bde2fb958ff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1b200bc5-2f11-4692-bf53-5acc7e6dfcca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
},
"job_status_id": "2a0e3515-3126-44ad-a624-7fdf01b2b336",
"job_status_code": "sample string 11",
"db_address_id": "9d97f536-2f8f-4f1e-a66f-282f4ad90769",
"contact_id": "08e4d418-c60a-456f-a886-ba28192752a3",
"requested_by_company_id": "8b17420f-994d-4350-9070-b4cf0446fba7",
"requested_by_contact_id": "55865c08-8493-41fc-9f14-3864fe534ff9",
"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-08-29T00:23:43.4240486+00:00",
"due_date": "2026-08-29T00:23:43.4240486+00:00",
"date_create": "2026-08-29T00:23:43.4240486+00:00",
"date_update": "2026-08-29T00:23:43.4240486+00:00",
"date_closed": "2026-08-29T00:23:43.4240486+00:00",
"suggested_user_id": "aea5ba48-afee-4d7a-8d96-a8b4a0da1665",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "98f98a43-fb7f-4021-b766-ef4d23e4ab2a",
"db_language_id": "c2aa989f-5c5f-4157-8db9-37d914261843",
"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-08-29T00:23:43.4240486+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "be75ca3f-2875-43c4-b6c0-53e40bd96ef1",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9ef05dd8-7ee4-44df-8bbc-791ff19a62d9",
"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": "d7721fb1-847b-4224-906c-82f62f918f56",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e81975e4-3f64-4376-864d-f394dcf13dbc"
},
"suggested_date_start": "2026-08-29T00:23:43.4240486+00:00",
"skill_id": "110d073e-497e-4e46-b307-fabc5eb80d10",
"skill_code": "sample string 32",
"skill": {
"id": "c52cc3f1-3fb0-4bfc-8cca-0b09d8b76db4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9ce8c21e-9fbf-48bf-96d0-f9e4d8b80f90",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1e5af98b-e55c-424a-a35d-cacaee95c3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a28566fa-00fe-4a7f-ad72-8a88f0c005b4",
"db_currency_id": "8366588a-238b-469d-9197-829d0563e354",
"db_language_id": "87389220-0172-48d7-81d1-9d5871ff9370",
"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-08-29T00:23:43.4240486+00:00"
},
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "69277c39-f924-44cd-be05-e102d7e50020",
"date_reported_by_company": "2026-08-29T00:23:43.4240486+00:00",
"id2": 36,
"company_id": "ba81471f-5318-4bb2-b97c-3330ed737c98",
"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": "e9cd9860-7070-404b-aafa-244bba245eb5",
"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-08-29T00:23:43.4240486+00:00"
},
"work_instruction_details_id": "96c885a5-b84a-4c25-b15e-ba3b5601653c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3793035b-d839-4d03-a37e-ab7a76d8c203",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9b827c53-3b90-4f24-bee9-6ffa0f64b5f4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T00:23:43.4240486+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": "5baf2384-8e02-4297-a1cf-595836e87842",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T00:23:43.4240486+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.