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": "d9b0a7aa-08d4-4cc5-9558-920cdff5c397",
"jobs_id": "e36b91f3-a80c-47a5-a63d-bc76d6242bf7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "558a1f35-f1e8-4060-948b-b10861338ff9",
"_parent_id": "69054bb3-f499-4e35-b6e3-d983edf82e36",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "34182f5b-40a0-40e9-b09e-a99771958a54",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e0449fee-2a3b-4f15-beec-368f03e06d86",
"_parent_id": "6d5935c5-759b-4afb-b227-511acf3ab71d",
"root_parent_id": "d64d7106-ea7c-4b56-8acf-6ce74ec02b15",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c79892dc-89a5-45a4-a2d4-8da0e5fd67e7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d218dd17-fe99-4c67-a2d9-49729bee6d58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1ed68e90-e2bf-4084-b14e-524a9938f16a",
"_parent_code": "sample string 6",
"sales_organization_id": "f7932259-fd29-41f1-b7ed-8d32a15825f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
},
"equipment_model_id": "67276899-1984-4eb0-83ab-586a8d760855",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a6c42a8f-9e14-412c-92a4-4d0b354a1237",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4e9c3a01-2cc3-4af7-855d-2c3b4728ed6d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4c664e34-36ea-435a-9667-a6045abbc6f9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "39ed46de-b315-447b-ae21-baefe37a74fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
},
"equipment_family_id": "b4ebf2c5-28f2-48a3-8e83-d0c5d3d79796",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d218dd17-fe99-4c67-a2d9-49729bee6d58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1ed68e90-e2bf-4084-b14e-524a9938f16a",
"_parent_code": "sample string 6",
"sales_organization_id": "f7932259-fd29-41f1-b7ed-8d32a15825f8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
},
"date_in_production_since": "2026-07-17T09:28:53.7118211+00:00",
"date_out_of_production_since": "2026-07-17T09:28:53.7118211+00:00",
"date_end_support": "2026-07-17T09:28:53.7118211+00:00",
"sales_organization_id": "23ffca01-940f-40da-9239-516e055ba012",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+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-07-17T09:28:53.7118211+00:00"
},
"project_status_id": "e1035060-1f2e-47a2-b0a0-b573bd7b4890",
"project_status_code": "sample string 10",
"project_status": {
"id": "21cd03b9-cd61-4950-82b8-7d64f0d22209",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50c66215-7cc9-4e87-90cb-c8680b9614a9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
},
"company_id": "da279f44-e7f7-4549-bfc8-06db4ee6e347",
"company_code": "sample string 12",
"db_address_id": "f03abb21-0ab8-48e1-adce-bf8937565583",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a90f02ca-2032-445f-8d47-0f5b43b0cd05",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e5531f50-d779-45df-b37c-4e8a6a9869d5",
"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-07-17T09:28:53.7118211+00:00",
"date_create": "2026-07-17T09:28:53.7118211+00:00",
"date_update": "2026-07-17T09:28:53.7118211+00:00",
"updated_by_user_id": "03dd500a-a0a2-48bf-8ce4-a16e786d01fc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-17T09:28:53.7118211+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-07-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-17T09:28:53.7118211+00:00",
"date_last_job": "2026-07-17T09:28:53.7118211+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-17T09:28:53.7118211+00:00",
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00",
"is_mobile_installation": true
},
"job_type_id": "d5351519-2578-451c-a1a5-0c1f93e2911e",
"job_type_code": "sample string 7",
"job_type": {
"id": "b211ae9b-395d-4fdb-931e-0bc7c6f3910b",
"name": "sample string 2",
"sales_organization_id": "e4dfe054-2b33-41b4-a831-bf7c16d29a09",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00",
"code": "sample string 7"
},
"job_priority_id": "30ceaccb-9fe4-4b0b-983c-e2cfe112f5b3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7fd61bd3-a551-457d-9314-dd485d5f660a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "64f08889-b264-4802-a680-4c1493d0e78b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
},
"job_status_id": "3231ecb4-4471-46fb-bcc1-cb9030f09e03",
"job_status_code": "sample string 11",
"db_address_id": "e06ed0fa-8b58-458d-b32c-9c7397c961c1",
"contact_id": "738491c0-9adb-445d-b430-3d18c4bf88c3",
"requested_by_company_id": "ab60fc1d-fa00-4139-aa84-6e62afb5cd75",
"requested_by_contact_id": "c535f08b-c824-4158-b19c-e907be201a41",
"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-07-17T09:28:53.7118211+00:00",
"due_date": "2026-07-17T09:28:53.7118211+00:00",
"date_create": "2026-07-17T09:28:53.7118211+00:00",
"date_update": "2026-07-17T09:28:53.7118211+00:00",
"date_closed": "2026-07-17T09:28:53.7118211+00:00",
"suggested_user_id": "f7d8b606-180b-4850-81c2-e4efe3e031c8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "85161717-d826-4704-af32-708c72cb2912",
"db_language_id": "0af041a9-7cda-412f-bea8-922e3a8fc1ba",
"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-07-17T09:28:53.7118211+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a4dae4ea-d3ae-4582-98a6-82eae26a9faf",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8279d3b-c108-4ab1-a36c-7bf3eb3f9483",
"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": "f60f105f-b0a0-42a6-abba-3c848dd109c8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b7d99f57-e2e4-46ba-8a63-46161d60118d"
},
"suggested_date_start": "2026-07-17T09:28:53.7118211+00:00",
"skill_id": "e0cb8644-922e-4a72-9840-e4a4089cd8ac",
"skill_code": "sample string 32",
"skill": {
"id": "20d7916d-1b77-4d01-b30d-5962a29b0e9a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1fbea920-2ec5-4098-a17c-23cefa9a2d76",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "254a8ad6-3dc3-4357-9ab2-c7b93cbfd19e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eece8575-ef72-4140-87d2-9c073f61b3a9",
"db_currency_id": "5a6f56c7-6396-487e-abf1-3e6edbe9634f",
"db_language_id": "2b3be4dc-cf92-4996-9d41-f4440a040b3e",
"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-07-17T09:28:53.7118211+00:00"
},
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d84feb65-897c-400a-96c4-e004c54a8893",
"date_reported_by_company": "2026-07-17T09:28:53.7118211+00:00",
"id2": 36,
"company_id": "c71507cd-7118-4d30-a35e-ba3da749051f",
"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": "4854408b-b672-4470-9754-1b9b1055528c",
"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-07-17T09:28:53.7118211+00:00"
},
"work_instruction_details_id": "90c9f039-c2df-4f50-a601-c54e60dbc0cc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e51204ab-eb33-4e77-99dc-f28324895b17",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0002d96b-01b7-42f5-a42d-f9129a4cafea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-17T09:28:53.7118211+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": "c0bf1ed0-9c61-4610-9fd0-a222bafb9f7b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-17T09:28:53.7118211+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.