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": "81adc8c2-66ad-400f-af07-1ba216cda812",
"jobs_id": "7ef1cd4f-15ee-46d3-bb75-c25b1553059b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5973b305-70e7-41e6-9e0b-ef788f45fbd3",
"_parent_id": "3f0242fd-c354-485f-89a8-bce1bfb39f20",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1e186768-7e16-412e-82b2-d26c7f50fb94",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2a3e0022-fa06-429d-9d4f-8f98bec77a19",
"_parent_id": "b4685b5f-3678-43b3-8cb1-d49c4232e988",
"root_parent_id": "1ae5fcde-d50e-416f-b8f8-d11a1f0acb0d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0cf93117-47ce-444b-b1e1-f7078dd0d897",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c98bb6cc-0620-49eb-ad50-5ea0720b0bac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b2fcc23-3d17-41a7-9c18-ac48921c234f",
"_parent_code": "sample string 6",
"sales_organization_id": "4968401b-8aef-4965-be7f-33f2bbbddfde",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"modified_dateutc": "2025-11-12T11:33:43.7769161+00:00"
},
"equipment_model_id": "771e9d90-c22f-4157-abc9-09ccaea632cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d3b8df0d-c36c-4db9-9b2b-7c6977d1fe23",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d2e60593-9eb6-4c49-b027-573cbc083522",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "03e4484b-b349-4bf8-928a-57cb31c1670f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "faf9ffec-68cc-4308-aa4b-16f507eff921",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"modified_dateutc": "2025-11-12T11:33:43.7769161+00:00"
},
"equipment_family_id": "6a87f83a-e289-4c98-9c29-ae84d73dbebe",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c98bb6cc-0620-49eb-ad50-5ea0720b0bac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0b2fcc23-3d17-41a7-9c18-ac48921c234f",
"_parent_code": "sample string 6",
"sales_organization_id": "4968401b-8aef-4965-be7f-33f2bbbddfde",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"modified_dateutc": "2025-11-12T11:33:43.7769161+00:00"
},
"date_in_production_since": "2025-11-12T11:33:43.7769161+00:00",
"date_out_of_production_since": "2025-11-12T11:33:43.7769161+00:00",
"date_end_support": "2025-11-12T11:33:43.7769161+00:00",
"sales_organization_id": "e5f4d219-4792-4c99-aa75-960a15a87af7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+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": "2025-11-12T11:33:43.7769161+00:00"
},
"project_status_id": "eaa125cc-6d6c-42fb-ade8-b194d0d0a561",
"project_status_code": "sample string 10",
"project_status": {
"id": "6b2f30b7-3961-4ac4-8ffe-6914e82896de",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "129a877e-b130-45ac-8284-2c2965e96446",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T11:33:43.7769161+00:00"
},
"company_id": "39942b64-269d-4dcb-bda8-ee4a20849198",
"company_code": "sample string 12",
"db_address_id": "34ac6c3e-da8c-45f9-bc84-109a89ee88e4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "383b6cdf-b129-446a-9bf6-c8d52632176a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d0b37f76-2214-40b9-b1ab-e23234868cb4",
"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": "2025-11-12T11:33:43.7769161+00:00",
"date_create": "2025-11-12T11:33:43.7769161+00:00",
"date_update": "2025-11-12T11:33:43.7769161+00:00",
"updated_by_user_id": "cc17ddd0-bbc0-4235-b290-67fc43531063",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-12T11:33:43.7769161+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": "2025-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-12T11:33:43.7925498+00:00",
"date_last_job": "2025-11-12T11:33:43.7925498+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-12T11:33:43.7925498+00:00",
"modified_dateutc": "2025-11-12T11:33:43.7925498+00:00",
"is_mobile_installation": true
},
"job_type_id": "5072a729-cb47-4e1d-9196-e3e48c72d8fe",
"job_type_code": "sample string 7",
"job_type": {
"id": "ef64fd83-317f-4814-85ba-e964730828cf",
"name": "sample string 2",
"sales_organization_id": "061d287e-c3cd-4771-9fb0-747f3b5febd4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-12T11:33:43.7925498+00:00",
"code": "sample string 7"
},
"job_priority_id": "9d718176-2378-48a8-843b-a8dc14f2cca4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7f0be61e-8305-488a-8002-2113f4758c68",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0dbec05e-0fa1-4695-b3ef-8f16541a8337",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T11:33:43.7925498+00:00"
},
"job_status_id": "0e95f750-9c39-4f16-a5a2-dae1131d8be9",
"job_status_code": "sample string 11",
"db_address_id": "c85f8926-36f3-4d14-851f-d1c55de2c49d",
"contact_id": "f9534142-f618-465d-a0e1-3ca2be5f7877",
"requested_by_company_id": "83233bb5-17ae-4b38-a28f-dec32ceefb3a",
"requested_by_contact_id": "91fb4611-789d-4805-95ad-867068aa6d0d",
"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": "2025-11-12T11:33:43.7925498+00:00",
"due_date": "2025-11-12T11:33:43.7925498+00:00",
"date_create": "2025-11-12T11:33:43.7925498+00:00",
"date_update": "2025-11-12T11:33:43.7925498+00:00",
"date_closed": "2025-11-12T11:33:43.7925498+00:00",
"suggested_user_id": "16ebad37-8e54-40b8-ab3f-b84753bbc553",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4b17ab36-cd67-4711-b1d2-b7780ada2eaf",
"db_language_id": "9a051943-5d4d-4e2e-8bcd-0a63d8455b58",
"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": "2025-11-12T11:33:43.7925498+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6cf33456-e98a-4072-b7dc-16887995d69a",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2f9d3853-67cf-4611-988c-cece427c5c62",
"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": "74aa8b21-80b7-4e34-80ea-3eb05fd605a2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-12T11:33:43.7925498+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a8d55446-8500-4c70-aa8c-1e7a8d15c2b2"
},
"suggested_date_start": "2025-11-12T11:33:43.7925498+00:00",
"skill_id": "2e7e7484-201d-42b9-a2a3-638f1e95993a",
"skill_code": "sample string 32",
"skill": {
"id": "8069625c-17a9-4a71-ab0d-b284a22f1a39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "65e5ad39-a51f-40e4-91fd-6f5bb30aaf96",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2947160f-6896-4df9-9b18-e075fdb12cc9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7774ad3-ff98-449e-b629-266c68c5840e",
"db_currency_id": "d4d3718d-d647-4931-bbbe-5d849538197c",
"db_language_id": "b15ce548-761e-4c8c-b8b0-3a33449fee5f",
"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": "2025-11-12T11:33:43.7769161+00:00"
},
"modified_dateutc": "2025-11-12T11:33:43.7925498+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c976d27b-63d6-4351-9cc1-024aef99309d",
"date_reported_by_company": "2025-11-12T11:33:43.7925498+00:00",
"id2": 36,
"company_id": "e7763a7b-acf5-42a9-a806-981855ef4d66",
"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": "041a41b4-890b-46f9-8697-d3c3061dbbc6",
"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": "2025-11-12T11:33:43.7925498+00:00"
},
"work_instruction_details_id": "baa5c58e-4579-4357-b25d-191eb56af593",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "48580409-66f5-42e9-8570-de900f33c43c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aad81101-5055-4981-990b-38e529c6151e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-12T11:33:43.7925498+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": "2b266edd-1260-4f66-bff0-8a691fed148e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-12T11:33:43.7925498+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.