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": "c6a1da21-3a68-4156-bf4a-6d895320af9b",
"jobs_id": "a7823e47-fbe9-4229-8a90-32d1144745b9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fafe4877-547f-48a6-81d8-b816a899ced0",
"_parent_id": "a0b305fd-3694-4091-9447-047a4cf6eff9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fb222e26-8822-43c0-9004-ab2707beae48",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e9d78823-0a28-46f4-b800-1f3b3537cd3b",
"_parent_id": "8ce3d384-aa60-4b50-825c-0f2e9de0de4c",
"root_parent_id": "a19a4de2-6c43-4668-9e1d-9008f72823ee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "90edd295-ffbf-4983-b93e-da857a1e566c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4062704f-65f8-43f5-844e-c45336886054",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71fe589f-f36e-4251-9bf2-43b3ed20af81",
"_parent_code": "sample string 6",
"sales_organization_id": "540450e2-454d-4cfa-8ebe-b07cda46764a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"modified_dateutc": "2026-11-13T15:39:00.7669452+00:00"
},
"equipment_model_id": "70d8e788-7227-4c69-a8b5-5bf43ed79826",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2d1a7cf4-8c47-4440-9709-b5573cf7d74b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "794294cc-72b5-4630-9a10-3c88e5d378f3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f85182dd-ef67-49ad-975d-815bcd29d0f6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2ba31e62-1b7e-46a6-8a60-6cbcd4347a7a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"modified_dateutc": "2026-11-13T15:39:00.7669452+00:00"
},
"equipment_family_id": "f6d8d0b5-2183-49f6-b81c-3fa01ce6ea41",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4062704f-65f8-43f5-844e-c45336886054",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "71fe589f-f36e-4251-9bf2-43b3ed20af81",
"_parent_code": "sample string 6",
"sales_organization_id": "540450e2-454d-4cfa-8ebe-b07cda46764a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"modified_dateutc": "2026-11-13T15:39:00.7669452+00:00"
},
"date_in_production_since": "2026-11-13T15:39:00.7669452+00:00",
"date_out_of_production_since": "2026-11-13T15:39:00.7669452+00:00",
"date_end_support": "2026-11-13T15:39:00.7669452+00:00",
"sales_organization_id": "b5cf6b07-17ce-4ff8-8214-68506bfc1593",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+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-13T15:39:00.7669452+00:00"
},
"project_status_id": "0b5d7cd4-a6d9-4df7-8923-180e3e2e153e",
"project_status_code": "sample string 10",
"project_status": {
"id": "1328c86c-a4e1-4133-bb34-7fdc3fca5aab",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d6dcdfbd-8fa4-4c7a-a69a-a5b07e272f5e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T15:39:00.7669452+00:00"
},
"company_id": "e51ab25b-d944-4ab6-beda-47bce504dc51",
"company_code": "sample string 12",
"db_address_id": "57054540-ed2c-4083-ad60-9acdc2ab5c75",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f945b052-7ee3-4d39-ac77-a209e6039726",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "27759651-fddb-406c-9fb4-e58839838af6",
"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-13T15:39:00.7669452+00:00",
"date_create": "2026-11-13T15:39:00.7669452+00:00",
"date_update": "2026-11-13T15:39:00.7669452+00:00",
"updated_by_user_id": "aa51c7f6-8f3f-4b22-98de-afc1113e52e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-13T15:39:00.7669452+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-13T15:39:00.7669452+00:00",
"date_last_job": "2026-11-13T15:39:00.7669452+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-13T15:39:00.7669452+00:00",
"modified_dateutc": "2026-11-13T15:39:00.7669452+00:00",
"is_mobile_installation": true
},
"job_type_id": "53a44860-2b98-4b25-b6de-d90227bb5aef",
"job_type_code": "sample string 7",
"job_type": {
"id": "6a350503-2890-4d58-b2ca-fe7875fab595",
"name": "sample string 2",
"sales_organization_id": "dd02ecf3-d915-41aa-9a20-cbbb1dba84c0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-13T15:39:00.7669452+00:00",
"code": "sample string 7"
},
"job_priority_id": "73ecef36-e306-410d-883a-93df4b88d6f6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4b386f6f-2c7e-4dc7-b8b5-42de0975ccef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6719b973-e574-4764-bc64-b61b0b763f39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-13T15:39:00.7825738+00:00"
},
"job_status_id": "ad54f652-ca01-4145-aa91-9f26c4d101ad",
"job_status_code": "sample string 11",
"db_address_id": "b659084d-25b7-4f10-a8a4-e212ee84588b",
"contact_id": "3268d3af-3e41-4689-b2a8-59c867c4b06b",
"requested_by_company_id": "3c291f0a-1cb6-4802-9030-16be7b794209",
"requested_by_contact_id": "17382c4d-ff18-47bd-82f7-8c5f574de290",
"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-13T15:39:00.7825738+00:00",
"due_date": "2026-11-13T15:39:00.7825738+00:00",
"date_create": "2026-11-13T15:39:00.7825738+00:00",
"date_update": "2026-11-13T15:39:00.7825738+00:00",
"date_closed": "2026-11-13T15:39:00.7825738+00:00",
"suggested_user_id": "473a2432-b5e5-4ce8-9e04-6b42cf64cec7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0a0be498-7694-4c3c-8999-60cb0c475ff2",
"db_language_id": "793da69f-5987-47eb-9a3a-6645ec1bc72a",
"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-13T15:39:00.7825738+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d15d1b63-a0d3-48c0-a43e-3dccb2c2c10a",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "55c3c1ea-10fa-4a2b-97aa-2e9d54e88142",
"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": "c714c0d5-4904-4a06-99aa-1b333c6da775",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-13T15:39:00.7825738+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f4922859-50a3-4390-99dc-a2aac795089b"
},
"suggested_date_start": "2026-11-13T15:39:00.7825738+00:00",
"skill_id": "6157f027-b82b-421e-82f2-b08930c8f772",
"skill_code": "sample string 32",
"skill": {
"id": "475c7fb5-836e-43bb-80d3-c8821e53a8ae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "79997733-5b16-49a9-9e20-a7eae66ce401",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3763a2e4-7eda-49d5-94e7-69e946837617",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e99bf8dc-1234-4bfb-9874-9b822cf21459",
"db_currency_id": "816acc6d-7f71-43c2-80fd-668117c2f4e8",
"db_language_id": "a3f6131e-0e39-474a-b16a-8e593e470cbb",
"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-13T15:39:00.7669452+00:00"
},
"modified_dateutc": "2026-11-13T15:39:00.7825738+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b026dcb5-3b3e-473e-907d-b408133666cd",
"date_reported_by_company": "2026-11-13T15:39:00.7825738+00:00",
"id2": 36,
"company_id": "cb41d256-6a23-4aa5-a8e1-dd81d19fd787",
"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": "98705786-e120-490f-8dc2-53fe04efaaea",
"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-13T15:39:00.7825738+00:00"
},
"work_instruction_details_id": "0a2a0c34-9618-4ea3-85d9-ae72603ebe45",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "99d12b22-fec0-49fd-b76d-f94598ffd493",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "99e4160c-8dc2-4126-9574-64110aa92430",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-13T15:39:00.8000853+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": "fd8c0080-0661-4acc-92b7-4593384b4c9a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-13T15:39:00.8000853+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.