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": "a2ac4b65-3316-42b4-a81a-6c3fba3b5d41",
"jobs_id": "2d8c11af-44ca-4b56-9065-5ce3d793c1ac",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "008460c9-14af-4117-aa37-69ad906e501f",
"_parent_id": "9c7a1499-bac8-45ba-b0f5-76747f20d3b0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e4f51f3-3d3c-4ed1-bf87-fc3118ea3be0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59aefb5a-1e9d-464f-9178-c7b72595b51d",
"_parent_id": "839ea6a3-41ed-4757-b6a5-7d224a970d59",
"root_parent_id": "c1a252f9-6fb8-426e-9aab-e61c33ae8a67",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fb6ad368-b5d6-43cd-914d-2fcf69b9c886",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b0ffcd27-a01a-4717-af5f-924321b32131",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "111a49f5-eedc-453e-8ed3-f88b4eb85de7",
"_parent_code": "sample string 6",
"sales_organization_id": "197feaa8-602b-4d74-8172-a671eab65ef1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
},
"equipment_model_id": "9d102132-f199-466d-b57d-84c05f69c5ef",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "de3c5c6f-196c-4d1c-a456-872cbe229fb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cd0a0030-d497-459c-847d-695b04173f54",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "45c41487-2808-4731-bd75-7c5e663a4af3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f6c8e0d-3d62-41f1-a0a1-7213aa276e4d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
},
"equipment_family_id": "a91f01ec-a6c0-4144-bcea-0d1c472d1f50",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b0ffcd27-a01a-4717-af5f-924321b32131",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "111a49f5-eedc-453e-8ed3-f88b4eb85de7",
"_parent_code": "sample string 6",
"sales_organization_id": "197feaa8-602b-4d74-8172-a671eab65ef1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
},
"date_in_production_since": "2026-11-12T16:33:19.5299404+00:00",
"date_out_of_production_since": "2026-11-12T16:33:19.5299404+00:00",
"date_end_support": "2026-11-12T16:33:19.5299404+00:00",
"sales_organization_id": "81ef3705-d53f-4fbf-af6a-1ed9be4a1900",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+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-11-12T16:33:19.5299404+00:00"
},
"project_status_id": "19a9f9bd-04d3-4084-a4fb-ab33c815c0c1",
"project_status_code": "sample string 10",
"project_status": {
"id": "e838d2d5-19c4-4908-8c14-cc9807951c18",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2ff91adc-c830-46f3-883c-bbb91bdff64e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
},
"company_id": "30e852f7-6ae7-40c7-8446-4f0b72008102",
"company_code": "sample string 12",
"db_address_id": "1c34aa30-ab41-4201-9680-ef42647394b6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d093b2a5-b813-4aed-b623-d56f6c0c5f63",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94c22f74-7ad4-4c3d-93ee-b2b054e4e2e3",
"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-11-12T16:33:19.5299404+00:00",
"date_create": "2026-11-12T16:33:19.5299404+00:00",
"date_update": "2026-11-12T16:33:19.5299404+00:00",
"updated_by_user_id": "594051a2-211a-44d9-8a87-e5b1953fdd23",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-12T16:33:19.5299404+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-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-12T16:33:19.5299404+00:00",
"date_last_job": "2026-11-12T16:33:19.5299404+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-12T16:33:19.5299404+00:00",
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00",
"is_mobile_installation": true
},
"job_type_id": "502b5a83-85f7-43a2-afa5-2042c3a60743",
"job_type_code": "sample string 7",
"job_type": {
"id": "a9352d23-dc49-4f05-98a8-368c4126b08e",
"name": "sample string 2",
"sales_organization_id": "e0d4addc-b074-4c13-b641-883bde408678",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00",
"code": "sample string 7"
},
"job_priority_id": "9045d5b9-d981-47ff-8ba1-29983c6adead",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb1e1f46-8bd6-4a02-abf6-a30cda59088a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4d90d9fc-59ce-4a5c-bb96-4c7dcb13de5c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
},
"job_status_id": "68df8047-f824-4409-9efb-51140334a7aa",
"job_status_code": "sample string 11",
"db_address_id": "f2cf1919-e4f5-4815-937d-7122aa06d04c",
"contact_id": "87eb8e9a-9ff9-4f25-9dee-b114493ea30b",
"requested_by_company_id": "e29708c2-15ca-4b34-aaf0-0edbeb038226",
"requested_by_contact_id": "a40f93b9-c236-42a6-9fa6-9957b07150da",
"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-11-12T16:33:19.5299404+00:00",
"due_date": "2026-11-12T16:33:19.5299404+00:00",
"date_create": "2026-11-12T16:33:19.5299404+00:00",
"date_update": "2026-11-12T16:33:19.5299404+00:00",
"date_closed": "2026-11-12T16:33:19.5299404+00:00",
"suggested_user_id": "1647cf7b-cd32-4446-b2ab-ffcbdfad8df5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6d860d8f-f047-4355-8f6b-72c005d53d52",
"db_language_id": "536a879e-8e8f-4f56-915b-27430820a640",
"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-11-12T16:33:19.5299404+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "59a51bdf-9cc7-438e-bcea-016f375c73f9",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9c7a3675-56b3-47e0-b1b8-207b34a33ea6",
"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": "a3bc085c-d2bc-427c-9039-312da1659993",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b444a56b-4cc2-4a3e-9628-ec974d0ab0d0"
},
"suggested_date_start": "2026-11-12T16:33:19.5299404+00:00",
"skill_id": "8f87d4c3-8722-4e6a-9b1f-b667ac6e776d",
"skill_code": "sample string 32",
"skill": {
"id": "27da68f5-5398-41f4-8da3-c2dcc07d7889",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ef58ab9f-209b-491f-b09f-de699a256958",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7460820c-bbe0-4a35-8f91-140beaa77a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "408fa147-fc48-48dc-bb03-ff70c59435f2",
"db_currency_id": "5c5a74f5-ab37-484a-8915-f7dde88f85ad",
"db_language_id": "fbfc4db3-b595-4d77-9b8a-5d72468e4952",
"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-11-12T16:33:19.5299404+00:00"
},
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "742a8210-7dd9-47fd-80d9-8005fe5137f4",
"date_reported_by_company": "2026-11-12T16:33:19.5299404+00:00",
"id2": 36,
"company_id": "186bcd4d-84ca-44ab-9932-9045d51a7b61",
"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": "46861755-7039-45fb-8820-6bc2d4b137d4",
"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-11-12T16:33:19.5299404+00:00"
},
"work_instruction_details_id": "79f23a6d-6d2a-4fb8-bd46-ad01e605397c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "aa719be0-0838-4092-a120-21a86edbf7b9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7ec38c48-2be2-47bc-90ab-6426d9619bac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-12T16:33:19.5299404+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": "51a13be1-cff1-44b6-ae53-e9f29ed279ae",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-12T16:33:19.5299404+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.