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": "5f9bc2d8-a7f1-4ef2-a734-1b97fb5ef2aa",
"jobs_id": "cae3a726-74d3-4dfc-a37f-53e6a67c2d14",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f9636947-5bde-43e4-8f46-8b02a454f8e0",
"_parent_id": "78c396c3-10b9-4278-9088-a030f180422d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5dcfdd4e-9e73-4d90-8900-3f7726467e95",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6846364f-09b7-4ed0-9046-3b50e1d56121",
"_parent_id": "b51947c1-d26d-4df4-8f8d-63241e17187d",
"root_parent_id": "fe6376d4-63d9-41eb-9691-c62bd5835c50",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6b08f3df-a000-4174-a5bf-655966b023e5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dda0b679-661a-442d-897e-b0264018798e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d39f4313-515c-44e1-b8ba-b81462a8857d",
"_parent_code": "sample string 6",
"sales_organization_id": "4cd5c253-1a7f-48f4-82ea-e91ce73bd396",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
},
"equipment_model_id": "2b6d21aa-712e-4280-863e-6b7a78f87ec8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dbc97204-d291-42f0-a823-006647fc809a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c28db4e2-c512-4686-894f-cb03a6fb138f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "585e82f8-3289-4787-a3bf-c621f4ccfbcb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "32ec0f93-0779-48c9-962a-028fb4af960f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
},
"equipment_family_id": "907918ff-2a80-4d8c-bd20-72f479fc3bc3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dda0b679-661a-442d-897e-b0264018798e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d39f4313-515c-44e1-b8ba-b81462a8857d",
"_parent_code": "sample string 6",
"sales_organization_id": "4cd5c253-1a7f-48f4-82ea-e91ce73bd396",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
},
"date_in_production_since": "2026-09-23T15:22:21.0640643+00:00",
"date_out_of_production_since": "2026-09-23T15:22:21.0640643+00:00",
"date_end_support": "2026-09-23T15:22:21.0640643+00:00",
"sales_organization_id": "27075491-0c30-495f-992c-5dcb474ac61c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+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-09-23T15:22:21.0640643+00:00"
},
"project_status_id": "b4fa0111-c58e-4839-9b61-7aa5940159ba",
"project_status_code": "sample string 10",
"project_status": {
"id": "ff1ad148-749d-4ec3-80db-04330a4b75fd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "595cd21a-484a-4295-8ec6-973e01913e35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
},
"company_id": "52e8c7f2-b3cc-496f-b6b3-955c14876980",
"company_code": "sample string 12",
"db_address_id": "06701771-779c-42c8-b106-c9e9e519bb2c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "15a1bada-0708-4cea-b641-0e6ae96f8d3d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c829fcde-4227-4e85-9afc-6abc063ff9a6",
"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-09-23T15:22:21.0640643+00:00",
"date_create": "2026-09-23T15:22:21.0640643+00:00",
"date_update": "2026-09-23T15:22:21.0640643+00:00",
"updated_by_user_id": "48ecf7cc-9af5-4409-b089-1631a6b941dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T15:22:21.0640643+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-09-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T15:22:21.0640643+00:00",
"date_last_job": "2026-09-23T15:22:21.0640643+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T15:22:21.0640643+00:00",
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00",
"is_mobile_installation": true
},
"job_type_id": "cd3c7d65-15ce-4dff-9cd5-faa074a676b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "cf00c0e3-3799-4abc-a475-b83a9f38d064",
"name": "sample string 2",
"sales_organization_id": "641a6a94-b2fb-4ff4-ad31-c9c357a04585",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00",
"code": "sample string 7"
},
"job_priority_id": "323dccaa-4187-47d4-94cf-a6e92cb5616f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0eead451-6e47-4f3a-a576-de395590cb26",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "42312d92-d4a6-4691-8dda-dad18a4f2cad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
},
"job_status_id": "bebcfdbb-fc28-446c-9223-1f731dee3cc2",
"job_status_code": "sample string 11",
"db_address_id": "3363d0e6-b769-4fce-8bf3-8e955afb9b6b",
"contact_id": "2b754afc-7684-4393-b7d1-af6cca59261b",
"requested_by_company_id": "4b296d66-5b66-4de9-95e7-6b3147fab83f",
"requested_by_contact_id": "6410e304-10cb-4d1f-9440-b7f94dd31ef3",
"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-09-23T15:22:21.0640643+00:00",
"due_date": "2026-09-23T15:22:21.0640643+00:00",
"date_create": "2026-09-23T15:22:21.0640643+00:00",
"date_update": "2026-09-23T15:22:21.0640643+00:00",
"date_closed": "2026-09-23T15:22:21.0640643+00:00",
"suggested_user_id": "edc1c974-246d-4dac-8208-37e7e094139d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "78e495af-8bae-40f9-adf5-280b2fd75214",
"db_language_id": "15b76880-adf2-4776-81eb-e0836ac14e50",
"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-09-23T15:22:21.0640643+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eada6970-0971-4026-89c8-b49466758361",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6353745a-dcdd-4126-aa4d-35d4feb41dde",
"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": "691c661f-4432-41e5-8999-b952d413064a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "64081670-1522-406e-b2b2-999942ba6c0a"
},
"suggested_date_start": "2026-09-23T15:22:21.0640643+00:00",
"skill_id": "fcbe7b9c-1add-4c17-b358-7f69052ba6b5",
"skill_code": "sample string 32",
"skill": {
"id": "2f291b0e-b476-4ae1-8a01-1d496bb802b4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b9ef79aa-ab3e-498a-aa26-3104fcb3b837",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25fbb03b-6719-4ce2-8489-84f2e8722488",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d68e3262-2ad1-450c-bf9a-95147cb252f4",
"db_currency_id": "b224767c-b07b-465e-b95b-f144eb058e13",
"db_language_id": "06354a9a-a7fb-491c-b6c7-13c8a490c6fd",
"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-09-23T15:22:21.0640643+00:00"
},
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "40b8fbf4-9efa-4430-8baf-2126e0921d51",
"date_reported_by_company": "2026-09-23T15:22:21.0640643+00:00",
"id2": 36,
"company_id": "d1ab0f0e-a9c2-4996-ac7c-393e83fbcade",
"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": "00202737-e30c-4fef-b87c-f28158bda641",
"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-09-23T15:22:21.0640643+00:00"
},
"work_instruction_details_id": "0c9b9904-801b-4e58-b089-8afbd8dd8236",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e934dad1-7a57-42e6-bf61-a375d1052ed3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6a65acdf-3b3c-4a17-baca-fbb2367dbea2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T15:22:21.0640643+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": "1a227ba7-1d2d-42d0-8fd6-094573d55e65",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T15:22:21.0640643+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.