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": "9e871578-b42a-49e3-889e-3055cffd9233",
"jobs_id": "3340ccdb-ca4f-4e62-bf5c-92ee69645057",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c2df0728-9b6f-4705-a986-24a40b9df88e",
"_parent_id": "ce22588a-bfc2-4a6f-950a-a4c5cbafc146",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4ffe8849-faf0-43b1-a1c9-d1c7c17e68b0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "03e6df1d-9811-43a7-acc7-8a24809d1774",
"_parent_id": "9c7b8604-fa6d-42bb-919a-05df6542a1ff",
"root_parent_id": "d95afe5b-26e0-4a0f-9b93-7ee24743a901",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c3b5d754-8691-410e-b9f3-38a1d117f92a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cccf92e9-b027-48a9-8ee2-eb7aa194c0b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ef3748a0-eea3-4ed4-98fe-fa5ed9581119",
"_parent_code": "sample string 6",
"sales_organization_id": "aa12e1d9-0052-483c-bf97-06a12f6a3f42",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"modified_dateutc": "2026-10-09T10:12:57.8845762+00:00"
},
"equipment_model_id": "000413d1-7f5a-4ceb-9fb2-fb83871fb3fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "86227d28-6173-4183-ba99-8e41df2a71b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "227dd82f-bda9-49d2-a80b-756a6ca67744",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dd57343d-897f-4489-9cb4-96f7fa26a480",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "56af80a6-28e1-4025-8b9e-518843cbdd78",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"modified_dateutc": "2026-10-09T10:12:57.8845762+00:00"
},
"equipment_family_id": "59a33af7-355c-4d66-ba5c-9a9b94ac117e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cccf92e9-b027-48a9-8ee2-eb7aa194c0b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ef3748a0-eea3-4ed4-98fe-fa5ed9581119",
"_parent_code": "sample string 6",
"sales_organization_id": "aa12e1d9-0052-483c-bf97-06a12f6a3f42",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"modified_dateutc": "2026-10-09T10:12:57.8845762+00:00"
},
"date_in_production_since": "2026-10-09T10:12:57.8845762+00:00",
"date_out_of_production_since": "2026-10-09T10:12:57.8845762+00:00",
"date_end_support": "2026-10-09T10:12:57.8845762+00:00",
"sales_organization_id": "d4479041-04ff-49d8-ad7a-e816084e40fb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+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-10-09T10:12:57.8967516+00:00"
},
"project_status_id": "ef19715f-6acc-447a-a96c-cc9d5e0f1409",
"project_status_code": "sample string 10",
"project_status": {
"id": "2b8a83cb-6307-48fd-80d1-e0dd34d254b9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1db5e3a6-b10f-4aae-b5f3-c16d3646ecff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T10:12:57.8967516+00:00"
},
"company_id": "15ca7045-f2c0-4d1e-8c4e-2bcd70115a6c",
"company_code": "sample string 12",
"db_address_id": "b0981dd6-7475-4687-81cb-4085f74b95c3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "39c9e151-a4b0-46e5-9e1b-f1baea33124c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5b4a2500-3a28-45cb-a1be-b8a48b9112b8",
"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-10-09T10:12:57.8967516+00:00",
"date_create": "2026-10-09T10:12:57.8967516+00:00",
"date_update": "2026-10-09T10:12:57.8967516+00:00",
"updated_by_user_id": "aa5de8ed-c3dc-42a9-8b1e-26826263fb02",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-09T10:12:57.8967516+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-10-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-09T10:12:57.8967516+00:00",
"date_last_job": "2026-10-09T10:12:57.8967516+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-09T10:12:57.8967516+00:00",
"modified_dateutc": "2026-10-09T10:12:57.8967516+00:00",
"is_mobile_installation": true
},
"job_type_id": "9d8499f5-7326-4a7b-bcae-42ff81633863",
"job_type_code": "sample string 7",
"job_type": {
"id": "7bb696a3-bd00-4396-80b0-95d9dffe94cc",
"name": "sample string 2",
"sales_organization_id": "b47ecd7f-bd33-4a38-9488-c35c12557fa8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-09T10:12:57.8967516+00:00",
"code": "sample string 7"
},
"job_priority_id": "8897fb30-14c9-46c0-ba92-20a52cb2190e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e3f71bb7-f0ab-4651-a540-baed1a3e0bb4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cd85b3d4-aa98-4275-9f36-0aaec9666646",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-09T10:12:57.8967516+00:00"
},
"job_status_id": "54d30df2-4772-4c86-9b1f-a7ad19fdfd47",
"job_status_code": "sample string 11",
"db_address_id": "5677c21a-683b-4dab-8b0d-e9df1e068cb2",
"contact_id": "95ab1a32-f46e-4b4a-9d54-016705cd928b",
"requested_by_company_id": "3d05e932-6b4c-4d02-a1c8-fac40f5e81e5",
"requested_by_contact_id": "9f62a83f-76c9-4389-a19c-5d32f1367aea",
"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-10-09T10:12:57.9147005+00:00",
"due_date": "2026-10-09T10:12:57.9147005+00:00",
"date_create": "2026-10-09T10:12:57.9147005+00:00",
"date_update": "2026-10-09T10:12:57.9147005+00:00",
"date_closed": "2026-10-09T10:12:57.9147005+00:00",
"suggested_user_id": "51b4d603-afc8-4978-b936-128866d0d275",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eb2ee113-c9ed-45f8-a2ef-d6040127fac3",
"db_language_id": "b464fe86-fb66-4812-bc55-fa24be752237",
"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-10-09T10:12:57.9147005+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f72ff1e7-b374-42ca-afb9-350431b985ab",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "387ffd8e-2c4a-4055-9e35-77f57df0ec85",
"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": "808ca09d-778e-4c3c-955d-7510edd2dff3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-09T10:12:57.9147005+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a9724f7-40ce-4379-ac26-6843089f49f6"
},
"suggested_date_start": "2026-10-09T10:12:57.9147005+00:00",
"skill_id": "1aa8d78c-6002-44b2-a321-98571cdbf5fd",
"skill_code": "sample string 32",
"skill": {
"id": "f992ccd2-b0f9-45ef-9a76-2be0f81df0bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ea3911e9-87e5-4f81-b9c8-9feffbffa5e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f711307f-4216-40f9-9dd1-391f9bdec60e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69a219a5-3824-43b3-b856-7c6ad9950265",
"db_currency_id": "4555eeca-4740-4e0b-9266-8d3619e78289",
"db_language_id": "57d028ca-89c8-4d9a-99aa-27965c04d4b4",
"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-10-09T10:12:57.8845762+00:00"
},
"modified_dateutc": "2026-10-09T10:12:57.9147005+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5bdbdfbb-dbe7-4f1d-997f-4d1f4d5ae46a",
"date_reported_by_company": "2026-10-09T10:12:57.9147005+00:00",
"id2": 36,
"company_id": "68a4925f-5d50-45bc-adf9-cb52ddfc57a1",
"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": "3e004c8c-712d-4b42-9aec-9645bd05ef38",
"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-10-09T10:12:57.9147005+00:00"
},
"work_instruction_details_id": "e0a71ca9-83e7-4a75-8cd5-ef2022c80f7f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "74d7d367-e2d5-41f7-bae6-58332c89f855",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ded546ef-b630-430c-9da6-7ae511d131bf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-09T10:12:57.9147005+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": "99fe2053-b79a-48f4-9153-8a82b8ea4bb8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-09T10:12:57.9147005+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.