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": "6ef02b20-10b5-4dbb-85e0-8b3c4c3a6e9e",
"jobs_id": "9df41840-d0ab-4beb-9035-466ee3303ef0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cbf974a0-c3eb-446c-b971-4a922b8959fd",
"_parent_id": "97bdb1c3-dcf5-4525-98a0-1e509d8b253e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b5d807af-5ce3-401d-8ab8-8a71a51fcc93",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c40e24ab-77c7-40b9-b2a2-dad8e021bf85",
"_parent_id": "64cfcc2a-a0fc-40ef-84a2-c0b043e19f62",
"root_parent_id": "a0d47661-7d8a-4e19-81e0-f72d0ae7d746",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4a98b932-58a8-4cf3-bbcb-f4b532708b17",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c4fcd196-9a56-4841-a311-8af97b47e9a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ef798a3-4af8-40ac-aa52-d9b4dc375142",
"_parent_code": "sample string 6",
"sales_organization_id": "670c38df-caf6-4b5e-b22b-9393c937fa5b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
},
"equipment_model_id": "a8cb2f11-6868-4eaf-bfda-85738fc78cb7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3056f1eb-422f-4906-9f17-ded61019dc66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d6cfb4ab-e153-483f-a82c-4b6dc50f40a1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a6c20856-0ad7-41b2-9501-edc26d4d6a80",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0a1a7883-4b58-42f0-a08b-af2b8b91306d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
},
"equipment_family_id": "17119f67-72f8-4b3a-924d-e5d035760ed3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c4fcd196-9a56-4841-a311-8af97b47e9a6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ef798a3-4af8-40ac-aa52-d9b4dc375142",
"_parent_code": "sample string 6",
"sales_organization_id": "670c38df-caf6-4b5e-b22b-9393c937fa5b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
},
"date_in_production_since": "2026-02-21T02:06:33.9264857+00:00",
"date_out_of_production_since": "2026-02-21T02:06:33.9264857+00:00",
"date_end_support": "2026-02-21T02:06:33.9264857+00:00",
"sales_organization_id": "c28d69cc-baf5-4e97-897f-131832f576ef",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+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-02-21T02:06:33.9264857+00:00"
},
"project_status_id": "a2d4dcaf-665f-4141-b5af-0bfb4a2a39a5",
"project_status_code": "sample string 10",
"project_status": {
"id": "03deed20-5af5-433b-b9ec-fcb2b678e5d5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2b2ae97e-415f-4d36-882a-b18916c9eadc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
},
"company_id": "4d293bf4-1a2e-4eee-a134-03fa9f58469c",
"company_code": "sample string 12",
"db_address_id": "9241bc58-e3f0-4a7d-98a7-9cf91b62f3eb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "67cf465a-e410-46ad-a85a-396efb335f00",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e22b83b2-834f-468c-9635-6d958dc6c80f",
"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-02-21T02:06:33.9264857+00:00",
"date_create": "2026-02-21T02:06:33.9264857+00:00",
"date_update": "2026-02-21T02:06:33.9264857+00:00",
"updated_by_user_id": "60daf94c-6d49-4af6-809f-1e3f1842425c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-21T02:06:33.9264857+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-02-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-21T02:06:33.9264857+00:00",
"date_last_job": "2026-02-21T02:06:33.9264857+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-21T02:06:33.9264857+00:00",
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00",
"is_mobile_installation": true
},
"job_type_id": "2e4a0c72-8b3b-4bd6-83ae-c42c8355d9f8",
"job_type_code": "sample string 7",
"job_type": {
"id": "0198d1b3-3b80-4981-8d66-1fcd893c422d",
"name": "sample string 2",
"sales_organization_id": "2dccd2d9-a107-41fc-abb3-a8e9540cc381",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00",
"code": "sample string 7"
},
"job_priority_id": "a7705ede-5b08-4cb3-906f-25400e9a8df1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3e7693c0-12ce-47de-81f7-89ddb26eeb35",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0dc6f4f3-e179-425b-8cd8-f1ca1dbd407d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
},
"job_status_id": "308e308d-1db3-4286-bd53-f79c6a77cd2c",
"job_status_code": "sample string 11",
"db_address_id": "e333ec45-fdc0-4bd7-9d2d-303a89195ae6",
"contact_id": "35d03b5d-e981-4a89-9217-b94c3f3fa904",
"requested_by_company_id": "a4f63de9-a4c2-4775-97ef-fd30a139853f",
"requested_by_contact_id": "b4e0a2e3-95fa-4a05-bbfa-829d5054338e",
"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-02-21T02:06:33.9264857+00:00",
"due_date": "2026-02-21T02:06:33.9264857+00:00",
"date_create": "2026-02-21T02:06:33.9264857+00:00",
"date_update": "2026-02-21T02:06:33.9264857+00:00",
"date_closed": "2026-02-21T02:06:33.9264857+00:00",
"suggested_user_id": "aae17056-f9b4-48c8-b4d3-d6a4cb91a27b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e533c20a-a0d4-4e72-aa73-03289333ca3a",
"db_language_id": "02f632a2-ea0d-463a-977a-53359762160c",
"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-02-21T02:06:33.9264857+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4ddeb369-caca-4392-9bc0-ef977d85d05b",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "011568d9-8264-40ae-8f1f-e86ebf5aeb0c",
"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": "42ac6016-c094-44cc-88c4-3ec682b1bcdd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cff6912f-cf5a-42c3-a2fc-c5483a482b8a"
},
"suggested_date_start": "2026-02-21T02:06:33.9264857+00:00",
"skill_id": "d36fb8cb-b69c-4c44-a4b1-e06d2da0b04e",
"skill_code": "sample string 32",
"skill": {
"id": "d99916d8-941e-4270-b8f5-7bcdd729695a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c96afb8a-a0ac-462d-8db9-b1809626ebe1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ff0ea45-573a-4f07-851e-6f18abe923ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "659146e3-d506-4b2f-8e58-c112e539c9fc",
"db_currency_id": "ddac0d11-7fa6-4ce4-953f-0508a1ed831c",
"db_language_id": "7b974873-09bd-4b94-91e3-bb08ef64e0a3",
"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-02-21T02:06:33.9264857+00:00"
},
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "53a91cce-029c-4dc6-85b4-35bee5bfa56c",
"date_reported_by_company": "2026-02-21T02:06:33.9264857+00:00",
"id2": 36,
"company_id": "f6bfd388-0f42-4237-94c4-0b2d4eee5311",
"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": "08fc2ad5-3a7d-4f8f-badc-413d77858a4e",
"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-02-21T02:06:33.9264857+00:00"
},
"work_instruction_details_id": "62386b92-550a-4162-b4a9-99eb6da3ea10",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9750acd5-8d34-464c-b36b-3f6483004346",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4a60727f-40ab-440f-b9f1-84980a05d905",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-21T02:06:33.9264857+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": "dda039a9-c69e-4d43-ab3e-fa9ab3a6966b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-21T02:06:33.9264857+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.