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": "1274d1ce-92ce-431c-9cbb-419f585e92b2",
"jobs_id": "886538d8-7388-4bcb-bb53-c8979e5c6395",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "629be081-409c-4855-91b6-5598d773e489",
"_parent_id": "b5da0c50-8518-4d44-9fca-05f597fc2c08",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "39cc8b57-3b57-43de-9065-95e6e582f9d8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2a461c35-bd75-4149-a5fb-c8a6c96f89ee",
"_parent_id": "448c0c48-dcad-47c5-bf92-49b6430f6995",
"root_parent_id": "b70edf50-79cc-4a03-a528-af915e51fa7c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d380d6fb-56f0-4d06-9cb2-24ef800cb0fa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f0d4c68c-9fac-4870-ac99-9d7a2977f3ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0e4b062a-9dbc-4480-874f-8e4953f8d1af",
"_parent_code": "sample string 6",
"sales_organization_id": "40adbadf-e425-498f-8559-d46b2f2e50a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
},
"equipment_model_id": "580d38f4-1e36-4a2b-83f8-a3cde6657916",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7ec39d2a-e73c-4ceb-883e-01a98ffde339",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "becf334e-c723-4d43-84f2-bfab6feb0a13",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d874bba4-30bb-409d-8d51-229ffb27d9be",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a225abbd-7279-455e-a0a6-c9fe8afe040d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
},
"equipment_family_id": "7db0fcf2-2f7c-4911-a110-f05c90800ffb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f0d4c68c-9fac-4870-ac99-9d7a2977f3ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0e4b062a-9dbc-4480-874f-8e4953f8d1af",
"_parent_code": "sample string 6",
"sales_organization_id": "40adbadf-e425-498f-8559-d46b2f2e50a9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
},
"date_in_production_since": "2026-06-02T01:13:21.2844128+00:00",
"date_out_of_production_since": "2026-06-02T01:13:21.2844128+00:00",
"date_end_support": "2026-06-02T01:13:21.2844128+00:00",
"sales_organization_id": "270c39b3-54af-47d4-a03c-87f095d73fd4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+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-06-02T01:13:21.2844128+00:00"
},
"project_status_id": "2797d93d-abe8-4d27-bbd8-95137f795781",
"project_status_code": "sample string 10",
"project_status": {
"id": "a19a4897-ca6a-419c-b9c5-247630769ab3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ecc18b5c-d903-483d-bd91-7a297269d00e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
},
"company_id": "a1fba88e-2371-4a19-95c2-ced9f550c9dc",
"company_code": "sample string 12",
"db_address_id": "8e716cf7-c6e8-4cda-85c7-bf96c3687c0a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "def0cf0a-0768-4b2c-8277-8d98f351f059",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "79547b72-d1eb-430c-bcfa-e5569c363e8f",
"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-06-02T01:13:21.2844128+00:00",
"date_create": "2026-06-02T01:13:21.2844128+00:00",
"date_update": "2026-06-02T01:13:21.2844128+00:00",
"updated_by_user_id": "ba9aafa8-61ba-4069-8f52-8913c4d62f3c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T01:13:21.2844128+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T01:13:21.2844128+00:00",
"date_last_job": "2026-06-02T01:13:21.2844128+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T01:13:21.2844128+00:00",
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00",
"is_mobile_installation": true
},
"job_type_id": "12e8816f-dc58-4460-b5f7-9ffad092240f",
"job_type_code": "sample string 7",
"job_type": {
"id": "794c0c78-9217-4d44-88ef-530c54f4224d",
"name": "sample string 2",
"sales_organization_id": "7c639663-bc8f-431a-b9d7-196f40e25ed7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00",
"code": "sample string 7"
},
"job_priority_id": "c53b03b8-f1ab-4969-b3f8-7fdefe6513e9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0e8de489-8809-4453-b644-2cdb346a4d71",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6232a19a-0d76-4f91-8414-24f87498df8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
},
"job_status_id": "3e874119-2eaf-4899-bfff-8736a26af649",
"job_status_code": "sample string 11",
"db_address_id": "8951930f-1b48-48ca-bb74-d8473ff8b134",
"contact_id": "fd1d248d-914f-4af6-9266-b345600794d5",
"requested_by_company_id": "4fec7119-41cd-4e19-b0a5-95c3afd59334",
"requested_by_contact_id": "3b4ce76d-cebe-4964-b7e9-1db992062203",
"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-06-02T01:13:21.2844128+00:00",
"due_date": "2026-06-02T01:13:21.2844128+00:00",
"date_create": "2026-06-02T01:13:21.2844128+00:00",
"date_update": "2026-06-02T01:13:21.2844128+00:00",
"date_closed": "2026-06-02T01:13:21.2844128+00:00",
"suggested_user_id": "9fb1c584-9849-4cec-a57f-257283eb61fd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b796375b-4aa9-42ef-9271-c05f3af8f0e6",
"db_language_id": "bff65d2e-103c-46e6-a3d8-8d6222d853e4",
"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-06-02T01:13:21.2844128+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "03e9d544-6d0f-4bb0-9ac0-072829c9c249",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "46abcec6-cbef-4a02-8ed0-e91872574400",
"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": "b3c29970-87d0-4436-984e-66c6f4b3b14e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "058333c1-072f-436d-a466-da788e98048a"
},
"suggested_date_start": "2026-06-02T01:13:21.2844128+00:00",
"skill_id": "fda87729-661c-4e31-8156-9927005c94aa",
"skill_code": "sample string 32",
"skill": {
"id": "b55a0bd7-4cbd-4b40-8608-937418866e57",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "21e10222-aab7-4aa8-a969-a4069059b355",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e91d4b35-f2d1-42ce-b235-5bd701246d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a8f0a14-16e0-4697-b72f-6f9d7853515a",
"db_currency_id": "170205be-24b6-497c-b724-6eda23492a80",
"db_language_id": "bf81bcd0-23f2-4e80-a514-9f7aeb006422",
"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-06-02T01:13:21.2844128+00:00"
},
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "51e64dbf-3e85-4b5e-b163-98920a24da11",
"date_reported_by_company": "2026-06-02T01:13:21.2844128+00:00",
"id2": 36,
"company_id": "22a71cfc-ff3d-4929-aedd-c3c75f33cfdf",
"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": "9900896a-c292-4be0-a787-bb45b0a4f19f",
"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-06-02T01:13:21.2844128+00:00"
},
"work_instruction_details_id": "608b574f-7ddc-4e3e-9a5b-d63ccbe65006",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5c8d7774-c226-49f2-bdff-8a45554412de",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b9ccf69a-064a-4d81-8193-26ff483d7b0a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T01:13:21.2844128+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": "73a11d09-c077-4b06-8931-ab5e8980fefb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T01:13:21.2844128+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.