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": "32834d21-607d-4ee0-b70b-52c46f0d3f39",
"jobs_id": "7a66d526-3bc8-4c50-a341-07b80e7d4f1d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "10c3cfc3-7384-492e-aa56-bcb750100296",
"_parent_id": "71358e43-d46e-453c-97df-d3291dbd806a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e0e787b3-3d44-48f3-95e7-0add9c24ad58",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c1d2674e-6ed5-42c3-8b2e-225eb319c165",
"_parent_id": "5abcd909-e824-4bf9-a972-d3624a5a4260",
"root_parent_id": "c8bb53b4-ecca-4a5a-ba2b-d327bea9ff48",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8f77c3f-d4e3-4505-9c60-e5cf34da523a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a8e9491b-3209-4eed-a16c-8173e5bd8ebb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc08a7dd-86c9-4fb9-8a1e-74e02bbbe75b",
"_parent_code": "sample string 6",
"sales_organization_id": "93afa43d-14ba-4ae8-a8be-fb7f6056a69a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
},
"equipment_model_id": "cb639a1d-099c-429f-9565-071184d9b555",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d8f29c2-c2e3-43e8-a7d9-f67c8289f0ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6867af4a-0f01-4e03-9a5f-ae44d349b396",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ae500abe-4be4-407b-90ad-660632957c1a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a9d25b49-f43d-4a54-8a27-9cfd08330931",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
},
"equipment_family_id": "8395928a-7cab-4e87-a1a3-ed39beb6bc86",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a8e9491b-3209-4eed-a16c-8173e5bd8ebb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc08a7dd-86c9-4fb9-8a1e-74e02bbbe75b",
"_parent_code": "sample string 6",
"sales_organization_id": "93afa43d-14ba-4ae8-a8be-fb7f6056a69a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
},
"date_in_production_since": "2026-06-09T07:44:48.5028819+00:00",
"date_out_of_production_since": "2026-06-09T07:44:48.5028819+00:00",
"date_end_support": "2026-06-09T07:44:48.5028819+00:00",
"sales_organization_id": "b4f02c24-b541-4bc9-95a1-a427cf95706e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+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-06-09T07:44:48.5028819+00:00"
},
"project_status_id": "037674fc-ab14-4e67-91e7-3dbcaa53dc10",
"project_status_code": "sample string 10",
"project_status": {
"id": "e77bc234-a453-437c-b21a-5c8e67f50876",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9dcd123e-def0-4c8a-9774-95674fd6c529",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
},
"company_id": "74198d4c-f842-47e2-b7de-b4089bb1e5d6",
"company_code": "sample string 12",
"db_address_id": "5a67b92b-749c-4f5a-8573-5226f9e239be",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "61af1eb8-e090-49ae-84f3-c77da5e40e39",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "db92bea8-2f98-469a-b334-5229446f35d0",
"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-06-09T07:44:48.5028819+00:00",
"date_create": "2026-06-09T07:44:48.5028819+00:00",
"date_update": "2026-06-09T07:44:48.5028819+00:00",
"updated_by_user_id": "323b40bc-15e5-4877-93f4-4cb037c99726",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T07:44:48.5028819+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T07:44:48.5028819+00:00",
"date_last_job": "2026-06-09T07:44:48.5028819+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T07:44:48.5028819+00:00",
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00",
"is_mobile_installation": true
},
"job_type_id": "683b7bf4-2d85-4779-af2a-d576fad8de79",
"job_type_code": "sample string 7",
"job_type": {
"id": "1a3bc65c-529b-4988-967e-27fb4e4b3c04",
"name": "sample string 2",
"sales_organization_id": "d9176787-1cb7-4248-8b23-c2f76c51ccd0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00",
"code": "sample string 7"
},
"job_priority_id": "7e8001fc-5be4-4f6d-829d-166992525f3c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bda6be61-957f-436b-89a8-7386cb8607cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "29d9d1e4-ebe4-4452-a11c-dd7ce9e544f1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
},
"job_status_id": "c1f876c3-d0c2-4989-a4d3-4ed870dc9eac",
"job_status_code": "sample string 11",
"db_address_id": "92f4f404-0cfb-4ffd-85dc-89224e820b51",
"contact_id": "3c9dd1ca-c619-41d0-88ed-23006e85b85f",
"requested_by_company_id": "d6a02b83-d2c0-4a48-b714-ffb6472f4852",
"requested_by_contact_id": "66752da9-b278-4455-8e3d-67bb7b783954",
"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-06-09T07:44:48.5028819+00:00",
"due_date": "2026-06-09T07:44:48.5028819+00:00",
"date_create": "2026-06-09T07:44:48.5028819+00:00",
"date_update": "2026-06-09T07:44:48.5028819+00:00",
"date_closed": "2026-06-09T07:44:48.5028819+00:00",
"suggested_user_id": "4e0532e9-6276-4aa5-9275-de282429e41c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5195e89c-440c-49a8-9aa2-e7ea0e145feb",
"db_language_id": "81d0d393-131b-4cbf-ad0f-cb2f7c548ed0",
"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-06-09T07:44:48.5028819+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a2fa783d-9a8e-4c67-9ce5-81013730c467",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "eaf6f9e5-3af3-45fe-b3a2-1a2d3725d501",
"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": "8d608373-6ce3-4ac4-b378-b2aaec8f8fdb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a9e6c4c5-8e9a-487b-85ba-f1bc26d07da4"
},
"suggested_date_start": "2026-06-09T07:44:48.5028819+00:00",
"skill_id": "95fd0587-4af3-43a7-a22f-0e48250294a5",
"skill_code": "sample string 32",
"skill": {
"id": "e55fb18a-8791-431c-b91a-99accc5f7580",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "29b7e400-6f18-4bf1-9329-5cdfbcd87e3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90388f52-96da-4c83-87bc-e302dd31106b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6620a6f6-7a61-47d5-8154-508b1c77242a",
"db_currency_id": "0ab5cc28-6673-4940-bc31-836eed0b0619",
"db_language_id": "12dee81d-08c2-4420-a49f-a1f0420fffbf",
"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-06-09T07:44:48.5028819+00:00"
},
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b42a4c11-5226-4f24-876d-4b13d2a980ff",
"date_reported_by_company": "2026-06-09T07:44:48.5028819+00:00",
"id2": 36,
"company_id": "c2428b8e-aaaa-4f02-a5a9-d31a472194ca",
"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": "3e22d5e6-4651-4751-b8d0-712c233bf3e7",
"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-06-09T07:44:48.5028819+00:00"
},
"work_instruction_details_id": "8b84cdc2-70c2-4555-9a8f-e99fa3126147",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e2490ba5-44cf-48d1-b5d7-eab6e443fdf3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a8d3c56a-c49d-4196-90e6-872e57038997",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T07:44:48.5028819+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": "e429750a-14a3-47e5-9ce0-1bc92f0c8956",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T07:44:48.5028819+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.