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": "5c757a05-3088-430a-83ae-6a4f0fb8983e",
"jobs_id": "86bddd98-ad99-4818-881f-6c7d5f31339c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0522787e-5d62-41e6-bda3-de602e37eb69",
"_parent_id": "d8f3427a-36a9-4efe-9af4-9f4a9d2831ea",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b92b7244-340c-462b-9614-f228af2ba694",
"project_reference_back_office": "sample string 5",
"project": {
"id": "198c7032-1336-4d65-829b-0d6c748eef27",
"_parent_id": "3b845aef-cdf9-42ee-8721-91c23d4a3ce4",
"root_parent_id": "76484abf-b17d-4240-bc76-0f1013e17d40",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "63ebecfd-7618-4123-834c-76d86a57880c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a88840fe-d0a6-4e4c-9e42-70449ecb17f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aaf512e1-4111-4f52-bbb5-e5f6d5d86fb4",
"_parent_code": "sample string 6",
"sales_organization_id": "6cbc5b29-811f-4239-920b-565ee491bcc4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
},
"equipment_model_id": "7b5aa296-fdcc-40ea-be40-87207e2b6ebf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bedcb97f-ca8a-43e2-9746-9f20b67d6a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2f93c04f-8c57-443f-a686-ac2d9cc767c1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7c74ef7f-581b-4658-bdbb-592a98439400",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5fc725b8-aa0b-459d-a38b-795e7ad1bdb3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
},
"equipment_family_id": "7f8fac2b-0ce2-4937-b616-ca2401dcaeb3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a88840fe-d0a6-4e4c-9e42-70449ecb17f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aaf512e1-4111-4f52-bbb5-e5f6d5d86fb4",
"_parent_code": "sample string 6",
"sales_organization_id": "6cbc5b29-811f-4239-920b-565ee491bcc4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
},
"date_in_production_since": "2025-12-22T18:57:41.9626059+00:00",
"date_out_of_production_since": "2025-12-22T18:57:41.9626059+00:00",
"date_end_support": "2025-12-22T18:57:41.9626059+00:00",
"sales_organization_id": "762d950c-a5ad-4b5e-b49c-9924bb86ffac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+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-12-22T18:57:41.9626059+00:00"
},
"project_status_id": "00cbf56f-8097-42b8-ba04-716bc3b71701",
"project_status_code": "sample string 10",
"project_status": {
"id": "c2fe3bdc-bcc0-4723-9d49-6ecc1fce1287",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "91e32aff-4ca2-448b-9b8d-f94fb10af206",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
},
"company_id": "482a7840-6806-4da0-91c6-7309bad4cae4",
"company_code": "sample string 12",
"db_address_id": "b427d049-2152-4e28-8bf0-df0b4c0aa943",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "20e3d732-3343-479b-9774-7914f75e857e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a901e1ef-2880-45c6-bfb6-13792d49ad44",
"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-12-22T18:57:41.9626059+00:00",
"date_create": "2025-12-22T18:57:41.9626059+00:00",
"date_update": "2025-12-22T18:57:41.9626059+00:00",
"updated_by_user_id": "9e7bc870-b95b-46cf-8f98-34a0a6c2ef14",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-22T18:57:41.9626059+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-12-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-22T18:57:41.9626059+00:00",
"date_last_job": "2025-12-22T18:57:41.9626059+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-22T18:57:41.9626059+00:00",
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00",
"is_mobile_installation": true
},
"job_type_id": "ba24ff58-cce9-47f3-ba09-d8d265ed8345",
"job_type_code": "sample string 7",
"job_type": {
"id": "84608f9b-4e10-4bf3-ad02-4a54a5801829",
"name": "sample string 2",
"sales_organization_id": "bc1cabee-12b7-4f50-8113-b2bd2c1002d7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00",
"code": "sample string 7"
},
"job_priority_id": "0c6fde2a-41ac-4211-b389-ec77d4a69fd2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6496f3bb-1225-4ed6-bf5f-ff5973d76dec",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "de6b13e4-76fc-405c-a55d-1f6816e9176d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
},
"job_status_id": "c45608c7-c2d3-4b00-af96-90d790728c5d",
"job_status_code": "sample string 11",
"db_address_id": "96fe567b-894a-4c3a-8a0a-3e8cd3052d0c",
"contact_id": "43822df9-5166-4b8a-bd8f-339b6b2c024d",
"requested_by_company_id": "fc50e981-3889-4fed-8d2e-1fcd9e20fd16",
"requested_by_contact_id": "ac7a2043-5dfb-4c76-a98d-e90b803e3944",
"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-12-22T18:57:41.9626059+00:00",
"due_date": "2025-12-22T18:57:41.9626059+00:00",
"date_create": "2025-12-22T18:57:41.9626059+00:00",
"date_update": "2025-12-22T18:57:41.9626059+00:00",
"date_closed": "2025-12-22T18:57:41.9626059+00:00",
"suggested_user_id": "eccc4225-466b-4367-997b-b9c9cd4b3981",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "291f6706-9ca7-4dc5-a908-d8d4012e9c61",
"db_language_id": "77e8c61d-ecc4-4c3c-9fdc-e4cea72df7a7",
"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-12-22T18:57:41.9626059+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7ff0877f-cb1c-4a8e-a9b3-395cf53d793b",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5b9f95a9-2a20-4a2c-b809-08b5058d6b49",
"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": "f090f032-e1ab-4a6f-8d62-1bffd1b71dcf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "369dbcf1-e969-4274-8d47-06a4cb868214"
},
"suggested_date_start": "2025-12-22T18:57:41.9626059+00:00",
"skill_id": "41a5bf83-189e-4306-823a-d6a3daff1619",
"skill_code": "sample string 32",
"skill": {
"id": "5beac05c-2bea-498d-bbb8-fe0cc2096c8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0009a38f-e89f-46d0-a182-1677f0fcaf4e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a79c111-abe4-45aa-85c8-9830dec9c6fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cd0071f-ab84-4fc7-b071-149514dd9d33",
"db_currency_id": "bf017e9f-4785-457f-b45c-9d23be58efcc",
"db_language_id": "efe27dbe-568f-4f9f-83b8-5b3e36185ff1",
"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-12-22T18:57:41.9626059+00:00"
},
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2680f4f5-08e8-433f-977d-baef01d3680e",
"date_reported_by_company": "2025-12-22T18:57:41.9626059+00:00",
"id2": 36,
"company_id": "a2b46924-cd6e-40a3-9ea2-a8e2a41ff26e",
"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": "6453422a-a729-4119-b666-6b87cdc03df8",
"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-12-22T18:57:41.9626059+00:00"
},
"work_instruction_details_id": "c2296672-a373-4cc8-97d9-35b8eb870d2f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a5db8814-22f2-4b85-bdc2-e8d3333278a8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d0917dee-54f5-4cc5-91e9-c971aaafbe8a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-22T18:57:41.9626059+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": "86ac4436-5936-46f3-9df6-723d4fca2732",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-22T18:57:41.9626059+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.