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": "259bd75f-18b6-4891-b6e5-464a7646b050",
"jobs_id": "33241d84-fd07-4fde-bf71-75adfcdeae49",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "74218c9e-fff6-4637-bbb9-2b06dc85e047",
"_parent_id": "e2a7cfbe-3135-4899-9b5f-48dc3d67904e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "85b71f38-60ab-429e-9991-388f69203577",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f97e383f-464e-412b-bd01-136be0dec100",
"_parent_id": "f84ad8a2-f73c-49b0-bfcb-aef1136dbec2",
"root_parent_id": "bb2d57ec-fd81-44ea-a477-465b69d9af99",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a16b0ce8-bc82-4cbd-b50c-ee7ce014fbd5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "98a75494-38be-4c13-87e1-e8cb831a4873",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06f106ac-e81c-4e13-974a-f901b35e7ed4",
"_parent_code": "sample string 6",
"sales_organization_id": "a9be34ba-4900-4bc7-8a62-ee760195a99e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00"
},
"equipment_model_id": "e3749238-b52e-456c-96e6-ca34981de5cb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b3de3f3b-c820-44b1-a8ea-6f6df9669bdb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3a050b4f-e0aa-4a90-911e-2126dbceaf8e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7660c2e5-2bd3-49db-a668-2c0946c1eee0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2fdb221b-102c-4798-99e3-912dca66d6bf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00"
},
"equipment_family_id": "7ce50e8a-06e6-45d3-bbb3-7ca2895d30c2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "98a75494-38be-4c13-87e1-e8cb831a4873",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06f106ac-e81c-4e13-974a-f901b35e7ed4",
"_parent_code": "sample string 6",
"sales_organization_id": "a9be34ba-4900-4bc7-8a62-ee760195a99e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00"
},
"date_in_production_since": "2026-07-12T19:53:14.857692+00:00",
"date_out_of_production_since": "2026-07-12T19:53:14.857692+00:00",
"date_end_support": "2026-07-12T19:53:14.857692+00:00",
"sales_organization_id": "eda35466-61d1-4b02-8c80-66e4985e1171",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+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-12T19:53:14.857692+00:00"
},
"project_status_id": "53f12b80-1cac-4d80-9f66-ed887648e1b8",
"project_status_code": "sample string 10",
"project_status": {
"id": "fd8bbaf5-f50e-44db-88da-6e4f5d4ef828",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "44fca29c-43d9-4c8f-9fba-0e6623555fab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00"
},
"company_id": "9f8cb517-f238-4fbc-a374-cbbf4d2b9b8d",
"company_code": "sample string 12",
"db_address_id": "c3ca135b-6639-42f5-9e9d-d4f0326e590e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "26548e2e-487c-4fc3-9bcf-dc2b699beac4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d1db70a8-3b57-4b8a-a290-e4c06edbf9f5",
"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-12T19:53:14.857692+00:00",
"date_create": "2026-07-12T19:53:14.857692+00:00",
"date_update": "2026-07-12T19:53:14.857692+00:00",
"updated_by_user_id": "98193d9d-10e0-435b-9327-086c38033b6e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-12T19:53:14.857692+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-12T19:53:14.857692+00:00",
"date_last_job": "2026-07-12T19:53:14.857692+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-12T19:53:14.857692+00:00",
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00",
"is_mobile_installation": true
},
"job_type_id": "d139c9c4-5ee3-4903-80b1-f580b4d890a6",
"job_type_code": "sample string 7",
"job_type": {
"id": "5ce8ce63-b299-4101-b3df-5dcbcffd8b99",
"name": "sample string 2",
"sales_organization_id": "fb6aedff-caec-47a3-9580-89b43d9ea5e4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00",
"code": "sample string 7"
},
"job_priority_id": "a9db4f23-aa99-4800-aa5f-dbbf95fb606c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "84fd25d0-a8a3-4d66-9744-9608a7d74629",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a0d14454-275f-4ffe-a141-7eb0891ac69f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00"
},
"job_status_id": "1e433641-f03d-4bce-b742-19d1ef410b7f",
"job_status_code": "sample string 11",
"db_address_id": "968eddcc-8d3d-413c-a46b-d6ca7c3107de",
"contact_id": "8987d4fc-2126-430d-a2ab-1e1d22093a81",
"requested_by_company_id": "e8a7f679-a4f8-42b5-bc9f-cdcfd81de678",
"requested_by_contact_id": "d67c659b-7f38-4fb7-9a94-5065c9e44b0c",
"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-12T19:53:14.857692+00:00",
"due_date": "2026-07-12T19:53:14.857692+00:00",
"date_create": "2026-07-12T19:53:14.857692+00:00",
"date_update": "2026-07-12T19:53:14.857692+00:00",
"date_closed": "2026-07-12T19:53:14.857692+00:00",
"suggested_user_id": "26689470-1823-4ef4-ab4d-03ec96830abd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "65c9cd17-5e4d-4d39-9e9b-fdf71c3446e9",
"db_language_id": "d791cf41-72dd-4800-8109-b0846a04de66",
"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-12T19:53:14.857692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9b40058-a10f-4d8e-a0c5-4a167cd49308",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c77a8eec-ece3-47fc-b4c7-c87563eafcd0",
"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": "ad8c6a03-500c-4f54-9306-5ec04c72798b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cd5bc640-2acd-474d-8a48-924e5356e45e"
},
"suggested_date_start": "2026-07-12T19:53:14.857692+00:00",
"skill_id": "f6525998-4990-4100-9201-70031d208f04",
"skill_code": "sample string 32",
"skill": {
"id": "9b4322d4-1790-432a-b120-b57399db5a92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dc1cefd3-5ab0-462a-a4ac-77004c4b284a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3f93020a-a8b4-4acd-b294-8fd218addf2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43f43499-8e87-42ce-a9ac-6fb0ea36d0a6",
"db_currency_id": "83f2d3fb-e087-4499-92e0-2b4b8fdcc508",
"db_language_id": "89bdd004-c426-4a0f-aed9-2d9d79ebbe9c",
"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-12T19:53:14.857692+00:00"
},
"modified_dateutc": "2026-07-12T19:53:14.857692+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2050d594-3526-4f09-9e0f-f577f3762408",
"date_reported_by_company": "2026-07-12T19:53:14.857692+00:00",
"id2": 36,
"company_id": "29971343-8a75-49d9-b287-cb6e27533ea4",
"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": "cfe6a66f-1e7b-419a-ae5a-81d6045e955f",
"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-12T19:53:14.857692+00:00"
},
"work_instruction_details_id": "ac2d4867-f907-444d-9321-188056d17385",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b78807ac-6e04-48ad-ac27-59ac92b0bd06",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6a6d5f15-2fe4-4425-be72-d3f1092674c9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-12T19:53:14.857692+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": "c7c58724-ff20-471e-a375-cc5646ceed41",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-12T19:53:14.873316+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.