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": "88ce77f5-2344-4237-9c3a-7f84d4280ed9",
"jobs_id": "448c2b3c-1d03-4423-9758-1a7e62164f7a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3775669d-4990-42b6-899f-27e6299046dd",
"_parent_id": "fe5fc2db-d961-4b9c-86dd-9434da0e477d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2c9da98-b0bc-4a8d-bdec-ff935650e07e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a260c582-3691-44d5-bf99-d6e11c689765",
"_parent_id": "7fc42834-6497-40ef-bc69-9a9e139012be",
"root_parent_id": "46036b5c-9fd3-4db6-8eb2-71237a92f395",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1ef91825-6961-42e3-aaee-2504132b75f2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2a098ff1-b6e5-471e-897e-0baae29c0df9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf5091dd-8d6b-45c3-8adf-eb1aa0bc8221",
"_parent_code": "sample string 6",
"sales_organization_id": "daa5e16a-c566-48d0-a657-06b74fc57070",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"modified_dateutc": "2026-01-03T06:31:15.825+00:00"
},
"equipment_model_id": "7b9c75e7-5ccb-4d26-85a0-8f1b354cbd76",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c236f6c7-e0cf-4575-8d17-6793a4bbdebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1fa4382d-9fd9-47a3-8e8e-dd21fa53afaf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2f0878c4-867b-4ec7-acb3-f2a34d22d044",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "644f8b8d-ecdb-448b-89f5-97e2af5ae8ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"modified_dateutc": "2026-01-03T06:31:15.825+00:00"
},
"equipment_family_id": "ceadef53-41fc-4c73-b5c2-f8a56de44069",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2a098ff1-b6e5-471e-897e-0baae29c0df9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf5091dd-8d6b-45c3-8adf-eb1aa0bc8221",
"_parent_code": "sample string 6",
"sales_organization_id": "daa5e16a-c566-48d0-a657-06b74fc57070",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"modified_dateutc": "2026-01-03T06:31:15.825+00:00"
},
"date_in_production_since": "2026-01-03T06:31:15.825+00:00",
"date_out_of_production_since": "2026-01-03T06:31:15.825+00:00",
"date_end_support": "2026-01-03T06:31:15.825+00:00",
"sales_organization_id": "152f9ee9-30a6-4eca-b613-2b618a4dcadc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+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-01-03T06:31:15.825+00:00"
},
"project_status_id": "05b5320e-bd56-43a7-b96c-48c1caf4057a",
"project_status_code": "sample string 10",
"project_status": {
"id": "65b8277a-03a9-459b-991a-de54406ebb63",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8817c342-9f50-4c75-a4c1-41bc87770c37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-03T06:31:15.825+00:00"
},
"company_id": "16648dbf-1955-4bf3-8038-d9dfa4e09b28",
"company_code": "sample string 12",
"db_address_id": "16f12368-7990-4197-97b1-f780f3dadb01",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1889cc2e-b75b-4d48-a215-fae095eea053",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "951546e0-91cb-430f-b6b1-c6e150974822",
"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-01-03T06:31:15.825+00:00",
"date_create": "2026-01-03T06:31:15.825+00:00",
"date_update": "2026-01-03T06:31:15.825+00:00",
"updated_by_user_id": "9b37da66-6077-4760-a4b0-29811e9be338",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-03T06:31:15.825+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-01-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-03T06:31:15.825+00:00",
"date_last_job": "2026-01-03T06:31:15.825+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-03T06:31:15.825+00:00",
"modified_dateutc": "2026-01-03T06:31:15.825+00:00",
"is_mobile_installation": true
},
"job_type_id": "7c55f4a5-1dc3-4ce8-9469-e289a3bd985e",
"job_type_code": "sample string 7",
"job_type": {
"id": "2482d40d-47b4-4158-b6a2-e30ce672249a",
"name": "sample string 2",
"sales_organization_id": "e03362d8-195b-4d70-a650-cd0c64f2aefc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-03T06:31:15.825+00:00",
"code": "sample string 7"
},
"job_priority_id": "78aac704-9fe1-4d08-86b7-0e81ec469f4f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "59ad6edc-c65e-4d13-a67f-d85ddc4a338a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "41e164f7-732a-489e-9311-18e0c5c7cb94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-03T06:31:15.825+00:00"
},
"job_status_id": "ebede516-837e-47e0-adc5-e1111a57a094",
"job_status_code": "sample string 11",
"db_address_id": "a65c8ff7-ceb2-4b8e-9631-e314e628a4b1",
"contact_id": "549fe385-a25c-4752-a239-047396ccdb8a",
"requested_by_company_id": "71cd8620-05b2-403c-8d1e-5f25e4231e77",
"requested_by_contact_id": "f2f2c35d-0007-4877-9269-f44239f52cad",
"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-01-03T06:31:15.825+00:00",
"due_date": "2026-01-03T06:31:15.825+00:00",
"date_create": "2026-01-03T06:31:15.825+00:00",
"date_update": "2026-01-03T06:31:15.825+00:00",
"date_closed": "2026-01-03T06:31:15.825+00:00",
"suggested_user_id": "8caf9db8-10f9-4d54-8765-cb8b4cee2588",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "099345b3-28a3-4449-9a45-45882a68aac8",
"db_language_id": "103400fa-d9ed-4f05-99f8-ab2664fbf535",
"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-01-03T06:31:15.8406279+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fe235589-53a5-44c6-b9b7-355f2738bb14",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "961d21a4-1767-4f3a-a344-55f63b9f9c5f",
"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": "5071999a-181a-448e-afbe-ee9e5a1f765e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-03T06:31:15.8406279+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "47698652-07de-456d-b57d-2225eab53fa1"
},
"suggested_date_start": "2026-01-03T06:31:15.8406279+00:00",
"skill_id": "deed2ada-b2b0-495e-8182-8f34797560de",
"skill_code": "sample string 32",
"skill": {
"id": "43b5c7c6-da68-4844-ad63-6cf37d211581",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1eb5e3d4-6a6d-41e3-b8b2-187fbdccfe58",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eed3170a-1a43-4530-986d-a4b8a77a1994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aacd7b8-b9d0-4bfc-b688-b65e2915a5fb",
"db_currency_id": "e3ced466-5dfc-4c00-b109-cd83c7688513",
"db_language_id": "00133d9d-2fd9-4c09-9034-9f675edca200",
"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-01-03T06:31:15.825+00:00"
},
"modified_dateutc": "2026-01-03T06:31:15.8406279+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d7911a13-f220-45ad-9fde-bd2991f17250",
"date_reported_by_company": "2026-01-03T06:31:15.8406279+00:00",
"id2": 36,
"company_id": "ee03ee6b-3c46-4ecb-9484-c3b3d1911814",
"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": "cefbee0f-4a21-421a-b5d3-c65c5cedb8c1",
"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-01-03T06:31:15.8406279+00:00"
},
"work_instruction_details_id": "5f919542-720e-4841-93d5-42229709780d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a1d4a04d-0c3c-4081-9aed-57615b01d1d6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ad88a8b5-48f5-4c3d-8e66-6211c2fb1018",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-03T06:31:15.8406279+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": "2d93ad1d-403b-436d-8d6c-91a38c47fd5d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-03T06:31:15.8406279+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.