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": "396af51d-4a17-42ed-bb6d-8f24914f7082",
"jobs_id": "00b255a7-b8d0-457e-9a49-d33097cf07d8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "790843ec-3ad9-4c91-81dc-2e6ad60c4221",
"_parent_id": "41d6e7dc-7b24-4f2f-93bb-84f0cf5fff6f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4f76c40-bb8b-473b-900d-7ba7070d08fe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9e167361-d0f9-465d-a060-463244798308",
"_parent_id": "00909c58-7d24-4952-bd84-918753a33725",
"root_parent_id": "85ca923f-d600-42db-98c5-38251110b86d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7ed87168-52d5-4769-b7e7-49d1c67c0b05",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ac06925d-d65c-40fb-914c-2d9567a48657",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df0cb0f3-ad56-42e9-8f4c-e550db4188ca",
"_parent_code": "sample string 6",
"sales_organization_id": "d0a93607-e0e6-49e5-894e-8bba3092e8ed",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00"
},
"equipment_model_id": "af3c8073-1e80-4232-b1ac-6c5d8c529301",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "59fda960-10f8-472f-b07d-6019e65bbf9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eadeb6ae-1f5a-4753-a9f4-bde9e63fb5cc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8b4c238e-07ba-49f3-822f-4d05a6a69c8c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b2e6400c-af9c-4b7e-9f20-c8c1535ea3ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00"
},
"equipment_family_id": "15845397-c073-4fee-93e5-16b9575747c2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ac06925d-d65c-40fb-914c-2d9567a48657",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df0cb0f3-ad56-42e9-8f4c-e550db4188ca",
"_parent_code": "sample string 6",
"sales_organization_id": "d0a93607-e0e6-49e5-894e-8bba3092e8ed",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00"
},
"date_in_production_since": "2025-07-05T22:27:15.5855028+00:00",
"date_out_of_production_since": "2025-07-05T22:27:15.5855028+00:00",
"date_end_support": "2025-07-05T22:27:15.5855028+00:00",
"sales_organization_id": "8d03b97b-c1fb-4052-a3d2-85c20507f598",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+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-05T22:27:15.5855028+00:00"
},
"project_status_id": "9378f33e-4fe3-43a0-bed6-e108692c3351",
"project_status_code": "sample string 10",
"project_status": {
"id": "c9c72770-2e27-4a95-b433-46b331d83e66",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c1b32d0-4c72-4cb1-8560-13c61caa5e0b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00"
},
"company_id": "73b90976-488e-45d9-8b91-89fa1eba6b05",
"company_code": "sample string 12",
"db_address_id": "91a3f5da-bf9a-40eb-9d91-394023669147",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8b30b82c-6c0d-4953-a557-c7c6c997174e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "88aed5f4-8abb-4f83-b00c-9e501381254f",
"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-05T22:27:15.5855028+00:00",
"date_create": "2025-07-05T22:27:15.5855028+00:00",
"date_update": "2025-07-05T22:27:15.5855028+00:00",
"updated_by_user_id": "a6979002-eb2f-4ade-81e0-8d6321890245",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-05T22:27:15.5855028+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-05T22:27:15.5855028+00:00",
"date_last_job": "2025-07-05T22:27:15.5855028+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-05T22:27:15.5855028+00:00",
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00",
"is_mobile_installation": true
},
"job_type_id": "d80108d2-519d-4c76-8239-46231f5ee87a",
"job_type_code": "sample string 7",
"job_type": {
"id": "4facb3da-5541-4c19-beb6-f40bd1d68806",
"name": "sample string 2",
"sales_organization_id": "c2c6be8c-723b-41e5-ae95-c28bf0df3301",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00",
"code": "sample string 7"
},
"job_priority_id": "6fdf30bc-c19f-4b50-93bb-eb4142ffc2ce",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "360213fe-7a9e-437b-ad5c-0eda94043a77",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "51466c8a-6f3f-4c83-952c-65c5c09a6ffe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00"
},
"job_status_id": "8fea9e1b-90db-4f52-8a0a-829b96d5d7a3",
"job_status_code": "sample string 11",
"db_address_id": "9ae1821b-22d1-40f4-a83d-06aa707eb95f",
"contact_id": "11d0f490-bd7d-4fa8-a246-0180ffc68fce",
"requested_by_company_id": "0dc6fa0b-7279-43d6-a7d1-706ede0d4671",
"requested_by_contact_id": "c0a7620a-bb35-4485-a01b-f41f5411909d",
"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-05T22:27:15.5855028+00:00",
"due_date": "2025-07-05T22:27:15.5855028+00:00",
"date_create": "2025-07-05T22:27:15.5855028+00:00",
"date_update": "2025-07-05T22:27:15.5855028+00:00",
"date_closed": "2025-07-05T22:27:15.5855028+00:00",
"suggested_user_id": "0094f8be-fff8-4f30-b314-8fc3636882e9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "96af2fb4-9949-4c19-be76-e76dcc517878",
"db_language_id": "4915a7be-3474-46bc-948d-324912e0218a",
"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-05T22:27:15.5855028+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "70b92c80-8941-4778-b936-d30bdc57ea0a",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "79b482d6-079d-4149-91b9-a96236284bd0",
"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": "f2da95b5-f983-4da4-8b94-392cdc6a7d4b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "80549164-51f0-427d-b2df-1a807e63184e"
},
"suggested_date_start": "2025-07-05T22:27:15.5855028+00:00",
"skill_id": "51b0ace4-0a2b-4313-87a1-4217900f44a1",
"skill_code": "sample string 32",
"skill": {
"id": "3669376d-3e49-42bb-876b-6e559f422d9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2c4a2a9e-b37b-4c2b-a421-6a512126f0b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46369d57-d51f-4c48-a8cf-2425b91f5bd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bcc4b2ef-97e6-4762-bff6-c4a00fcd9801",
"db_currency_id": "601ef47c-956a-4e6b-a252-80d68a98ab7f",
"db_language_id": "d93fd83f-4f57-4e37-972d-5776b434dfbb",
"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-05T22:27:15.5855028+00:00"
},
"modified_dateutc": "2025-07-05T22:27:15.5855028+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f3917d32-0612-4ea6-9e28-984f70aae992",
"date_reported_by_company": "2025-07-05T22:27:15.5855028+00:00",
"id2": 36,
"company_id": "207f38bc-f4ac-4647-b33b-6788d8781e24",
"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": "9065f378-8ed1-4cf1-9748-7b4a607b4c6f",
"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-05T22:27:15.5855028+00:00"
},
"work_instruction_details_id": "28670e5c-62dd-4020-bfd8-55457ca1e574",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d7fc53f5-b6ff-43b2-a558-229d132be207",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3463d6a0-8cb9-4f06-9ba4-0969f49d1177",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-05T22:27:15.6011399+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": "b7320f0d-e919-4f07-9343-36e04e41c756",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-05T22:27:15.6011399+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.