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": "c80f0ab3-08d3-42f3-8473-a307f0bdf616",
"jobs_id": "26b2d523-79c8-4cbe-a35d-eb510425a08c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d10ec45-3447-4154-bb0e-41065840d2ea",
"_parent_id": "8015c396-6d6f-45f9-a626-c29d285cb499",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "017976bd-38bb-4c58-b93f-17f56bd6bce4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aca94b6d-a5d8-44ed-89d0-b562c04c04d1",
"_parent_id": "a4abaf19-c7fc-4c0b-8905-8ee530dff785",
"root_parent_id": "febfe8a6-276a-4800-b80f-9d54e7be19d6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "be3dc02c-06c3-4981-a9e6-5b58de47192e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7c215676-1897-4d40-bcec-1609edf2916e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "378cb266-4dae-4f1e-8223-422d991b5680",
"_parent_code": "sample string 6",
"sales_organization_id": "b4f01aa3-0794-458d-b36c-792a4c6c7dd1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
},
"equipment_model_id": "a6cbb258-b0dc-4198-baa4-63567b95d42f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a36ac858-6b16-4233-bea1-46200671713b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "302af901-6f2d-4066-be02-e873bc824c6b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6f73111d-478c-42af-b786-3f475d7f42cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "11fde8e0-2406-4d8d-978d-cc0708934012",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
},
"equipment_family_id": "2c4c68d0-f0d0-4425-85fc-0c2457b18900",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7c215676-1897-4d40-bcec-1609edf2916e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "378cb266-4dae-4f1e-8223-422d991b5680",
"_parent_code": "sample string 6",
"sales_organization_id": "b4f01aa3-0794-458d-b36c-792a4c6c7dd1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
},
"date_in_production_since": "2026-08-07T02:03:02.4707179+00:00",
"date_out_of_production_since": "2026-08-07T02:03:02.4707179+00:00",
"date_end_support": "2026-08-07T02:03:02.4707179+00:00",
"sales_organization_id": "878ddb3d-ee95-45b9-bf6c-bebfccd7fdae",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+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-07T02:03:02.4707179+00:00"
},
"project_status_id": "13ac31a2-4b11-46b0-ac10-25ab8ce68362",
"project_status_code": "sample string 10",
"project_status": {
"id": "aed9290f-4142-40b9-85be-272ea3ccb5cf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b2f164c-e20d-4183-a61d-a177818994cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
},
"company_id": "6c848679-b844-45b9-ad03-fcdefde5c064",
"company_code": "sample string 12",
"db_address_id": "ba1e4e8e-89f8-4169-8a5e-af573a6bbbc6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a1d7dde7-b818-4be3-b646-7d295f264bd9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "801f2389-9b5b-4b19-89c9-eb63dbf5c37d",
"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-07T02:03:02.4707179+00:00",
"date_create": "2026-08-07T02:03:02.4707179+00:00",
"date_update": "2026-08-07T02:03:02.4707179+00:00",
"updated_by_user_id": "908b8032-712c-49a6-a324-3cdf12df2d66",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-07T02:03:02.4707179+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-07T02:03:02.4707179+00:00",
"date_last_job": "2026-08-07T02:03:02.4707179+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-07T02:03:02.4707179+00:00",
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00",
"is_mobile_installation": true
},
"job_type_id": "61e9903d-67f1-4d1b-bde4-f5994e0143c7",
"job_type_code": "sample string 7",
"job_type": {
"id": "3508d41f-8c65-4416-ba0d-fc6792b93b04",
"name": "sample string 2",
"sales_organization_id": "d6155eb2-22cd-4cb0-bd64-1b056a204700",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00",
"code": "sample string 7"
},
"job_priority_id": "43e9291d-f7d8-4274-bb12-62c7064aea3f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d5566655-59fd-4c70-90fa-f7c97ed7b1ad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "eccefe79-caff-436d-82b8-09016167d2e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
},
"job_status_id": "0e921640-4630-4ea5-93f3-8e3e22e40e01",
"job_status_code": "sample string 11",
"db_address_id": "1a2b6222-fb55-4f73-a742-a3de14c17df6",
"contact_id": "897a45bb-2302-4b6c-b15d-6f67047d75bc",
"requested_by_company_id": "4e2a174e-fdb6-4fda-94dd-b63f603b0591",
"requested_by_contact_id": "da75e19a-a08a-428f-a6af-fa4acfd670b0",
"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-07T02:03:02.4707179+00:00",
"due_date": "2026-08-07T02:03:02.4707179+00:00",
"date_create": "2026-08-07T02:03:02.4707179+00:00",
"date_update": "2026-08-07T02:03:02.4707179+00:00",
"date_closed": "2026-08-07T02:03:02.4707179+00:00",
"suggested_user_id": "8c2dc5ec-c684-44ab-8906-42c55b374118",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4e0b82f6-7d94-49bd-b3bc-74d2cb3f049f",
"db_language_id": "10ada16a-e22d-45e0-9a76-6cc40e522b6d",
"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-07T02:03:02.4707179+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1074342c-8db9-4258-bfea-a7fef7ce7e9e",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "507adfd8-00e6-43dd-908c-95e949c4e8e7",
"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": "ddd46ba0-b194-461a-8960-c6b2852f0143",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f09e19cf-fe1d-4f90-acb3-f849b6389d7f"
},
"suggested_date_start": "2026-08-07T02:03:02.4707179+00:00",
"skill_id": "1f405450-8ecf-4230-8f81-2cfa3b17267f",
"skill_code": "sample string 32",
"skill": {
"id": "6876dcab-0f31-429f-a1b4-a2097362e84a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6f52c877-6bad-426f-9e42-d7ddc7f9d04a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76aa9329-2ff9-4639-963e-257ea07706c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "84ada413-9cd1-4170-ba5f-5671d7f2d10c",
"db_currency_id": "718c8fc0-7e32-4784-a560-f1ba02e0c3cd",
"db_language_id": "c50eae9a-4855-4575-8ec1-d4f566789783",
"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-07T02:03:02.4707179+00:00"
},
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bbdb067e-280a-4d9d-b981-df5ecd6a99cb",
"date_reported_by_company": "2026-08-07T02:03:02.4707179+00:00",
"id2": 36,
"company_id": "ebcfc2ca-4521-44cb-ac2d-05383133bd95",
"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": "44a41c49-364f-49d7-9004-f4c71006952e",
"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-07T02:03:02.4707179+00:00"
},
"work_instruction_details_id": "57c1c339-cd89-49f9-8eee-775748af04f3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1261911e-75d3-4cb8-9618-1a1f601b680a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dd940f7b-81b5-40f9-908c-b5769ac2bfba",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-07T02:03:02.4707179+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": "8fe1b516-fbbb-4f6e-b67a-e995084e80c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-07T02:03:02.4707179+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.