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": "93334e89-dba1-4cc8-8749-2ae74bb4977a",
"jobs_id": "86f5fef1-2507-4d67-9c3d-eaeb5034450f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b16b4877-c6c5-4ffa-9035-c9bfe207514b",
"_parent_id": "17e5e970-e0ac-4b82-91d7-78ea8ac7f033",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "404772c0-a1db-4035-baaa-eeea61befc8a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77890c7e-cb71-4c01-a313-fd9a7d07cf61",
"_parent_id": "684a8c74-5663-404c-949c-13fdf0a9cebb",
"root_parent_id": "b0d845c6-d3e2-43b4-a5f5-94d9a51429f7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6ae0168d-b393-407d-9a4e-1d6f474a0215",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b5b66081-d73b-4239-88d1-84d27de1ae30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1de19578-7538-445c-a0d7-fd77a22f918a",
"_parent_code": "sample string 6",
"sales_organization_id": "2efb86f4-3772-40ca-83e5-c26968901f09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"modified_dateutc": "2026-10-28T12:58:35.6004291+00:00"
},
"equipment_model_id": "7f7d60d1-a74f-4f1d-b907-76fa61467bbc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "83c872e1-d388-417d-8978-0819aee7e9e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "db654a6e-e427-4304-a970-b28e0163d0a3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1501cefb-67fd-4859-a12d-70e98d0fc9bd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ea6c680a-229b-42ed-9bdf-00fd296ce56c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"modified_dateutc": "2026-10-28T12:58:35.6004291+00:00"
},
"equipment_family_id": "1163ea37-35e0-4c2c-8ca3-6b12377bce1b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b5b66081-d73b-4239-88d1-84d27de1ae30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1de19578-7538-445c-a0d7-fd77a22f918a",
"_parent_code": "sample string 6",
"sales_organization_id": "2efb86f4-3772-40ca-83e5-c26968901f09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"modified_dateutc": "2026-10-28T12:58:35.6004291+00:00"
},
"date_in_production_since": "2026-10-28T12:58:35.6160961+00:00",
"date_out_of_production_since": "2026-10-28T12:58:35.6160961+00:00",
"date_end_support": "2026-10-28T12:58:35.6160961+00:00",
"sales_organization_id": "da03db2b-2896-47e1-91ec-9d2d41413411",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+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-28T12:58:35.6160961+00:00"
},
"project_status_id": "63c7f3df-13c1-48e2-85d4-6e1caf9a599f",
"project_status_code": "sample string 10",
"project_status": {
"id": "21368599-7622-40f4-82d2-316d8058b9d5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "614d9753-0a12-4b50-a158-bee5d34783ca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-28T12:58:35.6160961+00:00"
},
"company_id": "977cc9a7-5fa7-4f27-ab5e-6194436a05fd",
"company_code": "sample string 12",
"db_address_id": "0c7e1cc9-2143-4bcf-86e0-aaebed3039df",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4c220be0-4fba-48a6-936b-858a51b4b057",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6ea406b5-8463-4037-9261-737ee619b3ca",
"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-28T12:58:35.6160961+00:00",
"date_create": "2026-10-28T12:58:35.6160961+00:00",
"date_update": "2026-10-28T12:58:35.6160961+00:00",
"updated_by_user_id": "a7ee69ce-7cc4-4be1-92b8-6145b69e0e03",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-28T12:58:35.6160961+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-28T12:58:35.6160961+00:00",
"date_last_job": "2026-10-28T12:58:35.6160961+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-28T12:58:35.6160961+00:00",
"modified_dateutc": "2026-10-28T12:58:35.6160961+00:00",
"is_mobile_installation": true
},
"job_type_id": "88f2bce5-bf83-46dd-beb9-e496fa0075dc",
"job_type_code": "sample string 7",
"job_type": {
"id": "80c87c6b-f8d2-4315-bdcd-b4d1054e0fd2",
"name": "sample string 2",
"sales_organization_id": "89ea29ca-0284-43bd-86fe-a74adfcc390b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-28T12:58:35.6160961+00:00",
"code": "sample string 7"
},
"job_priority_id": "6c6c6a1a-eeab-4cb8-b174-ddf4ab866163",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bcf82c21-b023-4020-99e7-6ae1f1d0295d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d6f35e1-246e-4071-b987-9e23aee56812",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-28T12:58:35.6160961+00:00"
},
"job_status_id": "04b5b39d-f058-43cd-8804-795c78a5ba1d",
"job_status_code": "sample string 11",
"db_address_id": "eec38601-d7f1-4fb4-8288-a74e61eb6b12",
"contact_id": "5031f080-b319-4df1-a3fc-e3e53742d221",
"requested_by_company_id": "78e3f15d-7238-45c4-8a07-7af5335557f4",
"requested_by_contact_id": "6882958f-0cbf-451c-bc9c-83626f58a75e",
"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-28T12:58:35.6160961+00:00",
"due_date": "2026-10-28T12:58:35.6160961+00:00",
"date_create": "2026-10-28T12:58:35.6160961+00:00",
"date_update": "2026-10-28T12:58:35.6160961+00:00",
"date_closed": "2026-10-28T12:58:35.6160961+00:00",
"suggested_user_id": "1df652ca-3dbf-4e18-9fb3-ea6764330d78",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "42eba05a-aa41-4ddf-9b28-c127da4c036c",
"db_language_id": "9d8a1919-a69c-4d32-aa80-d5370aa1e689",
"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-28T12:58:35.6160961+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3c5bc6da-f709-453b-928b-6debdba3ef55",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0db71cd9-a260-4755-b49d-1e74cb9bc57c",
"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": "4e292a39-438b-4455-9258-1832fa32a24e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-28T12:58:35.6354697+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4993a150-2b62-43eb-a534-58f158ede335"
},
"suggested_date_start": "2026-10-28T12:58:35.6354697+00:00",
"skill_id": "c842d2ba-f672-476a-969c-5c07b818d523",
"skill_code": "sample string 32",
"skill": {
"id": "29a9754b-6652-4872-a362-40c4f8f68fcd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e31b1737-087b-477b-bb6a-6afc9ee7c9ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2660168b-1936-42f4-b007-1b8ebe2c884d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6902ed81-25d8-4700-842d-25995d683427",
"db_currency_id": "60332b54-71d8-40db-8b0b-cf4109f8694a",
"db_language_id": "0a351b6d-20c9-4482-b8f4-066d153bbc2b",
"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-28T12:58:35.6004291+00:00"
},
"modified_dateutc": "2026-10-28T12:58:35.6354697+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "77d8d158-f76b-4f7f-8e02-c891ffb798c5",
"date_reported_by_company": "2026-10-28T12:58:35.6354697+00:00",
"id2": 36,
"company_id": "9af15367-8fb8-4be6-a970-406f2cf5a755",
"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": "cea07c3e-15aa-4790-a0b5-62a987de24fe",
"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-28T12:58:35.6354697+00:00"
},
"work_instruction_details_id": "18877bff-3c5d-4b04-93b5-cc057fecd265",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2dd05113-8203-4546-bd5c-fee973d139fc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cd193aa6-5588-4231-852b-9efcabd5a3cf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-28T12:58:35.6354697+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": "aa6522e5-5f5a-466e-89f8-03955d5a41b9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-28T12:58:35.6354697+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.