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": "eb059191-38c7-404b-a23e-6eab9de793f0",
"jobs_id": "7b2a8972-430e-43f8-83eb-8afb440ad60c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "97e1d9d6-d9d5-4e17-a6d9-43747a76744d",
"_parent_id": "e21570fc-db9c-4bb1-939d-5fd911144a07",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c856fbda-87d4-4e47-81f0-7a968bc83595",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6cfc7f2b-dafa-4c20-975b-59fc1dc80790",
"_parent_id": "a4e1b96f-16fb-4de8-be83-1a8455d70783",
"root_parent_id": "d9749e14-6a25-4fc0-b4dd-5d3c5614717d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "35698c16-9586-4094-821c-934cbdba2b6b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "85abe511-fca5-441e-9373-9be8e64701dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aaff3d7d-94e8-492b-87ca-e0338e2ad76b",
"_parent_code": "sample string 6",
"sales_organization_id": "93e11f30-f18f-4e7f-9235-460e3e843dca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
},
"equipment_model_id": "dd9cd9fa-8e63-4bca-b8c9-ab8f961d468f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b63942bf-7f67-4c2f-817f-4f73872545d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8abb5fca-142b-4ac1-811f-deb224b446da",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c8e00dbc-5f91-473d-bf7a-76df71cd15d6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e98d5f6d-c396-43d0-95c7-4a34309da523",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
},
"equipment_family_id": "b35a2371-c468-4584-af81-ad5b44a38a1b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "85abe511-fca5-441e-9373-9be8e64701dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aaff3d7d-94e8-492b-87ca-e0338e2ad76b",
"_parent_code": "sample string 6",
"sales_organization_id": "93e11f30-f18f-4e7f-9235-460e3e843dca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
},
"date_in_production_since": "2025-11-25T02:08:32.4584407+00:00",
"date_out_of_production_since": "2025-11-25T02:08:32.4584407+00:00",
"date_end_support": "2025-11-25T02:08:32.4584407+00:00",
"sales_organization_id": "dfb31431-2b1f-4697-994f-58af220c5b37",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+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-11-25T02:08:32.4584407+00:00"
},
"project_status_id": "94d9b5d3-72e1-4438-8b25-d70cb063dec9",
"project_status_code": "sample string 10",
"project_status": {
"id": "dd274068-b1c1-4080-80c6-56a076549b15",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3d84af66-66e5-419d-901f-bd79f4ff0905",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
},
"company_id": "794d9743-bb4a-4583-afcb-0aa21ac080a2",
"company_code": "sample string 12",
"db_address_id": "39df773f-2d14-4669-82c1-567dc79e81e2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9656f571-811f-4c73-b230-dbc9332c3207",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cf1cc356-6ff7-4eeb-9b93-b5a38b59ead7",
"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-11-25T02:08:32.4584407+00:00",
"date_create": "2025-11-25T02:08:32.4584407+00:00",
"date_update": "2025-11-25T02:08:32.4584407+00:00",
"updated_by_user_id": "ed0624d9-cd73-4a11-aad4-c1fc3aeb3c2c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-25T02:08:32.4584407+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-11-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-25T02:08:32.4584407+00:00",
"date_last_job": "2025-11-25T02:08:32.4584407+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-25T02:08:32.4584407+00:00",
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00",
"is_mobile_installation": true
},
"job_type_id": "ccddba65-5c7c-4d9e-a39d-09d2796c11a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "5daf4982-2b4f-4417-a082-fe520811f0b8",
"name": "sample string 2",
"sales_organization_id": "38096dc3-e654-4222-a392-5d115b29d62b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00",
"code": "sample string 7"
},
"job_priority_id": "2bc6cc89-3088-4015-955b-7283fc438b17",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "226ae7a7-04f7-400d-bb1a-9ea157f335dd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e012f834-50cb-46b6-a5d9-7a8f5967dd91",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
},
"job_status_id": "f1add26d-48bf-42c9-98d3-4b8d7b33adbd",
"job_status_code": "sample string 11",
"db_address_id": "82325fd8-bec0-4841-8f7c-a036d66441a3",
"contact_id": "73bd5ae7-0208-49d0-8711-c58f3cea4805",
"requested_by_company_id": "9a19b1bb-9ba1-4838-821f-35dffac2e9f9",
"requested_by_contact_id": "ffcbbec4-cff2-4dbb-a21b-bafe60003b13",
"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-11-25T02:08:32.4584407+00:00",
"due_date": "2025-11-25T02:08:32.4584407+00:00",
"date_create": "2025-11-25T02:08:32.4584407+00:00",
"date_update": "2025-11-25T02:08:32.4584407+00:00",
"date_closed": "2025-11-25T02:08:32.4584407+00:00",
"suggested_user_id": "ab761968-5e6a-48b8-b627-a807c8af2729",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b75019e0-093a-4632-a143-461dfb579655",
"db_language_id": "a9662697-d1f2-4c7b-a9da-d06e2c3bbf72",
"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-11-25T02:08:32.4584407+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0abd270b-697b-488e-b8de-1c10d5b6c1ee",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7d29ae59-95d7-445d-8119-83f427f350d3",
"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": "fa8d8cfc-1f94-4c54-8abe-2372f80aca78",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7877bf0f-b12a-48f9-8339-5c2bdccaa684"
},
"suggested_date_start": "2025-11-25T02:08:32.4584407+00:00",
"skill_id": "88d0a752-4cde-420c-b14b-2967d108b684",
"skill_code": "sample string 32",
"skill": {
"id": "8e126743-b391-4949-aaec-8326055a6767",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "76de1fc3-627d-49e5-89a6-67dbf484fd69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9565efe1-0bd9-446a-905d-ac832b93cc2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f353cba7-c4ce-4c7f-8018-09c4d2c16f78",
"db_currency_id": "967093e9-3377-4130-95e8-801040566072",
"db_language_id": "c6271ebe-9c22-486e-a67c-b953382d0af9",
"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-11-25T02:08:32.4584407+00:00"
},
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2d9d06ef-66f1-4e6f-bda3-546088bdc465",
"date_reported_by_company": "2025-11-25T02:08:32.4584407+00:00",
"id2": 36,
"company_id": "41b4efcb-2265-4534-9a77-d5c237f451ce",
"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": "1a2c24f0-6c20-4d45-b908-e5d5436e0509",
"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-11-25T02:08:32.4584407+00:00"
},
"work_instruction_details_id": "a091fc2b-2ede-4c02-85ff-b66411e59cd4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0a974afd-8456-4683-afea-ba7a7ea52566",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0ca7bd58-fcd8-486e-b88e-377c5606044a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-25T02:08:32.4584407+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": "d2149dde-2766-4e35-a231-f5431f72403a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-25T02:08:32.4584407+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.