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": "2a756513-e0fe-48eb-a611-abd18faaed12",
"jobs_id": "a2af6f5f-9dd6-4843-b932-013c33fb91c2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d5dc1cdc-4782-4924-9809-a03158cee7e3",
"_parent_id": "2667bb2a-4f3e-48ee-ab8c-f710ff8d6f43",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c8b2a3a9-f460-4f0c-aab3-4975d927b219",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4ae233f2-0552-4302-962d-77e058c22d5c",
"_parent_id": "8b7f03b3-5a26-4c74-a9f4-01e4c17b48d4",
"root_parent_id": "1074ca99-7207-42dd-bc28-6092d99b2ac0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "70ee1e2a-70bc-404e-960c-e851b83b56ae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab41dfcb-cff4-439f-9ab0-8ec26da2ecfb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "915b95dc-ee4b-4c34-8d86-5319d7a27ddc",
"_parent_code": "sample string 6",
"sales_organization_id": "1c2dd849-6093-4928-85d0-2500617caccc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
},
"equipment_model_id": "5733f6d3-601d-490d-8be4-4362b66cbd66",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0722dc90-2be8-4252-94d0-6f06fc66ef49",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3476d836-49f8-42d6-866c-6f63a88db589",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "57be331b-5fc4-4011-b681-3e7b955ebbb3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b0e8aed1-c635-4ff1-bd41-758ba33a8243",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
},
"equipment_family_id": "6ad0eeab-aea4-493c-a8e2-192eab08bbfb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab41dfcb-cff4-439f-9ab0-8ec26da2ecfb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "915b95dc-ee4b-4c34-8d86-5319d7a27ddc",
"_parent_code": "sample string 6",
"sales_organization_id": "1c2dd849-6093-4928-85d0-2500617caccc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
},
"date_in_production_since": "2026-05-24T08:00:50.7136333+00:00",
"date_out_of_production_since": "2026-05-24T08:00:50.7136333+00:00",
"date_end_support": "2026-05-24T08:00:50.7136333+00:00",
"sales_organization_id": "ee41a3d0-ee10-4629-aed8-5d5de6a3a8bf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+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-05-24T08:00:50.7136333+00:00"
},
"project_status_id": "79ea11d5-fadc-436b-8084-c7bd5119b6af",
"project_status_code": "sample string 10",
"project_status": {
"id": "613c4ce1-5fdf-4305-a077-0ff72e2dd35b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cd570f08-06d7-4413-8307-04b370730db8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
},
"company_id": "7aa9b4a7-63cc-4eba-a90f-df7c65b19e68",
"company_code": "sample string 12",
"db_address_id": "40d2c3c5-ea64-4515-9725-40e815a8ab9a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5e976c93-828a-42e2-8b55-22b7f4ecdb39",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9aa7a2eb-01a0-49c4-8ad6-b3cc3d1eee8e",
"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-05-24T08:00:50.7136333+00:00",
"date_create": "2026-05-24T08:00:50.7136333+00:00",
"date_update": "2026-05-24T08:00:50.7136333+00:00",
"updated_by_user_id": "11641cb7-5515-4f92-8000-9d64e21a6ccf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-24T08:00:50.7136333+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-05-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-24T08:00:50.7136333+00:00",
"date_last_job": "2026-05-24T08:00:50.7136333+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-24T08:00:50.7136333+00:00",
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00",
"is_mobile_installation": true
},
"job_type_id": "246a0c80-8ee0-4f6e-a8b1-77c415c6855a",
"job_type_code": "sample string 7",
"job_type": {
"id": "32068762-9e77-48c4-85a4-c46c9a6bf609",
"name": "sample string 2",
"sales_organization_id": "0e3cd412-539f-487f-ac9d-61238d3aa576",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00",
"code": "sample string 7"
},
"job_priority_id": "1a0f859e-87c0-407a-94dd-6212863f56c9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8de8d650-3bc5-4859-999a-91a2de84b76b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "31da1f59-4fa2-4d54-887d-9300ad2ef1c2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
},
"job_status_id": "be28e05f-94f0-42c0-8da5-431f5980fc78",
"job_status_code": "sample string 11",
"db_address_id": "889497c0-7397-49d4-858a-9749da665e64",
"contact_id": "1f91e057-736e-4b0a-a069-eeaab3ca4ec6",
"requested_by_company_id": "293ba5b6-f72d-4a78-9dba-a07debc66465",
"requested_by_contact_id": "5ea18c45-b6b7-40fd-ae37-46387d6558f8",
"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-05-24T08:00:50.7136333+00:00",
"due_date": "2026-05-24T08:00:50.7136333+00:00",
"date_create": "2026-05-24T08:00:50.7136333+00:00",
"date_update": "2026-05-24T08:00:50.7136333+00:00",
"date_closed": "2026-05-24T08:00:50.7136333+00:00",
"suggested_user_id": "6e895d3d-65a2-49c7-889b-501381542f21",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "32f7899d-bd71-4d8e-8a6d-3a5e5b8411d3",
"db_language_id": "4f1713a2-2d98-46c5-9f6e-a8f4a6edde90",
"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-05-24T08:00:50.7136333+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6ffb21e1-5a03-47b5-a30a-b4871d67dcb1",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "11f2f91e-3cc9-45c8-b4a0-ad0ad130e5d3",
"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": "83182378-bb35-430b-bba6-3feefc8c08f9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f95ddb80-918c-410b-b0c0-110114644233"
},
"suggested_date_start": "2026-05-24T08:00:50.7136333+00:00",
"skill_id": "35a277b6-3447-4678-9bab-d4d7bcadc943",
"skill_code": "sample string 32",
"skill": {
"id": "7565d3b6-6011-456e-8ed0-9952fd28b3ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2fc19ef9-a604-403d-94f3-b5c34758ee2a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff649a7e-f9a7-4f0f-9410-2f3526833a07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74189f8f-8ebf-4b35-a170-0a5959890b8a",
"db_currency_id": "3c5a67ed-9fbe-4361-9106-eabd8fb5afe2",
"db_language_id": "9022f41b-e7d4-415c-8851-9091e756bf82",
"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-05-24T08:00:50.7136333+00:00"
},
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "38b50808-6934-4c81-b012-4c259da195b2",
"date_reported_by_company": "2026-05-24T08:00:50.7136333+00:00",
"id2": 36,
"company_id": "449ac46d-65fd-40d4-bf72-97f8d7e8b964",
"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": "5411e655-dc1c-4677-a891-b75bdc4e06e4",
"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-05-24T08:00:50.7136333+00:00"
},
"work_instruction_details_id": "c42462d4-e703-4938-a4a2-83475a5da66c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "79a77f6b-0222-476f-b409-d38ba3571c3f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2feea184-ad29-432f-8001-9082580f7a7f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-24T08:00:50.7136333+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": "c925362e-6c73-4dc6-8cf1-fb95aa54f180",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-24T08:00:50.7136333+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.