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": "ac33c8eb-783e-4ada-8c8e-1808ac7d9392",
"jobs_id": "b4aaa3f7-1d41-456d-90ea-2a46939e28af",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7127781f-bbb6-49ed-a0fb-26f235ce2441",
"_parent_id": "7c245c04-8b27-463d-b1fa-14b929638e40",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d6ec6f78-4ecc-4096-a319-25e3a3cabe60",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7c71b1e5-3f7f-4b85-9bbc-f33e692547d3",
"_parent_id": "77401b19-b6ef-4580-989e-f20ffbdba89e",
"root_parent_id": "0833234f-a0e7-4091-8d46-aeb5d3100169",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0efbb4a5-fe48-4d07-9a2f-eb5187cbfae7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "96027b28-b82d-45df-be50-7851a7aa4671",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2f88187b-015d-4a31-b7d0-454e69828224",
"_parent_code": "sample string 6",
"sales_organization_id": "a2bda03b-14e9-476a-bc70-70277e1650de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
},
"equipment_model_id": "05bb664c-4783-4d71-a5ad-987ad20cee76",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5cbf2257-86d8-4c80-bc84-3032a1ca1409",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "923100b7-e754-4fc4-93b8-84b42e6391c5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "83ae2820-2bd0-4473-a4c2-1f3a8308fdfa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "20ae5f28-5da7-4850-8f8f-a99b11d4b6c1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
},
"equipment_family_id": "eb25fd40-7e49-4d3d-9d2e-630b61562352",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "96027b28-b82d-45df-be50-7851a7aa4671",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2f88187b-015d-4a31-b7d0-454e69828224",
"_parent_code": "sample string 6",
"sales_organization_id": "a2bda03b-14e9-476a-bc70-70277e1650de",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
},
"date_in_production_since": "2026-10-03T07:01:30.6900756+00:00",
"date_out_of_production_since": "2026-10-03T07:01:30.6900756+00:00",
"date_end_support": "2026-10-03T07:01:30.6900756+00:00",
"sales_organization_id": "582d9ea3-0f9a-46a9-bf06-0cc35e6210fa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+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-03T07:01:30.6900756+00:00"
},
"project_status_id": "32b4617a-462a-481b-8513-29fe04d39e22",
"project_status_code": "sample string 10",
"project_status": {
"id": "7484f5b2-5784-4d49-9f2d-e12995a2be84",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d8c49775-bc9b-4df7-932e-c6e6e639a96c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
},
"company_id": "b2d8ddb0-8b62-4302-9dda-41a30656b724",
"company_code": "sample string 12",
"db_address_id": "07bd514a-8694-434d-afcb-fb0f1a47a004",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1e2fb16f-2c0f-4530-af77-1617fff5a454",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5358e7b4-2927-426b-bef2-c5a4b82b122e",
"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-03T07:01:30.6900756+00:00",
"date_create": "2026-10-03T07:01:30.6900756+00:00",
"date_update": "2026-10-03T07:01:30.6900756+00:00",
"updated_by_user_id": "2ebf0645-9290-413e-a470-89ce47c8195f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-03T07:01:30.6900756+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-03T07:01:30.6900756+00:00",
"date_last_job": "2026-10-03T07:01:30.6900756+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-03T07:01:30.6900756+00:00",
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00",
"is_mobile_installation": true
},
"job_type_id": "a442d170-7eae-44c3-9047-5ce4327d1d46",
"job_type_code": "sample string 7",
"job_type": {
"id": "67bcfa43-21bf-42f5-abea-6dd34a601224",
"name": "sample string 2",
"sales_organization_id": "159e4056-1a99-4c0b-8fec-8871ebfb02bd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00",
"code": "sample string 7"
},
"job_priority_id": "c26b72b5-1a8c-4bb9-81a3-6e5238f98634",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5aa968fe-e46f-40c2-9205-83fdfda00fcc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a91d6f3e-bfed-4e5f-98ed-3399e1eaf988",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
},
"job_status_id": "ef95f476-4302-4ec0-8aa0-a8f9a9be4f08",
"job_status_code": "sample string 11",
"db_address_id": "a76f3459-1531-40f5-8dad-1c41db866643",
"contact_id": "ba9d8be7-ac5a-4ef2-a280-62a63631d3a0",
"requested_by_company_id": "d4600e69-69cd-48f2-b376-be31dfe5de40",
"requested_by_contact_id": "31855e04-5b27-4a0c-923c-48619b5861a6",
"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-03T07:01:30.6900756+00:00",
"due_date": "2026-10-03T07:01:30.6900756+00:00",
"date_create": "2026-10-03T07:01:30.6900756+00:00",
"date_update": "2026-10-03T07:01:30.6900756+00:00",
"date_closed": "2026-10-03T07:01:30.6900756+00:00",
"suggested_user_id": "aa919874-34c8-4c76-a1fd-7420c220455c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ad728114-6f55-4621-bab0-189d19e420b2",
"db_language_id": "425d8a1b-6912-49cc-999d-4f4a7f7755ec",
"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-03T07:01:30.6900756+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e65bf69c-564d-45c9-9f56-cde38e907b82",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c8832449-3d44-4d28-92fb-7e4cd4947e58",
"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": "f4814cdd-4934-4055-abc2-273688232723",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e1bcfb1b-7eff-4c5f-9cad-27f423bf08af"
},
"suggested_date_start": "2026-10-03T07:01:30.6900756+00:00",
"skill_id": "b084e044-ed3e-4da3-84b5-a04fc289ee99",
"skill_code": "sample string 32",
"skill": {
"id": "cf5731df-e5ea-429a-b2d0-bf35752b9fab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "84993f78-0483-43d5-8b63-1708403466ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e3d0675-b448-4cfd-88fd-fe538385b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "096cf9e4-b8ea-4d76-95e3-c3d8c26bff24",
"db_currency_id": "74d89ebb-d4d9-4f0e-ab0f-fbc6d9be19d1",
"db_language_id": "805b2ab1-d09e-4ba8-9465-8e8fe5893191",
"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-03T07:01:30.6900756+00:00"
},
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d3c8a4a1-1b26-46ad-9d70-f02f8eceec00",
"date_reported_by_company": "2026-10-03T07:01:30.6900756+00:00",
"id2": 36,
"company_id": "1a5674fc-466a-43dd-aaa7-55ce427d4f9a",
"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": "db3b84bf-16f0-4347-b782-6454be2c4426",
"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-03T07:01:30.6900756+00:00"
},
"work_instruction_details_id": "24f7cf46-0475-4bc0-a0e6-b57bf0a4842d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1b3dd768-cbcf-4e36-8af8-3e00e7a63a82",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "163e5d58-db6a-488c-bbbb-9abdfe301d11",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-03T07:01:30.6900756+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": "1f635a3f-ccd2-4093-b7f8-2e5c76e04b4b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-03T07:01:30.6900756+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.