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": "2953aeb2-5379-469d-bb9e-29de9e1d1848",
"jobs_id": "d8c2a138-3cbd-449b-a02c-db39394a2322",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f692dc22-c71a-4ba3-bc93-3c7f9063ee39",
"_parent_id": "2e6baad6-6cfc-4bb6-acd1-e8640625262e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9f1a32d2-1075-4ffe-b8db-ee21d65026e7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8d679726-a54f-4ffc-8750-b6f6f66ae77b",
"_parent_id": "266f887f-addd-47f7-8c93-bd4197d63170",
"root_parent_id": "37c59970-8f1c-4f76-aa5c-83339ea17ec2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d6d7a014-59ec-4121-a9b8-bff99ab9ad2e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5b218905-f7ff-471b-9cdc-94656adbb55f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85fb5fd1-e6aa-4b52-a8da-2151c9660337",
"_parent_code": "sample string 6",
"sales_organization_id": "a6535aa1-a7c2-4560-86dd-f0f07826da02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
},
"equipment_model_id": "dbe01952-fbd5-4a0d-9288-bb3c39f0fee1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "36da1393-ba24-4115-b2fc-cd6b4b217489",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f8c34186-c4bc-449e-9f81-e0ccfeb87afe",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3992bd43-9ec3-4ac3-bde9-99d6b30d8f71",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5908e4e8-9458-4d55-b0fa-c64a247183b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
},
"equipment_family_id": "0ca428e3-de2f-40a0-8034-81b6f273d7e4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5b218905-f7ff-471b-9cdc-94656adbb55f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85fb5fd1-e6aa-4b52-a8da-2151c9660337",
"_parent_code": "sample string 6",
"sales_organization_id": "a6535aa1-a7c2-4560-86dd-f0f07826da02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
},
"date_in_production_since": "2025-07-15T19:06:21.8531843+00:00",
"date_out_of_production_since": "2025-07-15T19:06:21.8531843+00:00",
"date_end_support": "2025-07-15T19:06:21.8531843+00:00",
"sales_organization_id": "a49c563b-dead-43e5-afb0-70cbbff7a083",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+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-07-15T19:06:21.8531843+00:00"
},
"project_status_id": "08102e32-bb30-43bb-ae3c-8dfe884ac8df",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd6bb1b7-720c-49f0-a195-bd6ef43027f1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "630f95c8-a0cf-4cf8-802f-6b99913f35dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
},
"company_id": "ff9f9408-3917-4ab9-96c3-28a11d32b469",
"company_code": "sample string 12",
"db_address_id": "4ff5d49e-f8fa-434c-9820-ed52178b9a50",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b68af08d-408f-47c1-818e-9ae963b9fa8a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a010d27e-1163-4020-a55d-e6daab5fdab6",
"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-07-15T19:06:21.8531843+00:00",
"date_create": "2025-07-15T19:06:21.8531843+00:00",
"date_update": "2025-07-15T19:06:21.8531843+00:00",
"updated_by_user_id": "0d2c178f-a068-4367-8968-dd9819607867",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-15T19:06:21.8531843+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-07-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-15T19:06:21.8531843+00:00",
"date_last_job": "2025-07-15T19:06:21.8531843+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-15T19:06:21.8531843+00:00",
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00",
"is_mobile_installation": true
},
"job_type_id": "0cb6710e-642f-44f3-bdcc-ea9ea1df9ede",
"job_type_code": "sample string 7",
"job_type": {
"id": "83fcce41-9275-4543-bda6-39717831fab1",
"name": "sample string 2",
"sales_organization_id": "cde0097d-07fa-495c-91ec-58c6d2d4b4ac",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00",
"code": "sample string 7"
},
"job_priority_id": "0e438524-ce96-4dcb-9dd2-f4c1f64ba4cb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9a7332d5-215d-43c4-9914-141405d41030",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "91a1b65d-8019-48e9-81b3-83c7cd4068d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
},
"job_status_id": "a1a972a2-4739-4eea-aaef-0f13867be342",
"job_status_code": "sample string 11",
"db_address_id": "caed7fcc-4636-41a2-9054-f3d6cfc44395",
"contact_id": "df0d6e29-9641-4fcc-a735-47ccdd8ee955",
"requested_by_company_id": "df760187-8245-4e58-8ac1-1eb5de255138",
"requested_by_contact_id": "b350a6fc-a6bb-47e5-969d-fdeab720ac4c",
"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-07-15T19:06:21.8531843+00:00",
"due_date": "2025-07-15T19:06:21.8531843+00:00",
"date_create": "2025-07-15T19:06:21.8531843+00:00",
"date_update": "2025-07-15T19:06:21.8531843+00:00",
"date_closed": "2025-07-15T19:06:21.8531843+00:00",
"suggested_user_id": "b70c91fd-6e64-4c7f-9c08-36027662a457",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "65838453-ccb6-4067-82da-fda238e5ead8",
"db_language_id": "0712365c-c44a-42d3-bec3-6f42c24af35e",
"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-07-15T19:06:21.8531843+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d5724cf5-2114-4d0b-b138-b5f1409d976a",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1fe81886-d64d-4937-abba-00615e968ad3",
"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": "17d9c11d-2fa2-4c52-bf39-41548d0cc867",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ef177e7c-fb8e-492c-b9c1-291d77b2fc0c"
},
"suggested_date_start": "2025-07-15T19:06:21.8531843+00:00",
"skill_id": "f626a652-a64b-4eec-bbd6-5ba9eb111e46",
"skill_code": "sample string 32",
"skill": {
"id": "ced212c7-2136-4737-92c6-1eb84cb656a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cb123608-551b-4777-8d8c-0a996b416c00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63afb451-8f2a-48d0-ae39-1314d9d7d58f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0f836b9-8f37-4d1b-a52c-a9c304e3580b",
"db_currency_id": "85ec2ddb-5a0c-4116-bb8a-019c5edd0fc8",
"db_language_id": "7fdf43ae-cc48-47e8-ab94-a5696a98ebc3",
"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-07-15T19:06:21.8375635+00:00"
},
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f533dfa3-3074-477d-8d60-9a96464aeee1",
"date_reported_by_company": "2025-07-15T19:06:21.8531843+00:00",
"id2": 36,
"company_id": "942aa9ef-5f28-4b45-b9cb-817069581808",
"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": "a112026d-1715-4d9c-b8ca-ce88e25a8895",
"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-07-15T19:06:21.8531843+00:00"
},
"work_instruction_details_id": "567a35c2-84f3-4e3d-994c-58cedfe73859",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "742131ed-1274-4ac2-9b1c-8185bb424e71",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9ccf8c75-06a4-46ed-aa18-24ac394138ac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-15T19:06:21.8531843+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": "54819a43-7c6b-428c-953d-05df068db18c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-15T19:06:21.8531843+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.