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": "ab6d4333-a5ec-4536-babb-c1d43d10725e",
"jobs_id": "4ed84184-4627-429d-b7dd-aa72b5a1ef28",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "779e6214-29c0-466b-966d-ac34b6a27767",
"_parent_id": "e1c88e21-fac4-49cc-b336-1d7cd15a1879",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "95349363-61a8-45b3-9616-d8ada5f7d4fe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0f26b271-d4bf-4572-b1c0-fcbe18e193e7",
"_parent_id": "3705fe20-dfff-4a79-83e7-a4f74d444a21",
"root_parent_id": "e98ed1ff-9376-49d1-83af-28b3e61a4854",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fe200452-e816-4961-a798-33d935bd4658",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2e7f44b2-cb7b-481b-92a2-0c839f89f2dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e771cec0-8810-4f6c-9ffa-fb46efee4482",
"_parent_code": "sample string 6",
"sales_organization_id": "932cf371-ad7d-4b31-882f-1737efad2b2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
},
"equipment_model_id": "006daf90-eb97-4213-a975-48196d88c989",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d171d738-4011-4c1e-a962-d93cc9e274d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fe02f88e-bcd2-4318-9e19-f087df77b7d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "15ff1bd4-1444-4d34-8e8d-addfeb652eb4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dc6b553c-32fd-4bc2-adc0-4107dfe89485",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
},
"equipment_family_id": "7201eb31-9e7c-4098-86e9-274e00353d50",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2e7f44b2-cb7b-481b-92a2-0c839f89f2dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e771cec0-8810-4f6c-9ffa-fb46efee4482",
"_parent_code": "sample string 6",
"sales_organization_id": "932cf371-ad7d-4b31-882f-1737efad2b2d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
},
"date_in_production_since": "2025-06-21T11:41:40.3083075+00:00",
"date_out_of_production_since": "2025-06-21T11:41:40.3083075+00:00",
"date_end_support": "2025-06-21T11:41:40.3083075+00:00",
"sales_organization_id": "42475b19-c533-407b-b682-352c4997c899",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+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": "2025-06-21T11:41:40.3083075+00:00"
},
"project_status_id": "873d07ce-c7e7-4606-83e9-b0d9f8b60b25",
"project_status_code": "sample string 10",
"project_status": {
"id": "94c3d733-1ce6-463a-9c13-369d1196b004",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "308bb36c-bba4-464a-abc5-3029db807fc0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
},
"company_id": "3808be65-74de-480f-8d7b-b61acaed8199",
"company_code": "sample string 12",
"db_address_id": "99d66377-400c-4bbc-a97c-4afaa5c812c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d1f3fc40-2916-4bc0-b061-b04c9ca5c057",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90a92baa-dcdd-40da-967e-703e144e6746",
"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": "2025-06-21T11:41:40.3083075+00:00",
"date_create": "2025-06-21T11:41:40.3083075+00:00",
"date_update": "2025-06-21T11:41:40.3083075+00:00",
"updated_by_user_id": "417e80a0-eceb-46ea-ab62-5cab73e91cb1",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-21T11:41:40.3083075+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": "2025-06-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-21T11:41:40.3083075+00:00",
"date_last_job": "2025-06-21T11:41:40.3083075+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-21T11:41:40.3083075+00:00",
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00",
"is_mobile_installation": true
},
"job_type_id": "247c9d24-b0e6-4408-8391-f8a05673fe8f",
"job_type_code": "sample string 7",
"job_type": {
"id": "4a3e3856-fa5b-4a0a-b58e-0bf09a959d04",
"name": "sample string 2",
"sales_organization_id": "55d6ec10-8ec3-4381-834e-8d3c12cc9166",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00",
"code": "sample string 7"
},
"job_priority_id": "b4ee159c-a163-4d28-8bcb-10d3442c15bf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "598552c9-20b8-4919-ab45-4697b1e7c14b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fd132093-9196-4b4d-b2a7-430d64f5f017",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
},
"job_status_id": "5bfbfdfb-c216-458c-bca4-f5fb5082c1b2",
"job_status_code": "sample string 11",
"db_address_id": "6c6f3980-e10e-4e29-a749-3df9cb1bcfec",
"contact_id": "242dc5e2-292a-48ed-93d1-26ffb42080e4",
"requested_by_company_id": "be7c990d-3cce-4445-8dae-4ce78b1c482c",
"requested_by_contact_id": "67895d00-f4de-4a68-a273-0be0268a147b",
"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": "2025-06-21T11:41:40.3083075+00:00",
"due_date": "2025-06-21T11:41:40.3083075+00:00",
"date_create": "2025-06-21T11:41:40.3083075+00:00",
"date_update": "2025-06-21T11:41:40.3083075+00:00",
"date_closed": "2025-06-21T11:41:40.3083075+00:00",
"suggested_user_id": "1915e5d7-9b5c-4af0-8050-b5c7b7d484b8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7fcb3516-175c-474a-9fa9-3617728fb44c",
"db_language_id": "1854fa17-c2cc-419c-99ca-02b2f514f76a",
"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": "2025-06-21T11:41:40.3083075+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1e80bd21-cbf7-4ba3-bd60-8f3ff7284392",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e5c2d732-fc5a-42b4-bca5-c2acf0c17da2",
"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": "25eaf544-5712-4c60-ab3e-290da43f45e8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "35137faf-baa4-45b0-9868-10b72fec95ba"
},
"suggested_date_start": "2025-06-21T11:41:40.3083075+00:00",
"skill_id": "8c768028-9642-4cf7-92d1-83014376feef",
"skill_code": "sample string 32",
"skill": {
"id": "3061cab3-4b91-4b80-8ca5-a90fabd0374a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1ba6ded2-4c0c-47bf-b000-a031ed0c06c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4ceec5e-9cc9-4228-9f15-e50745ac1b66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8eb75c14-e46b-46f0-84df-c8a189e3e293",
"db_currency_id": "627bb31f-1d8a-421a-a0ab-52522ccda5b4",
"db_language_id": "e4cfe743-cb64-4308-a837-1ded4428987e",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dacd7c4f-e052-4573-afef-c4e06d78f820",
"date_reported_by_company": "2025-06-21T11:41:40.3083075+00:00",
"id2": 36,
"company_id": "bd8c03e0-64f3-4b5d-8bb9-bc7721eb2adb",
"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": "06c18220-86bc-46eb-b50c-dfd24889c255",
"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": "2025-06-21T11:41:40.3083075+00:00"
},
"work_instruction_details_id": "8384daa0-41ef-4204-bc71-9ef4f9c41085",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b4116c9b-8ac1-41af-825b-610f2a3192da",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bc67bec8-dbeb-4757-8aad-8452e8a7f785",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-21T11:41:40.3083075+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": "91275f75-bb68-4345-9846-beaeae5d7ea3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-21T11:41:40.3083075+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.