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": "a5d2660a-1a58-41b3-b15f-a5cca99b9ddf",
"jobs_id": "a475c394-0cdd-4bcf-b208-f8f708c5dc6a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4da394a8-3d44-4913-b6f8-57967d9eacdc",
"_parent_id": "01f56ad3-d3e4-4d06-957c-24c343d20fcb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5f32436d-1729-4e79-9f5a-ea232abab86a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "044a4312-765d-4005-8bff-c89b15ad05f0",
"_parent_id": "bcc5f38a-fe38-45c8-bbc2-05cafafaf12a",
"root_parent_id": "19908485-c01f-45b1-aab5-83ace693b90b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "33c8d644-5756-4de8-b163-c0de934804a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "72d60496-d38b-4ecc-8c0d-de75d94f75ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2efbfb88-c603-4989-bacc-27cc4ba1f021",
"_parent_code": "sample string 6",
"sales_organization_id": "c845aca9-2dae-4408-946c-d41069d0cb34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
},
"equipment_model_id": "f7280bb5-9d48-46f7-8449-bb417d061219",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "baf2e85e-56de-48ce-b899-bc5068d55108",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "74afceb0-02f3-4d73-9512-0a1f679bf7ab",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "877db6b5-7d2d-47f9-a09f-bc846725d7a7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "991146b9-9fca-408f-bfd7-632e56ed667e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
},
"equipment_family_id": "d1b69bc2-c141-4e61-9bf6-4ff0e8cf6cf1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "72d60496-d38b-4ecc-8c0d-de75d94f75ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2efbfb88-c603-4989-bacc-27cc4ba1f021",
"_parent_code": "sample string 6",
"sales_organization_id": "c845aca9-2dae-4408-946c-d41069d0cb34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
},
"date_in_production_since": "2026-09-07T20:23:23.2561689+00:00",
"date_out_of_production_since": "2026-09-07T20:23:23.2561689+00:00",
"date_end_support": "2026-09-07T20:23:23.2561689+00:00",
"sales_organization_id": "5d0e9087-913f-4fe9-a79b-9883f74708a1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+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-07T20:23:23.2561689+00:00"
},
"project_status_id": "82cb8234-7180-4341-9bd0-ad5c4e7213b6",
"project_status_code": "sample string 10",
"project_status": {
"id": "4a9b05b3-2899-4136-b044-a79b4f13581c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "88410aaa-08aa-42f8-b687-661c91472dca",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
},
"company_id": "5515eee5-d22a-44c1-8af7-becf4cbb3cff",
"company_code": "sample string 12",
"db_address_id": "ee7167ce-acc9-45b0-a4d3-649db1673ef4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7cbd5670-ea39-4028-8446-977f19ea5d82",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "78ad10c1-5a70-4857-9477-f6a2c2cf8d4d",
"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-07T20:23:23.2561689+00:00",
"date_create": "2026-09-07T20:23:23.2561689+00:00",
"date_update": "2026-09-07T20:23:23.2561689+00:00",
"updated_by_user_id": "52d44102-500c-4b2b-b897-b3b565e7ebcf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-07T20:23:23.2561689+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-07T20:23:23.2561689+00:00",
"date_last_job": "2026-09-07T20:23:23.2561689+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-07T20:23:23.2561689+00:00",
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c16e812-9ac0-49c4-8ed0-6abd0cea06f1",
"job_type_code": "sample string 7",
"job_type": {
"id": "50b05ebb-f470-432e-bad7-1c8683ef75a9",
"name": "sample string 2",
"sales_organization_id": "520b29da-6bbd-4923-9ac6-01336a069df0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00",
"code": "sample string 7"
},
"job_priority_id": "9538627e-fa96-42d2-a901-e50ede1e0ea1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "71b3bb62-3f02-400f-9189-13beb61b4f56",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "146fe523-229f-401e-82bc-caa918e055ef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
},
"job_status_id": "06b9bd69-327a-4ba7-b450-75f7957c132b",
"job_status_code": "sample string 11",
"db_address_id": "3a6eafc1-466b-40aa-9a8b-3bafadfc5056",
"contact_id": "4a301d6d-d1d0-476b-a2c4-6483c7d3bd17",
"requested_by_company_id": "e8f99eab-9db4-4ebe-9dbc-4a615eefa159",
"requested_by_contact_id": "2d2b57e3-39ee-4478-9fee-bda285f4b324",
"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-07T20:23:23.2561689+00:00",
"due_date": "2026-09-07T20:23:23.2561689+00:00",
"date_create": "2026-09-07T20:23:23.2561689+00:00",
"date_update": "2026-09-07T20:23:23.2561689+00:00",
"date_closed": "2026-09-07T20:23:23.2561689+00:00",
"suggested_user_id": "470ada78-d6eb-4255-870a-ec6428351d64",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e6024826-ac28-4eda-a7cf-279faf63ea4e",
"db_language_id": "9d38cc90-42d7-4798-9367-00655ebe6447",
"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-07T20:23:23.2561689+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ca9363eb-1b84-4edc-b645-928f2f5e6c78",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b1d6177a-27ad-4f59-b1c2-8506ea75842e",
"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": "19e0e716-0e3c-448e-a74a-8c91772779fe",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c586c0d2-7c0b-4f2b-a8ea-734e22fbb4b8"
},
"suggested_date_start": "2026-09-07T20:23:23.2561689+00:00",
"skill_id": "e1281ba7-a8bd-4adc-9829-5e9d10e604b3",
"skill_code": "sample string 32",
"skill": {
"id": "0aee6f11-c9f3-469c-9943-602a4fb4e7c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "41ac7b7f-6ce5-4e6a-913d-118421ca2f58",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63c224e7-476e-4203-9425-8ba8536589c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5429fe0d-6cef-46dd-a8c3-6959efb423b6",
"db_currency_id": "03ae9ddc-a6a2-46fa-b5b0-872ad2254cae",
"db_language_id": "516c20ef-5349-490a-bc0e-a3c532566238",
"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-07T20:23:23.2561689+00:00"
},
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e18d1d72-d9e3-474c-b909-53ead148888d",
"date_reported_by_company": "2026-09-07T20:23:23.2561689+00:00",
"id2": 36,
"company_id": "b5507229-931c-46df-9d7e-c006a8c05682",
"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": "5c8116fc-e8bf-415b-b0ad-ce011d65840b",
"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-07T20:23:23.2561689+00:00"
},
"work_instruction_details_id": "28668ede-23d0-4c9e-81c5-21a51e236527",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b2f9e2f4-a9b5-4dfe-9b42-8a767cf880d6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8cd8d52a-d563-467d-9c1a-e164c5f0f0ce",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-07T20:23:23.2561689+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": "789958d6-d452-4cad-bca9-de746c2fe865",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-07T20:23:23.2561689+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.