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": "dbad0ccb-4e3e-4c0e-b341-8662fbfa81d2",
"jobs_id": "2c3dc7ee-f09a-4e5e-99b5-ee12fa5a5ed8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d9172495-113e-4317-999e-1df18eea865d",
"_parent_id": "5645004a-f84c-44c9-911b-87499a16d12c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c208dbd1-701a-479b-9e99-e8414414363d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1b861eba-0a54-4c00-951c-70ce7c56b427",
"_parent_id": "04850f41-e80f-43be-bc4e-293ec28e1699",
"root_parent_id": "8b02c85a-7c1d-4d05-a1c1-d7157fb43033",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8e96078c-64e6-4b14-874b-f472f44636ec",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2230fc43-15c8-4afc-8eb0-b20ba3701cb2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "958f2930-c1c4-4cb7-93fa-95eaa01642d4",
"_parent_code": "sample string 6",
"sales_organization_id": "2da0f542-5ff8-4569-bd42-cc2e921b0149",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00"
},
"equipment_model_id": "a1afd34d-0225-4c7b-8c75-3bf9a59fe64e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d57917a2-faa7-4117-911c-f065a85e03e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9cb61c66-b2f2-41f5-96f7-fb3e76ada83c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d26b6238-3adb-4e6a-97eb-5f8df0a12100",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3ebff2b5-7731-4ff0-a8f4-31eaef2d4ef7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00"
},
"equipment_family_id": "04932967-cb6f-4771-86a7-830ea70dd5e4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2230fc43-15c8-4afc-8eb0-b20ba3701cb2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "958f2930-c1c4-4cb7-93fa-95eaa01642d4",
"_parent_code": "sample string 6",
"sales_organization_id": "2da0f542-5ff8-4569-bd42-cc2e921b0149",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00"
},
"date_in_production_since": "2026-04-24T00:52:42.1041332+00:00",
"date_out_of_production_since": "2026-04-24T00:52:42.1041332+00:00",
"date_end_support": "2026-04-24T00:52:42.1041332+00:00",
"sales_organization_id": "3d1955e5-d059-424d-8343-c9a432c8c9cc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+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-24T00:52:42.1041332+00:00"
},
"project_status_id": "bfff4f5b-eaf3-401d-9b9e-6540b0cca3cb",
"project_status_code": "sample string 10",
"project_status": {
"id": "d5131098-657e-47fe-a5d3-30b4a41372fd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "447f7faf-b136-47cc-b9d9-751b28d40234",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00"
},
"company_id": "be1a8ec1-8e6f-4749-aca4-c4b359042e2f",
"company_code": "sample string 12",
"db_address_id": "112b0515-5a46-494d-90f7-38a7a388fafa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3b89d03a-536c-4c51-bd68-b65b55f2c27c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d9697263-2ae0-465b-93c7-549697db9880",
"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-24T00:52:42.1041332+00:00",
"date_create": "2026-04-24T00:52:42.1041332+00:00",
"date_update": "2026-04-24T00:52:42.1041332+00:00",
"updated_by_user_id": "f752dbbe-ba93-4bdd-8bd5-51a97693d258",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T00:52:42.1041332+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-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T00:52:42.1041332+00:00",
"date_last_job": "2026-04-24T00:52:42.1041332+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T00:52:42.1041332+00:00",
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00",
"is_mobile_installation": true
},
"job_type_id": "a8f8670a-a4c7-4d0e-b379-a49349c2ea13",
"job_type_code": "sample string 7",
"job_type": {
"id": "8fe99ced-f1d4-4ee9-9040-a4fb46895403",
"name": "sample string 2",
"sales_organization_id": "c253717b-281a-4697-8229-fed4454375d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00",
"code": "sample string 7"
},
"job_priority_id": "9a271c0c-6e82-48a0-97e0-a7ff2104ce4f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "04da5d27-6b21-4774-b5b4-6322631448d1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d9e2229-02f8-41d6-bd70-d0b036c73ec7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T00:52:42.1041332+00:00"
},
"job_status_id": "e58763c6-7725-4c4a-b9bd-50a041f29bcd",
"job_status_code": "sample string 11",
"db_address_id": "bbe4db68-f6ed-4a15-a74f-e063d1de3a87",
"contact_id": "c5cae4a8-284e-4ff9-b647-dd60e45ba285",
"requested_by_company_id": "c45cce83-4018-4148-99d2-b555f8bdc865",
"requested_by_contact_id": "d25df6bd-cca2-46b7-8ebf-7da50b0d4a27",
"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-24T00:52:42.1197389+00:00",
"due_date": "2026-04-24T00:52:42.1197389+00:00",
"date_create": "2026-04-24T00:52:42.1197389+00:00",
"date_update": "2026-04-24T00:52:42.1197389+00:00",
"date_closed": "2026-04-24T00:52:42.1197389+00:00",
"suggested_user_id": "5fdde961-803d-43c0-ac6c-4b61140371c5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6caf1437-b55a-4f26-b136-5caf2bf5cec4",
"db_language_id": "0f92992a-213a-4e1d-90b9-de73286c77fa",
"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-24T00:52:42.1197389+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a18c82af-bb57-46d3-9856-18bd792e70f4",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ed555bf9-d0a6-4146-a477-7c5fbe0d3ef5",
"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": "ea8ae0e1-cc92-4fe3-b341-73137485b65b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T00:52:42.1197389+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e7bbfee6-cea7-4928-8ce6-80a0dcd77431"
},
"suggested_date_start": "2026-04-24T00:52:42.1197389+00:00",
"skill_id": "1659333f-7970-443e-9760-a3f8561d2c21",
"skill_code": "sample string 32",
"skill": {
"id": "db13326c-7ddf-4a9f-bdca-2d2cfe480764",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8daa6a69-f61d-4247-b4e0-ca1ecee2b5c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cbb97f30-43fd-451b-abd6-66b761eadf08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e67b94ce-6da3-4a65-829a-b9f4613256c3",
"db_currency_id": "08486ef6-b383-4e07-a4e0-efa02adf042e",
"db_language_id": "2afadc7c-4137-45e7-a0a7-8d4d64619821",
"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-24T00:52:42.1041332+00:00"
},
"modified_dateutc": "2026-04-24T00:52:42.1197389+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cff073b5-867e-4766-a9de-77dedeffd7f8",
"date_reported_by_company": "2026-04-24T00:52:42.1197389+00:00",
"id2": 36,
"company_id": "f6d7c8a7-3043-49ae-b155-94864d8f986c",
"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": "e7fb1e32-6db2-46d1-8916-32c57e26e88c",
"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-24T00:52:42.1197389+00:00"
},
"work_instruction_details_id": "aeda0877-e17c-4399-94e6-7a4ab53b2283",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b25c20a5-76d8-4699-b43c-3d98ddda7bfa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d77c3bc5-18c4-4aa2-902a-7a71cb966028",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T00:52:42.1197389+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": "6d00a6c9-8b26-430a-8947-2f0f6f1939ef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T00:52:42.1197389+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.