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": "9b1f6947-95ef-4062-9490-753719b9889b",
"jobs_id": "710aab23-227c-4ef0-95f6-d2095c166420",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b6303ee4-851b-4edd-aea5-867b43bb3e2e",
"_parent_id": "cd26c4f5-0da4-4b5d-8282-ea5245a8d1a8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bde60128-d9fc-4d0d-88de-d35a70f4a8d5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fa7edd12-35c2-431c-8ae7-9e738e74d769",
"_parent_id": "3a1b0fbb-3358-4360-93aa-cff0fd4d5d72",
"root_parent_id": "45b118a0-9cbc-4a10-bc9f-aa553c8cfb15",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3f0fd1e7-5d33-4bde-8ec8-e5869dabbbf4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0f914d9d-349b-4db0-80d1-e58e32f72795",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4bce9292-1227-4dea-91aa-c184a58d01ab",
"_parent_code": "sample string 6",
"sales_organization_id": "04812a45-93bf-44e7-8c88-2c6ba74db04a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
},
"equipment_model_id": "95fa89f2-4634-42b1-867a-8f9f8b485d2f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5b0cf9f4-45fd-48dc-b609-47923506c5ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "487a97ed-4bf4-41b6-9bf0-d3337d3aaf3c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8b26a96c-2e72-4cb2-8a63-84c7d9cda9ab",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ef55a98b-0202-403f-b9ac-e887bde70732",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
},
"equipment_family_id": "2cd7bd95-0ec0-4f03-97ca-c74f9e42bf86",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0f914d9d-349b-4db0-80d1-e58e32f72795",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4bce9292-1227-4dea-91aa-c184a58d01ab",
"_parent_code": "sample string 6",
"sales_organization_id": "04812a45-93bf-44e7-8c88-2c6ba74db04a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
},
"date_in_production_since": "2026-04-09T10:30:53.2720523+00:00",
"date_out_of_production_since": "2026-04-09T10:30:53.2720523+00:00",
"date_end_support": "2026-04-09T10:30:53.2720523+00:00",
"sales_organization_id": "ef1d86b4-449d-450c-bbf2-3fbee3c1bbc4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+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-04-09T10:30:53.2720523+00:00"
},
"project_status_id": "5bec93f2-557a-4fcb-af4b-20404d91793d",
"project_status_code": "sample string 10",
"project_status": {
"id": "8d5bc49d-ed8b-4ced-9e57-15a74472ec29",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e2f9f36e-5af0-4f19-9688-01b11f776adf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
},
"company_id": "f053222a-9bc2-497d-a6c6-5d57781944e1",
"company_code": "sample string 12",
"db_address_id": "657dfb8a-f931-4b9c-b4dc-9dc1eb861214",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b1b1f030-781c-4aee-9c36-aff584598df4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8c97d463-bbbd-41d0-888b-a5df5f0ef234",
"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-04-09T10:30:53.2720523+00:00",
"date_create": "2026-04-09T10:30:53.2720523+00:00",
"date_update": "2026-04-09T10:30:53.2720523+00:00",
"updated_by_user_id": "aaa0b6c5-7b4d-4b6c-9205-bcff387bcc67",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-09T10:30:53.2720523+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-04-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-09T10:30:53.2720523+00:00",
"date_last_job": "2026-04-09T10:30:53.2720523+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-09T10:30:53.2720523+00:00",
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00",
"is_mobile_installation": true
},
"job_type_id": "836080f3-7a00-41e9-9a9f-f401a751f297",
"job_type_code": "sample string 7",
"job_type": {
"id": "57146541-3f3e-4499-a08f-a73dc6c792c4",
"name": "sample string 2",
"sales_organization_id": "f1713437-58d9-4c2c-8ff5-9d388131b35c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00",
"code": "sample string 7"
},
"job_priority_id": "544fdca4-21cd-4d5c-8a46-73d48c353cda",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a62e7e3e-3e38-4221-931d-bd1c8decf58b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "df9d5e13-8657-435c-a35b-8b98ac2fa8c7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
},
"job_status_id": "13828647-ef6b-4135-b00f-0c3cac76d2ca",
"job_status_code": "sample string 11",
"db_address_id": "ee75d845-7893-4f49-b552-4783332e9d63",
"contact_id": "b84b410a-b458-4323-972d-f89e12fc621e",
"requested_by_company_id": "8dc28c0a-eb21-47c1-816d-f55a7f721700",
"requested_by_contact_id": "830b5080-28fc-4e88-a95a-6406cc8f98be",
"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-04-09T10:30:53.2720523+00:00",
"due_date": "2026-04-09T10:30:53.2720523+00:00",
"date_create": "2026-04-09T10:30:53.2720523+00:00",
"date_update": "2026-04-09T10:30:53.2720523+00:00",
"date_closed": "2026-04-09T10:30:53.2720523+00:00",
"suggested_user_id": "4a5798a0-e0bb-452c-99d3-6c5657eee0e1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b26fd15b-1360-4ca2-af7a-4255d9124c8d",
"db_language_id": "4cfdf0b0-5b81-4b58-8a9a-18e78e933a98",
"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-04-09T10:30:53.2720523+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1c20198e-ec8b-468e-9e9e-58b1abc08fd0",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c10b3d98-ed8c-48ae-8e26-48f75a452c0c",
"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": "0437d665-3f95-428c-a728-ea3c7a278612",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3d61d171-ba89-4107-b3a9-ec9108dcef79"
},
"suggested_date_start": "2026-04-09T10:30:53.2720523+00:00",
"skill_id": "c1c09715-c8ad-4ec7-a044-4875a3eeb383",
"skill_code": "sample string 32",
"skill": {
"id": "fd9bb81f-ea05-4042-b45c-937cec8c7aa3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7407f2f6-698f-411a-a175-871596783f09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18ff5056-801e-4f02-8d95-5d7afa1659d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9771a2e3-1d44-4161-af6e-fb314afebc0c",
"db_currency_id": "a2effd11-e26b-48f4-92ad-acceb1601216",
"db_language_id": "c01d4623-941e-45d0-af27-f399f4e6223c",
"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-04-09T10:30:53.2720523+00:00"
},
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5f93b022-7e2a-4c09-b36d-85705cb0b818",
"date_reported_by_company": "2026-04-09T10:30:53.2720523+00:00",
"id2": 36,
"company_id": "da039216-c13f-4600-b83d-7edded7dc17a",
"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": "b598f4f1-2dbb-4b02-8b97-eac81926a927",
"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-04-09T10:30:53.2720523+00:00"
},
"work_instruction_details_id": "18611432-7300-4f51-833a-60d5ca3f3752",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bd84a20d-3346-4d15-9ae4-8b08bd053572",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "598a56e7-f3de-49cb-9647-217ca02fcd14",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-09T10:30:53.2720523+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": "f0da5516-b65b-4557-867c-f90e53639c71",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-09T10:30:53.2720523+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.