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": "d8d6e036-5b46-46b7-b511-1c516beb3065",
"jobs_id": "a94c4487-e34a-40e5-b623-4d6c44c3ff1e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "61883a36-13d2-43c9-9a04-603e5828ce73",
"_parent_id": "46462a91-3247-43ff-8bf1-96f7142d492e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3cdf8dc4-30b3-4aed-9c93-69261a279fce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2fc3d729-2031-45c2-80e1-4ee1a31773d2",
"_parent_id": "55087e07-0770-4809-bfb7-37ecd3e8c926",
"root_parent_id": "ddcea74b-c044-495f-82f0-4d9a2f2df341",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f542a3d0-f3a8-4acd-9950-454619ef206d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f1584bbe-c3a5-4d0f-abaf-3b65c6208a81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2007d1e6-b0c7-4366-bb76-e0bd650b8b05",
"_parent_code": "sample string 6",
"sales_organization_id": "645c01ed-21e3-413c-a1d8-dff5ecfd795f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00"
},
"equipment_model_id": "343690e9-5b5f-4f2c-a9ee-618207e37c73",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "334bd744-d926-4484-9e5b-35f954cdef2e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a90dd944-405e-4109-8ca4-03771f2b51a1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bd9ad312-d083-4b77-9dd3-6483049880e6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "791e4348-801d-4ff4-a2fa-d1fc0e6b065d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00"
},
"equipment_family_id": "254e1654-050f-416e-99b9-ede4ef8c795e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f1584bbe-c3a5-4d0f-abaf-3b65c6208a81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2007d1e6-b0c7-4366-bb76-e0bd650b8b05",
"_parent_code": "sample string 6",
"sales_organization_id": "645c01ed-21e3-413c-a1d8-dff5ecfd795f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00"
},
"date_in_production_since": "2026-05-28T20:08:22.9563543+00:00",
"date_out_of_production_since": "2026-05-28T20:08:22.9563543+00:00",
"date_end_support": "2026-05-28T20:08:22.9563543+00:00",
"sales_organization_id": "21c4483d-7a6e-4590-b9f2-767f44c9ab4c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+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-05-28T20:08:22.9563543+00:00"
},
"project_status_id": "df03f234-392f-4e3e-9e59-83c0bf94e4e0",
"project_status_code": "sample string 10",
"project_status": {
"id": "36319263-0d43-496f-be81-89601bd84c9a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e3b18ba6-b593-47b2-9a2e-308d7993526e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00"
},
"company_id": "5e8ca00a-baa0-4a0e-8f27-68c6799d1b85",
"company_code": "sample string 12",
"db_address_id": "4e572109-d2be-4c4e-a62a-e58069179bf5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "17e18058-0753-49de-9ac1-8950cc25fe90",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6540c76e-a1cd-404d-8a41-6d69a927e574",
"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-05-28T20:08:22.9563543+00:00",
"date_create": "2026-05-28T20:08:22.9563543+00:00",
"date_update": "2026-05-28T20:08:22.9563543+00:00",
"updated_by_user_id": "1b22e681-7ab9-4448-9019-e1a831fa8351",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-28T20:08:22.9563543+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-05-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-28T20:08:22.9563543+00:00",
"date_last_job": "2026-05-28T20:08:22.9563543+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-28T20:08:22.9563543+00:00",
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00",
"is_mobile_installation": true
},
"job_type_id": "668b5693-a8e3-42d7-8fc9-fc5d6f96cbfa",
"job_type_code": "sample string 7",
"job_type": {
"id": "8bcd35c0-4c5b-4fd5-8007-d78d58a01218",
"name": "sample string 2",
"sales_organization_id": "73035b1e-93ff-411e-89d0-a7baf7849e17",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00",
"code": "sample string 7"
},
"job_priority_id": "e57a78be-a620-4bc0-9db9-9a8d27bfb55b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9c4a0b3c-100b-4de6-920e-b0fc26490b4d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "084a8600-4646-409e-9a5c-bdf89a45692b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00"
},
"job_status_id": "55c06366-dd57-4261-a319-42b522bb8ae9",
"job_status_code": "sample string 11",
"db_address_id": "60894fda-5945-4675-b223-3056b5153c20",
"contact_id": "491bce67-df49-409a-91e9-9ed2555c78ef",
"requested_by_company_id": "93053bf9-a92a-4fb8-813a-ce1425753757",
"requested_by_contact_id": "2a0ce450-a00a-4d84-9a2e-1b4fbff812ff",
"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-05-28T20:08:22.9563543+00:00",
"due_date": "2026-05-28T20:08:22.9563543+00:00",
"date_create": "2026-05-28T20:08:22.9563543+00:00",
"date_update": "2026-05-28T20:08:22.9563543+00:00",
"date_closed": "2026-05-28T20:08:22.9563543+00:00",
"suggested_user_id": "41135453-3834-4698-949d-6ef005e51bc1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2bd23493-bccd-4d67-9981-3d067caa4bca",
"db_language_id": "c0bbb91f-a447-43ca-bba2-a23229479fde",
"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-05-28T20:08:22.9563543+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d25ff0d7-77c2-49fb-9209-22294f877016",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3523418f-08b8-4dbe-96ca-74075b0687c8",
"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": "182103a3-68f0-4093-bdef-7401e28f1f3d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-28T20:08:22.9563543+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8b8820e3-74c3-4921-9e85-0364e8a92c89"
},
"suggested_date_start": "2026-05-28T20:08:22.9563543+00:00",
"skill_id": "60d7357c-d963-4636-9d6b-4d78b7e77777",
"skill_code": "sample string 32",
"skill": {
"id": "a1298898-354c-45a1-ba25-3de060b4926b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3e2c33eb-b0a5-4584-88d2-0f3448e9c5b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7232ae1-ca9b-4495-8c6b-fd26f4259404",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d64c9706-4629-4e26-93d4-f26bc8b46d1c",
"db_currency_id": "8d2e002a-cd5e-4cd3-bbee-3cf58e988a63",
"db_language_id": "7aadf53f-0902-4529-838c-28fc81642743",
"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-05-28T20:08:22.9563543+00:00"
},
"modified_dateutc": "2026-05-28T20:08:22.9719761+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9dbe6146-ac44-482c-bba2-857883a9ce5f",
"date_reported_by_company": "2026-05-28T20:08:22.9719761+00:00",
"id2": 36,
"company_id": "61177ced-8566-41c1-8cac-972fea3b2b00",
"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": "45b18fe6-4766-4a5d-99da-e4c6078666ae",
"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-05-28T20:08:22.9719761+00:00"
},
"work_instruction_details_id": "4b9c5ebd-d299-445d-b97d-488c1c0dee16",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c21730d1-093b-4ee3-bf8c-c6fbd0f341fd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "11b85024-690a-47d5-b80d-c84ff0fabdb9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-28T20:08:22.9719761+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": "15789cca-47c3-4c55-955e-1bbeaea71b86",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-28T20:08:22.9719761+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.