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": "505c946a-02c2-4c1d-a5cb-df74f38d5c8d",
"jobs_id": "e408414e-4749-4820-9df7-14c9db7125ca",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4417f7fe-1b74-49c9-8bf5-a64adf13924c",
"_parent_id": "ec00cb5e-4592-494b-9b0f-1703b144f62f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a556ea61-5d0c-43ce-87d8-d295a1f287dd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "064eac77-7016-4833-9543-eea34985642f",
"_parent_id": "df84c325-ccb6-4db2-99b8-f4848e696d35",
"root_parent_id": "3b30195f-065d-410b-82b8-584c02aff39b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cde8f569-e2de-4dca-a727-482db79f3fd2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a054817c-e992-41fc-9f5d-3fd941579ed6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "de0b07b3-a25b-4f0a-a42f-c703d34b8417",
"_parent_code": "sample string 6",
"sales_organization_id": "439210f8-0d27-44a7-9f60-5e43abd8af09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"modified_dateutc": "2026-06-16T17:27:33.8663221+00:00"
},
"equipment_model_id": "5e77de53-a2ed-4c29-8ef3-f53a98229f89",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "140e7bf2-e422-4d28-98f3-b870cdb3675e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d497240c-f382-402f-9c15-757277f7a663",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d53c6ca7-8944-4290-99fc-d22a57941882",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8b028692-97af-47cd-bc88-619136935a62",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00"
},
"equipment_family_id": "ed4b7e6c-78ba-4734-925c-9c61d78b93a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a054817c-e992-41fc-9f5d-3fd941579ed6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "de0b07b3-a25b-4f0a-a42f-c703d34b8417",
"_parent_code": "sample string 6",
"sales_organization_id": "439210f8-0d27-44a7-9f60-5e43abd8af09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"modified_dateutc": "2026-06-16T17:27:33.8663221+00:00"
},
"date_in_production_since": "2026-06-16T17:27:33.8819423+00:00",
"date_out_of_production_since": "2026-06-16T17:27:33.8819423+00:00",
"date_end_support": "2026-06-16T17:27:33.8819423+00:00",
"sales_organization_id": "232d7247-5365-44f6-934a-93e9d6827eac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+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-06-16T17:27:33.8819423+00:00"
},
"project_status_id": "efc7073f-999f-4a1c-8405-f0b2e1dc3a91",
"project_status_code": "sample string 10",
"project_status": {
"id": "2479fca6-05c8-4ae7-ad66-ee8fc5339e96",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "270dd0f0-e53f-49f9-b288-88aa11d3cce3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00"
},
"company_id": "ae2d8c19-4786-45df-87f3-114ad79d9949",
"company_code": "sample string 12",
"db_address_id": "117392dc-8885-4bca-8ebd-12b457844548",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7a63f0cb-5319-42e6-a550-85c51f702f8d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a14037fc-cdd0-44eb-b6cc-078de1fb1198",
"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-06-16T17:27:33.8819423+00:00",
"date_create": "2026-06-16T17:27:33.8819423+00:00",
"date_update": "2026-06-16T17:27:33.8819423+00:00",
"updated_by_user_id": "a0d7a580-6393-4264-b9e4-32d8d47fe8b0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-16T17:27:33.8819423+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-06-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-16T17:27:33.8819423+00:00",
"date_last_job": "2026-06-16T17:27:33.8819423+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-16T17:27:33.8819423+00:00",
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00",
"is_mobile_installation": true
},
"job_type_id": "32838743-a8d7-4f4e-9e66-7b3eb68fa69b",
"job_type_code": "sample string 7",
"job_type": {
"id": "54358060-b6aa-4428-ae5a-c270a0e8396d",
"name": "sample string 2",
"sales_organization_id": "f00f0f7d-2d57-4ebc-b4ec-9e3d3dd55eae",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00",
"code": "sample string 7"
},
"job_priority_id": "f4f6a5e4-7031-4eb1-9ed1-e1635a1875aa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb4d5ed0-2c4b-4b7e-a1f7-8c3cf294c342",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ae43aa20-baea-40d0-8659-f67e49be2abf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00"
},
"job_status_id": "549e3609-05e8-4e13-9aee-b8f38d6b90e4",
"job_status_code": "sample string 11",
"db_address_id": "699fe66d-446e-46ad-84f9-1f3a3840c787",
"contact_id": "b4296324-5fcb-4527-831b-ff9027cbc21d",
"requested_by_company_id": "658a2441-4b0b-48d2-841b-94feabac759e",
"requested_by_contact_id": "0d28c71a-098c-43f9-ab10-914116e53b43",
"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-06-16T17:27:33.8819423+00:00",
"due_date": "2026-06-16T17:27:33.8819423+00:00",
"date_create": "2026-06-16T17:27:33.8819423+00:00",
"date_update": "2026-06-16T17:27:33.8819423+00:00",
"date_closed": "2026-06-16T17:27:33.8819423+00:00",
"suggested_user_id": "53b4766d-0328-40a3-9837-51dfc008308c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f903ecde-905f-411d-b426-99e1bf65e9e7",
"db_language_id": "ad56e841-d3d3-48f3-98c4-141f457ce668",
"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-06-16T17:27:33.8819423+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d1d6fc09-e77c-4237-be11-b76ebf46f8c6",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea3ea015-6216-4f76-a22a-bd914bdccb5c",
"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": "6a6f902f-dd49-42d5-9d11-2c357de5b92f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "77bb2718-2d64-43f0-9632-8c54948ba7a8"
},
"suggested_date_start": "2026-06-16T17:27:33.8819423+00:00",
"skill_id": "27b50ed1-2624-4daa-9909-189c4add4acc",
"skill_code": "sample string 32",
"skill": {
"id": "3a9c80a3-b63e-41e8-8bd8-4cdbaeb2665d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b0ed5f26-ebbc-4c04-9365-1cac1d98a0cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00dd4332-6df9-486f-adb0-d55d0eed9510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4963b48-fd20-40d2-8124-9130a72d6ff9",
"db_currency_id": "bf763baf-b7e7-4d56-93da-76f097441396",
"db_language_id": "03f5a2af-98a4-43a5-96f2-dc45c457726f",
"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-06-16T17:27:33.8663221+00:00"
},
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f39de7df-00d8-4715-8fdb-0e840abe32f2",
"date_reported_by_company": "2026-06-16T17:27:33.8819423+00:00",
"id2": 36,
"company_id": "21114221-3fb9-4cd1-8d0c-c5b694021074",
"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": "7b310ab5-b2b8-431e-97c9-6c6a870c69b2",
"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-06-16T17:27:33.8819423+00:00"
},
"work_instruction_details_id": "853fe177-de08-4e74-bc4d-3cb9c5bf006d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "aeddf6e8-4222-45ec-a07b-201f6d7e1ff5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "538d8842-60bb-4a79-8750-ac64faeb30fc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-16T17:27:33.8819423+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": "08c2568f-51e0-4cb3-add6-53588010579b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-16T17:27:33.8819423+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.