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": "d963f82e-e9ce-4e1f-a8cb-55f8c02402fc",
"jobs_id": "deaa47c7-4e69-4343-87aa-5ee301177336",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd690cf5-ec5e-4f80-938e-767c117c0203",
"_parent_id": "d2b0f7c8-905a-463c-b19c-6d1c1bc9406a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ebc86eb5-b747-4f03-b2f8-c8a7204e3aac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c6a163cb-863b-4cf3-ac16-ae8fd9de8214",
"_parent_id": "be030cc8-f2b1-4ce7-a639-ffc2b48339b6",
"root_parent_id": "16380ff7-e8fa-4102-93d9-432c9e67b450",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6954f842-ed43-4a1c-b1f7-62a0e6320050",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "de2848d0-d29f-4b7f-a01b-43c17e230fe1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b07feb6-9f76-48f2-bd1c-9f721f3be671",
"_parent_code": "sample string 6",
"sales_organization_id": "6568a1a9-214b-432b-b8e8-f66fef29e454",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
},
"equipment_model_id": "1f18b901-6a0b-44d3-b338-5756289a0c5f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e7c10ed3-ab01-4ebb-8828-3868b5f84d3f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2638379f-df2c-4950-8be4-d73e2b1914ea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2434270f-8335-4bea-82f1-a0af12614402",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ab2ea539-e7e1-4947-bd9a-c4a0b89b35a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
},
"equipment_family_id": "6096e6ef-fa08-4f81-9858-d870ff24e956",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "de2848d0-d29f-4b7f-a01b-43c17e230fe1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6b07feb6-9f76-48f2-bd1c-9f721f3be671",
"_parent_code": "sample string 6",
"sales_organization_id": "6568a1a9-214b-432b-b8e8-f66fef29e454",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
},
"date_in_production_since": "2025-11-22T02:42:07.4344589+00:00",
"date_out_of_production_since": "2025-11-22T02:42:07.4344589+00:00",
"date_end_support": "2025-11-22T02:42:07.4344589+00:00",
"sales_organization_id": "e0d1e56d-f203-485c-8205-07bccd1f4261",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+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-11-22T02:42:07.4344589+00:00"
},
"project_status_id": "b46e1c3d-e232-4ce8-8664-fe860f4c909c",
"project_status_code": "sample string 10",
"project_status": {
"id": "b7f0a304-2257-495b-a57e-d194010f64d5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bcf7d0d9-f476-4043-bc20-4c934f9583cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
},
"company_id": "43614436-deed-460b-835a-2e74250230da",
"company_code": "sample string 12",
"db_address_id": "07b2f3c3-b950-49e3-894c-9cb6a6935e5b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e2dc3add-44d4-4c48-b43b-c7983070db27",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "be151b9c-9de1-492c-965c-0fa79de54186",
"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-11-22T02:42:07.4344589+00:00",
"date_create": "2025-11-22T02:42:07.4344589+00:00",
"date_update": "2025-11-22T02:42:07.4344589+00:00",
"updated_by_user_id": "da3806c3-3f55-4e7e-836a-3393f4ea4484",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-22T02:42:07.4344589+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-11-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-22T02:42:07.4344589+00:00",
"date_last_job": "2025-11-22T02:42:07.4344589+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-22T02:42:07.4344589+00:00",
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00",
"is_mobile_installation": true
},
"job_type_id": "011699cc-236d-4652-bc2c-69073e761818",
"job_type_code": "sample string 7",
"job_type": {
"id": "448b1314-7590-4318-af2e-44d44c964886",
"name": "sample string 2",
"sales_organization_id": "d23b44de-0e68-4053-8219-b3bcfc8948b7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00",
"code": "sample string 7"
},
"job_priority_id": "4b7cadf5-a67e-47cf-be2d-d0053b7d514f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9a015bf5-a600-4a90-8e64-69ed490bafb2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "60c7b5f6-83de-4950-ba5e-7fdc72460571",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
},
"job_status_id": "3cfb17f4-8d73-4e5b-a895-cd6457a3f88c",
"job_status_code": "sample string 11",
"db_address_id": "acd574d1-cbb3-4692-abea-7ac5aedf4db6",
"contact_id": "ce2461f7-d76e-4aad-8ba4-af78b0a9d78f",
"requested_by_company_id": "220a5519-b7b1-443e-815d-9c5cfcd8798d",
"requested_by_contact_id": "1f4a6ab7-f7ab-484f-9d9d-c3c8ac12ba98",
"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-11-22T02:42:07.4344589+00:00",
"due_date": "2025-11-22T02:42:07.4344589+00:00",
"date_create": "2025-11-22T02:42:07.4344589+00:00",
"date_update": "2025-11-22T02:42:07.4344589+00:00",
"date_closed": "2025-11-22T02:42:07.4344589+00:00",
"suggested_user_id": "84c1c6f6-85b4-49cd-8e14-b251c7848a1f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "eca3700e-1e16-45b5-8121-c95f43c479d9",
"db_language_id": "1a460889-f143-49a4-a899-02734d211bed",
"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-11-22T02:42:07.4344589+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04d6f3b6-2e29-4035-9b45-1efad8624974",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2f9cc43-1388-4abf-89c5-dc3a231ae5db",
"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": "32581ecb-a1ba-4cfd-93dc-862f4db24e31",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7f495a37-2d8d-402f-93fe-7401d18c96f3"
},
"suggested_date_start": "2025-11-22T02:42:07.4344589+00:00",
"skill_id": "837f648d-c9e7-47a4-9bff-4e292d1f422c",
"skill_code": "sample string 32",
"skill": {
"id": "4a79b5a3-b8c3-4dba-bd97-40e55d8cd0ef",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cca474e1-23ae-4139-9c4e-41e6e6066b01",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "133cb931-5dbb-48b2-9a33-1739736ee7ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c25986d7-2684-435c-98bf-6db491ba0994",
"db_currency_id": "bd212748-e2bf-40fa-8e2a-bc3f9453ce6e",
"db_language_id": "ea649ee7-d9aa-4718-b13f-75ffc5afcff2",
"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-11-22T02:42:07.4344589+00:00"
},
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d33e27ed-6e9c-4c0b-89f0-7fcf0e910f07",
"date_reported_by_company": "2025-11-22T02:42:07.4344589+00:00",
"id2": 36,
"company_id": "4301d0cc-3084-4b96-af7a-91ccd67699e6",
"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": "1825be95-f4ad-43b8-bf85-d18811fddc4f",
"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-11-22T02:42:07.4344589+00:00"
},
"work_instruction_details_id": "096cce76-485f-436c-99b1-92f3ade0c5e7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b9b7153c-a173-43ad-bb98-34cc152c369b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4aeb603a-9b2b-4a22-8f34-48492d24a8b9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-22T02:42:07.4344589+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": "a4130d19-6543-4a08-8dab-2c2129ec295e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-22T02:42:07.4344589+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.