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": "bfa9ec38-f596-4be6-8fb9-29227789cb93",
"jobs_id": "3074bf1d-ac41-4834-bd00-cbd1a8d919eb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5e1c01b7-5277-4049-8b65-0e7800e7d062",
"_parent_id": "780b96d4-8ff4-4140-9f2a-f2787d697bf1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7889f42f-a614-4547-9a4f-f0404d88dec6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d8161ecf-237a-46dd-8167-88b23a5db435",
"_parent_id": "9123f191-7625-4e6a-ab5c-b0788ac281b9",
"root_parent_id": "3552519b-2539-4ada-8500-a3ee6f6eaa1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8e55681e-9c27-49f5-9e46-0fc238496012",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aa3ab66d-1ae9-4b8a-9a0f-18b48098db1c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01759c6c-50c1-4acb-907f-82c4cd45967b",
"_parent_code": "sample string 6",
"sales_organization_id": "14db59f5-f1e1-410b-a39f-115ef238c170",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"modified_dateutc": "2025-10-11T10:03:09.3029359+00:00"
},
"equipment_model_id": "96b0ab3f-897b-4e8e-895d-310dfcabf1cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "069c1844-4e5d-40f4-936e-9167087385f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dfe93ead-a92e-4392-a467-6e89bc3878b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "436da7c4-1936-4ff3-abf8-71abaac7b6f8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a6542c69-9563-4893-b1e3-024531e9fad3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"modified_dateutc": "2025-10-11T10:03:09.3029359+00:00"
},
"equipment_family_id": "ae966956-69e9-4402-aeae-83c10f1d3813",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aa3ab66d-1ae9-4b8a-9a0f-18b48098db1c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "01759c6c-50c1-4acb-907f-82c4cd45967b",
"_parent_code": "sample string 6",
"sales_organization_id": "14db59f5-f1e1-410b-a39f-115ef238c170",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"modified_dateutc": "2025-10-11T10:03:09.3029359+00:00"
},
"date_in_production_since": "2025-10-11T10:03:09.3185549+00:00",
"date_out_of_production_since": "2025-10-11T10:03:09.3185549+00:00",
"date_end_support": "2025-10-11T10:03:09.3185549+00:00",
"sales_organization_id": "b435b9e6-7321-4908-957b-320d8b514dcb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+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-10-11T10:03:09.3185549+00:00"
},
"project_status_id": "a881a23d-3b77-45d0-9d79-e7eb8dd809f0",
"project_status_code": "sample string 10",
"project_status": {
"id": "00e3ab07-dd27-4782-9e8f-a4cb893812d2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a2986abe-4efa-4b87-a5e6-caf9cffda50d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00"
},
"company_id": "aa0596e2-2215-453a-b72d-2bbc2ac82631",
"company_code": "sample string 12",
"db_address_id": "40ecb99c-1853-4342-9d4c-b981dcad0abc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4459bec6-2a05-4b3c-b9d3-ef62aca606d0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a84a6e37-5a86-4d2c-a01e-0cbe0fe38168",
"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-10-11T10:03:09.3185549+00:00",
"date_create": "2025-10-11T10:03:09.3185549+00:00",
"date_update": "2025-10-11T10:03:09.3185549+00:00",
"updated_by_user_id": "9b2d2375-83a1-4d1d-84cd-b10e3138df3a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-11T10:03:09.3185549+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-10-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-11T10:03:09.3185549+00:00",
"date_last_job": "2025-10-11T10:03:09.3185549+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-11T10:03:09.3185549+00:00",
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00",
"is_mobile_installation": true
},
"job_type_id": "9a977ba9-d861-4eff-b8c3-59201d8ff126",
"job_type_code": "sample string 7",
"job_type": {
"id": "31650265-8d52-4884-b9eb-880a5cd17e31",
"name": "sample string 2",
"sales_organization_id": "abdd1b2d-32d0-436d-a9e2-f82320ea184a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00",
"code": "sample string 7"
},
"job_priority_id": "5a816f70-71fc-49f5-b80a-c5ef40c08015",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b85727c-81d7-4298-970e-c7beca2f0b01",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7d4ca7c7-1060-482f-bb33-c32ae720cd26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00"
},
"job_status_id": "d85bd192-072f-46c4-bad9-61f4c0658f13",
"job_status_code": "sample string 11",
"db_address_id": "f4a1d58c-e4f6-4a99-aa87-994adfc05c00",
"contact_id": "43584430-500c-4d4d-97b7-d70429e27f20",
"requested_by_company_id": "a629d79e-347b-4a36-b2cd-cff96d0ea653",
"requested_by_contact_id": "b19b760f-56cd-4193-a819-a5c4589780a6",
"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-10-11T10:03:09.3185549+00:00",
"due_date": "2025-10-11T10:03:09.3185549+00:00",
"date_create": "2025-10-11T10:03:09.3185549+00:00",
"date_update": "2025-10-11T10:03:09.3185549+00:00",
"date_closed": "2025-10-11T10:03:09.3185549+00:00",
"suggested_user_id": "9dd4f952-d1d8-49ea-a4fd-b3de0f627be1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f24a6588-2c1b-48a7-9bd7-386db544ade5",
"db_language_id": "a8cb9b4e-8f3d-40ff-b365-7c39f88fde62",
"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-10-11T10:03:09.3185549+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5c81d301-57e0-4502-ba65-37e731631db0",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2748097d-3215-4236-b7a2-160cccd79d82",
"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": "37d16816-8392-4ca1-9995-9b015d5b720f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0ccac8a6-8428-4563-8ab6-c3b614ba6af1"
},
"suggested_date_start": "2025-10-11T10:03:09.3185549+00:00",
"skill_id": "17fbc659-bb44-4a32-bda2-ac3db0333ee2",
"skill_code": "sample string 32",
"skill": {
"id": "293fe1d7-abeb-4a80-bced-6130286d1c6d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "89675dda-af38-472b-a7c3-e760667b4427",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d1ae10ab-6841-4238-928d-46a0c0080a66",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ba9f1a6-3a7d-4d27-a104-18a1cd05577a",
"db_currency_id": "98bc06a2-ee1b-4457-bc97-ee321d7d705a",
"db_language_id": "a38a5ebb-51bc-4cbc-ba33-6b214e885179",
"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-10-11T10:03:09.3029359+00:00"
},
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "781aa22c-fbb4-4716-811f-7fa8e8843afc",
"date_reported_by_company": "2025-10-11T10:03:09.3185549+00:00",
"id2": 36,
"company_id": "e4e916d4-7a45-4353-87ce-378d0bf32724",
"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": "087544f7-ef64-49fb-8bdb-fd33990d085e",
"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-10-11T10:03:09.3185549+00:00"
},
"work_instruction_details_id": "9ebd3f65-9c6d-4ff3-a1c3-1709eef2ad6f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9534cf07-fccb-43a0-ba5c-2baa6d83bdb9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d08bcd55-d9ba-493d-8522-e8095d4dd2bd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-11T10:03:09.3185549+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": "0964254a-e3d2-4d84-b9c8-fcfd26042103",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-11T10:03:09.3185549+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.