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": "dc41bb29-7c0f-4b6f-95d9-2109cf4ff239",
"jobs_id": "644cd1bc-cc22-419f-bb41-39fc6baab51c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3e2ec98f-28c5-44e3-93a0-8782f5698380",
"_parent_id": "1a5d5757-d2d2-48a3-931a-ac49e6dcbaa5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a7e1890b-4e5e-4824-8b7c-9a76d55fed98",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b0a783ad-849e-477a-9430-f746ff3facaf",
"_parent_id": "fde61713-3045-495b-872b-0f7382713525",
"root_parent_id": "9ef4d70d-86e3-4109-b847-bfe14a823831",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c5c34607-532a-4e96-ac3b-899ba4c0dd20",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23a4d115-dede-4fc5-987a-30adec046580",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0f3c07d-0b38-4dab-adaf-67278d580af7",
"_parent_code": "sample string 6",
"sales_organization_id": "428feee3-9ceb-4e0e-b13c-967efb1d7214",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"modified_dateutc": "2026-01-21T06:48:56.263069+00:00"
},
"equipment_model_id": "1ca10306-02bb-432d-bf0f-2e0cbe38de50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ca952970-c12b-4dbc-a49f-8dc65c8620dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4fee5bf5-da89-4fd7-9147-213a904f0ff5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "08460d1d-aabe-4c7d-80e7-e54817e55f8d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e8681670-50e1-43f1-aabf-407c0159e3e7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"modified_dateutc": "2026-01-21T06:48:56.263069+00:00"
},
"equipment_family_id": "8510c2ac-254b-4588-813a-d4333db27193",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23a4d115-dede-4fc5-987a-30adec046580",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f0f3c07d-0b38-4dab-adaf-67278d580af7",
"_parent_code": "sample string 6",
"sales_organization_id": "428feee3-9ceb-4e0e-b13c-967efb1d7214",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"modified_dateutc": "2026-01-21T06:48:56.263069+00:00"
},
"date_in_production_since": "2026-01-21T06:48:56.263069+00:00",
"date_out_of_production_since": "2026-01-21T06:48:56.263069+00:00",
"date_end_support": "2026-01-21T06:48:56.263069+00:00",
"sales_organization_id": "b3560040-e7b4-4ebe-bdbb-b83c465dd689",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+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-01-21T06:48:56.2787459+00:00"
},
"project_status_id": "289b11ba-8052-4beb-bb2d-efd1b2d6bf55",
"project_status_code": "sample string 10",
"project_status": {
"id": "7bb6f075-ef39-488d-8cd6-bc37f77ca28e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d03e9c9c-6bf2-4b41-a0f7-67777f2af736",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00"
},
"company_id": "53175842-7fd2-4b30-8e60-9f9f48833bf1",
"company_code": "sample string 12",
"db_address_id": "09fb190b-bf30-4aa1-b599-7d0655ede52f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d86ef9a1-5801-4b3d-ada6-c51a70a944f9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "24bc4863-a9e8-4d2b-b43b-ffe36866e8e4",
"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-01-21T06:48:56.2787459+00:00",
"date_create": "2026-01-21T06:48:56.2787459+00:00",
"date_update": "2026-01-21T06:48:56.2787459+00:00",
"updated_by_user_id": "dfbeea96-bd95-4ba3-9d30-63b3e2cf44c3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-21T06:48:56.2787459+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-01-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-21T06:48:56.2787459+00:00",
"date_last_job": "2026-01-21T06:48:56.2787459+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-21T06:48:56.2787459+00:00",
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00",
"is_mobile_installation": true
},
"job_type_id": "e597a374-a043-48f6-b51e-95e3a37e628c",
"job_type_code": "sample string 7",
"job_type": {
"id": "94013460-d7b3-4fc6-8019-446277459a57",
"name": "sample string 2",
"sales_organization_id": "5004c9d2-0433-4605-9f16-6fc9155e2e43",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00",
"code": "sample string 7"
},
"job_priority_id": "efb036c4-9d9b-41d0-bf32-c9fd1db18fcc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e3278bb7-ffb8-4ee1-97c6-070a01af2e7b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "40ddd3df-8b6b-4563-bc1a-a20ec94510e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00"
},
"job_status_id": "b3424731-b8c0-4818-a3d0-7e561c746ce7",
"job_status_code": "sample string 11",
"db_address_id": "4bcf2fbb-0708-4670-8deb-bac6fdf49cee",
"contact_id": "382c672e-f797-45cb-8268-df7f6ba67421",
"requested_by_company_id": "6a4ccb2d-536e-4c50-99d6-0aaeb2bfddf3",
"requested_by_contact_id": "784d0f50-6239-4579-9d5e-387e3d1d0289",
"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-01-21T06:48:56.2787459+00:00",
"due_date": "2026-01-21T06:48:56.2787459+00:00",
"date_create": "2026-01-21T06:48:56.2787459+00:00",
"date_update": "2026-01-21T06:48:56.2787459+00:00",
"date_closed": "2026-01-21T06:48:56.2787459+00:00",
"suggested_user_id": "f0d8859a-6af5-44b4-b9e0-403293fbed8a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "240683e0-5217-4b88-bfb2-f534061d67e0",
"db_language_id": "948c71ec-e249-4d49-82d5-3fc16801f6a2",
"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-01-21T06:48:56.2787459+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a437668e-5057-4c1e-bed9-9617574f5b7b",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bcfcf16b-5f5d-4e1f-921b-24d0ccd1d01b",
"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": "aed8e18e-ed7b-45f1-ab02-014909e87330",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "13561751-9e1f-4cee-a890-8fd00f88451e"
},
"suggested_date_start": "2026-01-21T06:48:56.2787459+00:00",
"skill_id": "7413b5dd-317b-40df-9f5c-18045ee57039",
"skill_code": "sample string 32",
"skill": {
"id": "e6c701c1-4af5-436e-9f64-b0acf2e47be1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a3aef58a-594c-4ce4-b017-0a8362010aca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f2658f8-eb34-491c-b454-1d80b399f061",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a0b2ee93-f68b-4811-b723-2e6e7db67d2c",
"db_currency_id": "39a2e71a-1e8b-4d3f-9b91-0cad9d564650",
"db_language_id": "fb23888e-3dd6-4aaf-95bd-ce7c08b3307a",
"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-01-21T06:48:56.2474341+00:00"
},
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "922809ff-18e1-4307-a139-34cd5b090e1e",
"date_reported_by_company": "2026-01-21T06:48:56.2787459+00:00",
"id2": 36,
"company_id": "8fba45cd-5aba-463b-89fa-5afa82aeabf9",
"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": "749b0caf-9db4-4e01-ad20-07c4bf6b35ea",
"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-01-21T06:48:56.2787459+00:00"
},
"work_instruction_details_id": "33cd4f4a-f4d4-4cd2-a817-69ffb5753caf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "432b87b5-962c-4006-96f4-c468b656569f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5649425f-3e53-43bc-a972-51aa8701e253",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-21T06:48:56.2787459+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": "f8ce7cd3-27c0-45a9-9aaf-ce5f9592a5af",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-21T06:48:56.2787459+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.