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": "c062af9a-6bdf-43ee-bab9-1b56bf944560",
"jobs_id": "5e74e083-571b-45d2-9df1-5a145606bc4a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d0243fc-c959-45c3-b590-443ff6190fb4",
"_parent_id": "35a26c2e-72ea-4931-b0bb-396333c5fc3b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7c7ccc97-ddbe-4c6a-895e-a905a9eb30e2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8668f8d2-00bd-431d-8525-1ff4b9079804",
"_parent_id": "f3a963f6-cca0-4d44-8c33-764ec2515ae4",
"root_parent_id": "53849993-b2a8-4e0d-9e91-f366fdf8e775",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c6fce500-5d21-4dd6-bd01-b296f85b96c9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "98f3e717-4f36-43bb-ad64-a58d0ffb2365",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e715164-8ba6-4f7b-a166-333b4f2597a6",
"_parent_code": "sample string 6",
"sales_organization_id": "53966ea2-f239-4ed7-b173-ccdcf8e8e834",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00"
},
"equipment_model_id": "f7cf41f7-999a-46e6-9443-c9bacac598bd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "af41b16c-e049-473f-9da1-27c415efdc7a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8791d4e0-5aa8-4ea0-ba45-7c5f3fb281ff",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9bdfa521-6cab-49f3-962c-4f283bd131b9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8c0303db-2e35-46c5-b159-efd2a6efc261",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00"
},
"equipment_family_id": "f257a5be-2a15-45b0-9c03-f9370e39e10a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "98f3e717-4f36-43bb-ad64-a58d0ffb2365",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e715164-8ba6-4f7b-a166-333b4f2597a6",
"_parent_code": "sample string 6",
"sales_organization_id": "53966ea2-f239-4ed7-b173-ccdcf8e8e834",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00"
},
"date_in_production_since": "2026-04-29T21:02:53.5130436+00:00",
"date_out_of_production_since": "2026-04-29T21:02:53.5130436+00:00",
"date_end_support": "2026-04-29T21:02:53.5130436+00:00",
"sales_organization_id": "828e0a29-36d3-49aa-8aaf-0db05e7ba3bd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+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-04-29T21:02:53.5130436+00:00"
},
"project_status_id": "c13d1cef-f2d3-446e-8597-1e8d5ef9fa65",
"project_status_code": "sample string 10",
"project_status": {
"id": "e3492ae6-e9a0-4d1d-b361-1be977225144",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5c8dc06e-35c7-4ec5-83c3-4611e9884ba4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00"
},
"company_id": "e54e9453-d4f3-418f-a664-09924145b2db",
"company_code": "sample string 12",
"db_address_id": "288a7cb7-4143-404b-b217-41f3e2d47374",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0377e13b-67ca-498c-9712-3df390718200",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a7ed91d5-131c-4d49-86e5-dfc9cbecbb0d",
"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-04-29T21:02:53.5130436+00:00",
"date_create": "2026-04-29T21:02:53.5130436+00:00",
"date_update": "2026-04-29T21:02:53.5130436+00:00",
"updated_by_user_id": "e586d256-2290-44e9-993e-b15c5ca26d0a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-29T21:02:53.5130436+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-04-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-29T21:02:53.5130436+00:00",
"date_last_job": "2026-04-29T21:02:53.5130436+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-29T21:02:53.5130436+00:00",
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00",
"is_mobile_installation": true
},
"job_type_id": "554124d9-c344-4bd7-b5eb-f945fbc0584d",
"job_type_code": "sample string 7",
"job_type": {
"id": "c70193b2-8b21-417a-a267-043b2140b3e5",
"name": "sample string 2",
"sales_organization_id": "caabe69a-5c60-47f2-95b7-c1a009df467a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00",
"code": "sample string 7"
},
"job_priority_id": "63d3a677-8117-4f2a-bd9e-260f099fb107",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "836f9f51-e1cf-48a1-aa34-fd60b9f7d61d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0dac9e4d-c859-44a2-aff1-e5fa89f9eb9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-29T21:02:53.5130436+00:00"
},
"job_status_id": "0e7d898e-0cfa-41b7-a061-bd10889f372b",
"job_status_code": "sample string 11",
"db_address_id": "704b8022-8ab0-4625-9f86-e53e25a919be",
"contact_id": "0f41d57d-2573-40e9-9bb4-23777ae7afcd",
"requested_by_company_id": "49e0e91b-e4ed-49d9-a8b8-c52bc5709b47",
"requested_by_contact_id": "23cc5550-bdc3-47b4-95de-73093760a5b9",
"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-04-29T21:02:53.5130436+00:00",
"due_date": "2026-04-29T21:02:53.5130436+00:00",
"date_create": "2026-04-29T21:02:53.5130436+00:00",
"date_update": "2026-04-29T21:02:53.5130436+00:00",
"date_closed": "2026-04-29T21:02:53.5286674+00:00",
"suggested_user_id": "7c86c41d-dc78-4b07-9ff0-1708c4cedc63",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2cb9189c-92c7-45d9-8171-84ac9e8a4983",
"db_language_id": "5b38214c-34ad-48b7-ae47-bae64abc4ba6",
"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-04-29T21:02:53.5286674+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5fc98525-4e72-4cc6-a4ed-8098a2698ac0",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "14855151-b139-4473-bd90-93c47ddc7f9b",
"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": "52388655-b5a6-43f1-92a5-fb0ae0c45336",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-29T21:02:53.5286674+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "edaefff6-7671-48a7-87b2-eefe9073be82"
},
"suggested_date_start": "2026-04-29T21:02:53.5286674+00:00",
"skill_id": "f2791fd1-5e37-48a0-aaa3-3130b1a627b0",
"skill_code": "sample string 32",
"skill": {
"id": "ac71722e-27e7-4484-9864-736798545180",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a864884a-5cba-475f-bdc0-5b8fa2ca5151",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bdb303cc-c62f-4508-bcfb-d4e6f1af3b36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3c417c66-4958-4365-9517-82c50237407c",
"db_currency_id": "8cd9deb6-009c-4707-ae6f-95e1af1f667c",
"db_language_id": "187d6393-b6b2-4892-9eb8-90ebe6382cf6",
"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-04-29T21:02:53.5130436+00:00"
},
"modified_dateutc": "2026-04-29T21:02:53.5286674+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d334c7ce-28f9-479d-967c-4ff38731c580",
"date_reported_by_company": "2026-04-29T21:02:53.5286674+00:00",
"id2": 36,
"company_id": "a55842ba-df7f-4c82-a1f9-8b6532040602",
"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": "b6062f8a-6e2b-4a8e-b7ce-84230015eab6",
"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-04-29T21:02:53.5286674+00:00"
},
"work_instruction_details_id": "8ed10eed-95b3-4cde-b1e1-1ed2fbe02a4a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "41dc7af0-1abd-4ec5-9f65-6e18b2f07835",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a7a6fbb5-9be8-4406-8b54-687df7a44785",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-29T21:02:53.5286674+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": "b294b83f-2388-41f1-82c7-5485457f1ae9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-29T21:02:53.5286674+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.