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": "33a94cce-b2f4-4a3d-9679-fe4d233173b1",
"jobs_id": "1d9f03dd-4bec-4ac9-b863-e4368e71b42b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b74b1530-6346-450e-a1ae-926caf76d523",
"_parent_id": "2c6f0944-8d30-41dd-8507-1e59b59435f0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ce060198-0fe8-4e37-afb8-81ae3948bc14",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7829ce8f-a116-4c68-9209-8f6edfaa256d",
"_parent_id": "6b072ea3-642d-4ac4-88fc-21570508a383",
"root_parent_id": "b241fb2f-a598-4ff7-a3fc-eb93c4091298",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "79c80dc2-fe25-4f46-a41e-23fd6a4b149f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "52d80fc9-fbc9-4eee-9450-f1988d3d94b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a73105e7-b468-4d7c-9c33-4dd0c73da4e1",
"_parent_code": "sample string 6",
"sales_organization_id": "e3169449-b026-45a0-9b1b-cb38d6ed8f35",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
},
"equipment_model_id": "e8afd3e5-e4fb-49a2-badd-1f283c6118c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9a8018c9-2b25-42b3-b003-0d62e90c742a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "09baa3ca-4e34-4480-b623-150f69b3cc47",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4ec23526-bcd1-42db-b3ee-a959288992ec",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "57c473d9-2790-4fd0-9a07-56698b57a2f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
},
"equipment_family_id": "a2c1d2cb-4e48-481d-afa8-5c13afc07f59",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "52d80fc9-fbc9-4eee-9450-f1988d3d94b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a73105e7-b468-4d7c-9c33-4dd0c73da4e1",
"_parent_code": "sample string 6",
"sales_organization_id": "e3169449-b026-45a0-9b1b-cb38d6ed8f35",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
},
"date_in_production_since": "2026-11-02T04:58:17.6764949+00:00",
"date_out_of_production_since": "2026-11-02T04:58:17.6764949+00:00",
"date_end_support": "2026-11-02T04:58:17.6764949+00:00",
"sales_organization_id": "0af47f4f-e47a-4629-92ed-8d2d6579225d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+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-11-02T04:58:17.6764949+00:00"
},
"project_status_id": "0809b148-c86c-4513-b29e-f8bc6b8204d4",
"project_status_code": "sample string 10",
"project_status": {
"id": "ab0b3adf-134b-4470-8181-f607624e4f1c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "153ac0cc-7de4-4aa0-a842-245f4a35239a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
},
"company_id": "bc3a9fc2-2e87-436b-99ff-147c8b49c893",
"company_code": "sample string 12",
"db_address_id": "514827ac-262f-4a51-903a-00e610e67967",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0afc456c-0b95-4c6e-8ea5-6db939869467",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c96ef641-d458-422f-86f4-277ed374c8da",
"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-11-02T04:58:17.6764949+00:00",
"date_create": "2026-11-02T04:58:17.6764949+00:00",
"date_update": "2026-11-02T04:58:17.6764949+00:00",
"updated_by_user_id": "69c63221-c008-4a57-8191-5002ed6c7c4f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-02T04:58:17.6764949+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-11-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-02T04:58:17.6764949+00:00",
"date_last_job": "2026-11-02T04:58:17.6764949+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-02T04:58:17.6764949+00:00",
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00",
"is_mobile_installation": true
},
"job_type_id": "c00c8fb1-895e-4bdc-a407-28b3f64e574a",
"job_type_code": "sample string 7",
"job_type": {
"id": "ef1dc352-d787-42c4-bd1a-6972e5734258",
"name": "sample string 2",
"sales_organization_id": "8e39eeca-1e0b-4f33-879a-83e71e6a90fd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00",
"code": "sample string 7"
},
"job_priority_id": "4515a1f4-43e5-423d-a4af-59d61ecd530b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "40022b19-2bb3-49a8-b42b-66e942900cf6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "76dd1d38-e3c8-45c3-9d26-b6743ae6b65d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
},
"job_status_id": "73d32641-3e53-44ce-8cb6-b3d542603f36",
"job_status_code": "sample string 11",
"db_address_id": "91d3b15c-d252-4142-9b0d-8da74e050364",
"contact_id": "03c6820a-8988-44df-af86-d8991be8eba1",
"requested_by_company_id": "1bc16911-6c41-46bf-84c9-15ce9ea27e22",
"requested_by_contact_id": "91b61021-5cb8-436f-8004-6e6b0c5e3a6c",
"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-11-02T04:58:17.6764949+00:00",
"due_date": "2026-11-02T04:58:17.6764949+00:00",
"date_create": "2026-11-02T04:58:17.6764949+00:00",
"date_update": "2026-11-02T04:58:17.6764949+00:00",
"date_closed": "2026-11-02T04:58:17.6764949+00:00",
"suggested_user_id": "279b050f-fa45-44c2-916c-95f9e7add750",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4b9fbb39-eabf-4f37-89ea-018235e02652",
"db_language_id": "6d59a51e-2048-4785-888c-8b5ecdc6a982",
"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-11-02T04:58:17.6764949+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8c12050f-cf89-4c51-8cdd-5b4b9f3b87f0",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9d5d7482-f6b7-447e-8871-686fd7a85376",
"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": "fc5393a9-cfd7-4771-9589-aa6338e4fcb9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ddd870f5-f14a-4120-822d-dcb1d4581ded"
},
"suggested_date_start": "2026-11-02T04:58:17.6764949+00:00",
"skill_id": "0509a534-346a-4568-8165-d5ff7e37531d",
"skill_code": "sample string 32",
"skill": {
"id": "4a891180-0f9b-4ee1-9899-5fde3dfa3b97",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "522ab553-7b8d-4ea6-8288-b3217c778a79",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c273043b-01e2-489c-a099-4d7bf5d32121",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8704a383-e8d0-40cf-ba6e-52e3d1020f3a",
"db_currency_id": "fd20e94b-4659-4ee4-aac0-e81eac11e645",
"db_language_id": "a046aac4-fc0c-4975-bfd2-01a586d520ad",
"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-11-02T04:58:17.6764949+00:00"
},
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aec29bac-d806-48b2-9436-9cce3f0a9805",
"date_reported_by_company": "2026-11-02T04:58:17.6764949+00:00",
"id2": 36,
"company_id": "3ec66821-bb6d-4f55-a95d-ae3fbf9e4c62",
"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": "64c8ca2b-efb4-4ecd-a0bd-e0a44b16f9ef",
"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-11-02T04:58:17.6764949+00:00"
},
"work_instruction_details_id": "fad40f53-fc36-414d-9fe0-0d3ee021fbf7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3cec4165-9aa7-45a9-8332-d308451647bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f7297cb-fb91-4fbd-9766-6e6153a9d0f8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-02T04:58:17.6764949+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": "ec31665d-88a2-4d10-910f-5adefc4417b8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-02T04:58:17.6764949+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.