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": "79354cfd-fe46-4b34-8336-ac51bd7e5a8f",
"jobs_id": "f892dab6-69e7-45b0-9dec-a953c6a92851",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "49fc9646-a59c-4ae8-94ca-866430a15602",
"_parent_id": "aa5d9b17-c1da-4037-b03c-b4e75d873412",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eda272a8-267c-41df-8d10-0a32508aafd4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7486261a-baee-435e-898a-321ffa755402",
"_parent_id": "76b36bb1-10e8-4ed0-ac46-d6a776548632",
"root_parent_id": "52d07b3f-35fd-4ffe-b9f7-8c397533b75d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d8a511cd-8959-410a-9c17-6bf80892d8b4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "afd9143b-70aa-4e67-a8c8-7ca3748dd7dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dda9eee1-7406-4843-af15-8ade4d605459",
"_parent_code": "sample string 6",
"sales_organization_id": "e757efaf-5f19-4bb6-9b7c-526173901b95",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
},
"equipment_model_id": "b8061510-6b36-40b9-9947-cf05671c0e01",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "847ec578-83c1-4dff-a3d0-a23b2b694236",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d58c8150-fcbb-4f48-9384-ad041999dd47",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cb82ab18-0677-403e-96c2-a942666a1202",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d116bdf4-01f7-4c71-8a72-9476a6dca1a6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
},
"equipment_family_id": "e6ff5b6e-0151-4b58-8ca8-014fa528efd4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "afd9143b-70aa-4e67-a8c8-7ca3748dd7dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dda9eee1-7406-4843-af15-8ade4d605459",
"_parent_code": "sample string 6",
"sales_organization_id": "e757efaf-5f19-4bb6-9b7c-526173901b95",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
},
"date_in_production_since": "2026-07-31T00:43:24.2601584+00:00",
"date_out_of_production_since": "2026-07-31T00:43:24.2601584+00:00",
"date_end_support": "2026-07-31T00:43:24.2601584+00:00",
"sales_organization_id": "76ddb741-3d19-419b-9623-a0cbef4f1bfc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+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-07-31T00:43:24.2601584+00:00"
},
"project_status_id": "a3d2020c-e01b-405d-b4b7-e69da9fb60d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "31930891-e4d5-4789-83d8-e6aab1ddb583",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dcd69641-3c82-4c38-9cea-22fa5a2ae044",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
},
"company_id": "6788769f-1d6b-4752-98f7-dfa3cdd1f6df",
"company_code": "sample string 12",
"db_address_id": "4b3b760a-953c-44dd-bd22-a42ac03bd560",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb276172-526c-4a77-9ac4-7e6c72028c8d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2b1a717e-652c-45f3-8752-f7e388a51b86",
"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-07-31T00:43:24.2601584+00:00",
"date_create": "2026-07-31T00:43:24.2601584+00:00",
"date_update": "2026-07-31T00:43:24.2601584+00:00",
"updated_by_user_id": "70cde2c2-8418-404f-bf98-298aef078282",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-31T00:43:24.2601584+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-07-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-31T00:43:24.2601584+00:00",
"date_last_job": "2026-07-31T00:43:24.2601584+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-31T00:43:24.2601584+00:00",
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00",
"is_mobile_installation": true
},
"job_type_id": "6f020fae-11a8-4634-85f0-9ad964ac168d",
"job_type_code": "sample string 7",
"job_type": {
"id": "748e779b-bdb3-448c-ae70-6085a2b28007",
"name": "sample string 2",
"sales_organization_id": "b4c89694-87ef-4636-b16f-fc946dd6377c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00",
"code": "sample string 7"
},
"job_priority_id": "e0fcdfcf-35bb-4993-9251-fa8e3d0fd792",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f394774f-57e6-4d5b-9efd-deeb52b80b51",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "82e6a258-66b5-4835-85e5-e9caa258ce3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
},
"job_status_id": "deb88658-589a-4b87-b2f2-49ab6b33e10b",
"job_status_code": "sample string 11",
"db_address_id": "398fbdef-9ec4-4fad-bd95-82c45cc42435",
"contact_id": "7116536b-801d-4e09-988f-b7b4eb34f26e",
"requested_by_company_id": "741224dd-0ac1-4a1c-848c-d34b58b77028",
"requested_by_contact_id": "af07c715-c7e8-4307-8c90-b347cd45e9cd",
"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-07-31T00:43:24.2601584+00:00",
"due_date": "2026-07-31T00:43:24.2601584+00:00",
"date_create": "2026-07-31T00:43:24.2601584+00:00",
"date_update": "2026-07-31T00:43:24.2601584+00:00",
"date_closed": "2026-07-31T00:43:24.2601584+00:00",
"suggested_user_id": "777ab592-4155-4de3-b5cb-14749b06a5b6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aeb15731-3211-4e02-a598-b649fb027526",
"db_language_id": "3755090a-ff62-4b81-8d59-dbfe040e432d",
"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-07-31T00:43:24.2601584+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "86a54a93-99af-4804-aef0-1bd6004c61da",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "db0c5b30-405b-4a3f-b1ea-f49085d2b5c5",
"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": "9dfebb9a-981a-4f0d-9150-f4f15521b638",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f770d834-5197-4312-b0f0-c09540509ac1"
},
"suggested_date_start": "2026-07-31T00:43:24.2601584+00:00",
"skill_id": "c64a0881-f9a1-4dbd-ba3d-d6b80bf95889",
"skill_code": "sample string 32",
"skill": {
"id": "f3f8d350-cef9-48d6-95b2-761b552cd1aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4c56f54d-da0e-4958-87e4-7eb13a670bab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ab28757-3f52-41cc-8c8f-b741301d4797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89920152-e3e6-481a-8be0-8699fb4905c1",
"db_currency_id": "e9efc811-9729-440c-8d24-f91f8abc2802",
"db_language_id": "637159f2-7f5f-4304-87c4-8e77e2e11b43",
"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-07-31T00:43:24.2601584+00:00"
},
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "09094cf6-0ee3-4f05-8d1e-26f1793ccc36",
"date_reported_by_company": "2026-07-31T00:43:24.2601584+00:00",
"id2": 36,
"company_id": "5603907e-6b69-451b-8e4a-0976ebeb1348",
"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": "5dcc3e3a-e1c8-499f-9122-79d471b45385",
"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-07-31T00:43:24.2601584+00:00"
},
"work_instruction_details_id": "58c504a1-63fe-43ae-aa2a-78eedbb742bc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ddfc114e-8e72-4e28-9c36-033207f839ee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bd3adaeb-4609-45ce-8e63-5ce8d723e4d3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-31T00:43:24.2601584+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": "1b985b22-f6aa-42b2-ac0a-c93e3219e6b2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-31T00:43:24.2601584+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.