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": "a16d6775-071a-41c3-8907-4b2691c8d1d6",
"jobs_id": "2b8316e4-28b0-4bda-8890-a2d64a778b5c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a32d4633-c66b-48de-be9e-138dd660fb0e",
"_parent_id": "aa279577-6352-403e-9b75-66742f9a6d28",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "52207bc4-217b-46f4-931f-ca58ef233b86",
"project_reference_back_office": "sample string 5",
"project": {
"id": "18fdfe74-5429-4178-80ac-a276b3ba7c46",
"_parent_id": "55abc369-404a-4a96-9ed5-2192a4d994c8",
"root_parent_id": "02f82ffa-7365-4f47-91bf-2e9d885c8000",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d498ef0c-0fed-4478-960d-d769e27b404b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0b1b60a6-7dff-462e-ad9c-ba0c11fdd5e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "25d1d227-89ee-40fb-8521-813ec43c4659",
"_parent_code": "sample string 6",
"sales_organization_id": "d195862a-0256-434d-a6db-2d9d72c4181b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00"
},
"equipment_model_id": "4bb4cf31-f890-49b8-bd05-8527dfd46455",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cf91c260-8480-4529-b013-e8405c5a0b56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e27afe38-9ad3-47e5-8079-0db40c25cd81",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cadb5bc8-ed45-4afb-9042-09446595d3ee",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1ef73d3f-913b-4e23-bca1-8f8b4af479de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00"
},
"equipment_family_id": "3b77b717-6c5d-47a8-9120-a658a8ba006a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0b1b60a6-7dff-462e-ad9c-ba0c11fdd5e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "25d1d227-89ee-40fb-8521-813ec43c4659",
"_parent_code": "sample string 6",
"sales_organization_id": "d195862a-0256-434d-a6db-2d9d72c4181b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00"
},
"date_in_production_since": "2026-01-05T14:20:36.0675076+00:00",
"date_out_of_production_since": "2026-01-05T14:20:36.0675076+00:00",
"date_end_support": "2026-01-05T14:20:36.0675076+00:00",
"sales_organization_id": "ae17a8a7-3288-43f3-98a6-ddc4eae45f6e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+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-05T14:20:36.0675076+00:00"
},
"project_status_id": "eb426064-10d1-42af-ba6e-f13a04c5964d",
"project_status_code": "sample string 10",
"project_status": {
"id": "da77cdc8-73e6-4eba-bd1f-3bd08e6ddca7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "28c94c48-ea01-42f6-930b-12fa43fdd1a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00"
},
"company_id": "24247209-e26b-4b7e-a445-557780990ff7",
"company_code": "sample string 12",
"db_address_id": "5504ed22-8355-4f3e-b9bd-b216e32d9ea3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2220cd45-6b49-4ad8-856b-d0e4d3cc8652",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a2b924b1-0abe-4401-82ed-583db8a32ace",
"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-05T14:20:36.0675076+00:00",
"date_create": "2026-01-05T14:20:36.0675076+00:00",
"date_update": "2026-01-05T14:20:36.0675076+00:00",
"updated_by_user_id": "ccdf1a76-79e2-4195-b662-52530c203334",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-05T14:20:36.0675076+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-05T14:20:36.0675076+00:00",
"date_last_job": "2026-01-05T14:20:36.0675076+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-05T14:20:36.0675076+00:00",
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00",
"is_mobile_installation": true
},
"job_type_id": "7134632b-1bc1-46e2-87cb-70254131c7ef",
"job_type_code": "sample string 7",
"job_type": {
"id": "ae510a83-0fa1-44da-bebe-2625a723c777",
"name": "sample string 2",
"sales_organization_id": "e5570ffd-651b-43eb-9920-10b820ce7530",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e90e2ef-bae6-4740-9b83-4d4d3a389cf7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "680aefe2-a733-4b9a-8912-7a426a8543b5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2492f4d3-bfbd-48b4-a7a2-9aa4e53cdcb4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00"
},
"job_status_id": "35cef3d5-e0b2-4199-8824-30fc3bec4550",
"job_status_code": "sample string 11",
"db_address_id": "62027aab-5f4e-4095-a8d0-71a7f2c86f14",
"contact_id": "7428b573-7592-406e-98b5-d9fa4b1d0886",
"requested_by_company_id": "b888b255-56fe-4643-90a8-786db83281f9",
"requested_by_contact_id": "79e0558d-159d-43fc-86ff-d3851ff87fd7",
"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-05T14:20:36.0675076+00:00",
"due_date": "2026-01-05T14:20:36.0675076+00:00",
"date_create": "2026-01-05T14:20:36.0675076+00:00",
"date_update": "2026-01-05T14:20:36.0675076+00:00",
"date_closed": "2026-01-05T14:20:36.0675076+00:00",
"suggested_user_id": "71cf2424-23bd-467b-8451-b84a8d3cf763",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9874967f-66d1-4bf2-8fad-f9f23f9d17d5",
"db_language_id": "9342857e-93df-4f4b-abac-0d43d588a07f",
"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-05T14:20:36.0675076+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c8db8536-fb62-4d84-8134-21c420969966",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0e8cf1fe-1394-4498-8677-12b1b1a535f5",
"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": "102d67c4-801c-46c4-9c39-46043240197e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c04c0e85-52cf-42dd-a897-d3d23b785ab2"
},
"suggested_date_start": "2026-01-05T14:20:36.0675076+00:00",
"skill_id": "5ebcf546-cabd-4bb9-a1fd-50fdca7a3680",
"skill_code": "sample string 32",
"skill": {
"id": "def5c656-de31-4aa5-8639-b9930ba29ccc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b026d855-5202-4d91-90cb-69aca0ea0369",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5447e566-1a92-4454-a818-2d54dd1b8d8a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "765f0a55-eeb5-4282-b385-a9d6c50397f1",
"db_currency_id": "0885b22f-ffca-4536-9684-4ccd7478a49d",
"db_language_id": "6eb06759-fbff-405b-8fae-e99f94f4d1f8",
"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-05T14:20:36.0675076+00:00"
},
"modified_dateutc": "2026-01-05T14:20:36.0675076+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8e6673f8-31e5-4b28-89d5-696b7083ba66",
"date_reported_by_company": "2026-01-05T14:20:36.0675076+00:00",
"id2": 36,
"company_id": "bf8323c5-d401-4936-b162-94f4a88a1431",
"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": "a03ec6fc-209e-4a26-b7a5-757929fef268",
"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-05T14:20:36.0675076+00:00"
},
"work_instruction_details_id": "8b0b818b-f7aa-45dc-b5bd-21e5f8735a87",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1e5c9896-1ec1-4217-a8ec-67560274a272",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c0004056-3ffb-484c-843b-9a31d361b6a4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-05T14:20:36.0831347+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": "14a04ab4-5318-4a46-98ba-5e01dda2ffd8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-05T14:20:36.0831347+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.