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": "14bf69fa-9c0d-4f5b-b94f-8c4d81e9099c",
"jobs_id": "4da6d55d-0d71-44d8-9b13-2220dc68a5c5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e682b660-1493-4cff-b919-f2cc93729d9b",
"_parent_id": "4c48ebae-013e-40d3-80a0-a759db9db6f8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ca6c953e-0926-4037-a222-f58c1295626b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2b89c1ae-22de-495f-a3d9-c160db6ace43",
"_parent_id": "9814746a-2f4b-4cfa-9c30-64fa9a9ba6bf",
"root_parent_id": "bb5a06bf-138e-48a0-a92a-c6490507853b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "adc31b23-4210-4c0c-85ff-d7f941033a60",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "37e01de4-943b-4f8e-83aa-1b8a37d81cc0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4a64a3d6-40f1-4f09-b645-bc5c97a0bd77",
"_parent_code": "sample string 6",
"sales_organization_id": "25b2f2bc-b276-45c9-a2d5-a64f500b0a9b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
},
"equipment_model_id": "a83313a4-2e22-4048-afe0-b8de5855681c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f70e29a4-b792-4fce-9f0f-3faba35c2762",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c37e8355-e633-48bc-87d0-7df5cc205a51",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5047eff8-23c6-4b85-a745-1094b1e6a2eb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d2f467c7-1324-4f02-866b-21e466c0743d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
},
"equipment_family_id": "73cc1ae8-bfcd-4767-9fa7-a872ec212747",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "37e01de4-943b-4f8e-83aa-1b8a37d81cc0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4a64a3d6-40f1-4f09-b645-bc5c97a0bd77",
"_parent_code": "sample string 6",
"sales_organization_id": "25b2f2bc-b276-45c9-a2d5-a64f500b0a9b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
},
"date_in_production_since": "2025-04-25T20:24:44.0863171+00:00",
"date_out_of_production_since": "2025-04-25T20:24:44.0863171+00:00",
"date_end_support": "2025-04-25T20:24:44.0863171+00:00",
"sales_organization_id": "f7f0cf38-1c55-4a53-b7e9-91b59a20d7d1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+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": "2025-04-25T20:24:44.0863171+00:00"
},
"project_status_id": "3662f987-3399-4ff4-a3c4-a79a6a5a4cb7",
"project_status_code": "sample string 10",
"project_status": {
"id": "3d102b72-e99d-4409-80d5-373ab02c8fa1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b0c08469-2ee5-491b-81a7-2bf570b2fd6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
},
"company_id": "84c49bb2-0a0d-4c40-9014-822370e6cd20",
"company_code": "sample string 12",
"db_address_id": "dbda6dfe-648b-4eb9-8e63-3d4b2408092c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0417e339-a5ff-4245-918b-5db24cf17fb6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dd039f80-c458-41ef-b5f6-05b7e9991140",
"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": "2025-04-25T20:24:44.0863171+00:00",
"date_create": "2025-04-25T20:24:44.0863171+00:00",
"date_update": "2025-04-25T20:24:44.0863171+00:00",
"updated_by_user_id": "40b232fb-87d6-43e3-8f7a-6934bc2a5863",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-04-25T20:24:44.0863171+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": "2025-04-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-04-25T20:24:44.0863171+00:00",
"date_last_job": "2025-04-25T20:24:44.0863171+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-04-25T20:24:44.0863171+00:00",
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00",
"is_mobile_installation": true
},
"job_type_id": "ec5afe36-3d13-4059-b113-bf6eb4242b4e",
"job_type_code": "sample string 7",
"job_type": {
"id": "761eb19a-f979-4712-84a9-f4bcede2986d",
"name": "sample string 2",
"sales_organization_id": "9d83f0bd-b3f4-40c3-bf55-d00e781255a7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00",
"code": "sample string 7"
},
"job_priority_id": "4b696b93-1028-4bd4-99a0-4fb484acb29f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a6d28980-757a-4a43-ac6b-0db462d92ed2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9a82c9b1-0fbc-432f-a513-d6a64c619c51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
},
"job_status_id": "c834a468-2fdd-435d-9bbd-5d4638eb60a3",
"job_status_code": "sample string 11",
"db_address_id": "7a27406d-3d87-45d1-873f-e23a3e0bff6f",
"contact_id": "c4bcf703-5232-4098-ac51-556cd32d9e04",
"requested_by_company_id": "60aeb249-4944-4cf0-a579-4a00f31908f9",
"requested_by_contact_id": "5f1e975d-6502-4bbf-9eb2-0207420042a3",
"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": "2025-04-25T20:24:44.0863171+00:00",
"due_date": "2025-04-25T20:24:44.0863171+00:00",
"date_create": "2025-04-25T20:24:44.0863171+00:00",
"date_update": "2025-04-25T20:24:44.0863171+00:00",
"date_closed": "2025-04-25T20:24:44.0863171+00:00",
"suggested_user_id": "7d1aa571-0d8a-46b7-b1be-3061d647a991",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "40f3c96a-b7a7-451a-8fd2-d5caeced9a07",
"db_language_id": "74df1524-043f-46c0-af8e-66ca5138ddcd",
"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": "2025-04-25T20:24:44.0863171+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f22af161-68d6-4889-8529-7557fc27295a",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a127877d-8397-4a1b-998a-6ca812975f10",
"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": "67751a45-ad22-4822-999d-ef73156b230f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0f4e8261-c511-49d5-bac3-1b9a0af36799"
},
"suggested_date_start": "2025-04-25T20:24:44.0863171+00:00",
"skill_id": "29a358f1-d361-44a6-a814-780dbc967368",
"skill_code": "sample string 32",
"skill": {
"id": "dadc1108-dafd-471e-a55f-4c2a1c112658",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "54240cdf-b5b1-4a30-8979-4b6fadfa95fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0e17f171-5fa1-454b-b32b-5b929e568a11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "87e6373e-2867-4fed-a309-3d1256262409",
"db_currency_id": "98865150-ba4a-4fe5-9ae8-74663bc74a52",
"db_language_id": "b9d5f3ed-fda4-4ae2-b812-2c4a50aa8947",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f4d4459c-ac71-422d-bb23-c03cab37bed9",
"date_reported_by_company": "2025-04-25T20:24:44.0863171+00:00",
"id2": 36,
"company_id": "d8ef6ac7-80a3-4d21-98b9-3269f7aaa747",
"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": "393907ec-a2e6-4cf7-bd59-1f64ca72ffe9",
"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": "2025-04-25T20:24:44.0863171+00:00"
},
"work_instruction_details_id": "f95b4103-6f34-45c5-bc51-10848af23904",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "88aca059-2d21-42d7-b618-6706d201f55f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dfecf9d3-386d-4229-85ec-a09f61c82af0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-04-25T20:24:44.0863171+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": "407a9e7d-ae94-4c4d-863e-ab7c6b5b068d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-04-25T20:24:44.0863171+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.