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": "c3390420-aacf-4aca-8997-c319a3b5b542",
"jobs_id": "d2188a85-bfaf-4cf0-975d-f1e9c449df3c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e1f5c57a-375a-49f8-a016-72213e758f8e",
"_parent_id": "a2c7f6f6-92d4-4956-bfb1-93aa3608c2b4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9cd469ce-b730-4ddc-9135-9ff2e33132fd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "70f8b52d-c2d7-43d1-ae1a-2f9d4815cc84",
"_parent_id": "912e2596-fd53-4ccd-9da2-8a401bb39310",
"root_parent_id": "9fd0d6e2-6013-47e6-b39f-7551b3d86341",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4aad3f00-c65d-459f-bc87-d09bdc82c895",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0f6b68c2-fd5b-4a3e-a2db-88de56696bc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bab0ac0d-364f-4997-a2df-727168a1546e",
"_parent_code": "sample string 6",
"sales_organization_id": "1a6238d7-e754-49e2-8973-32c335b36b81",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
},
"equipment_model_id": "277fd685-a57a-413d-831d-0867e20f1fbb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "efb56e74-8352-4ec6-959d-9d9d0975d76c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a7149782-580b-4dbe-93a8-54361b41a1f1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "296f4513-025f-4768-81f1-ba53fb334002",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "39ee728e-9353-4998-b8ec-9994b6b33bf1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
},
"equipment_family_id": "ba1a00b4-44df-4b72-8161-22159280ac91",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0f6b68c2-fd5b-4a3e-a2db-88de56696bc8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bab0ac0d-364f-4997-a2df-727168a1546e",
"_parent_code": "sample string 6",
"sales_organization_id": "1a6238d7-e754-49e2-8973-32c335b36b81",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
},
"date_in_production_since": "2026-09-21T07:04:55.2376698+00:00",
"date_out_of_production_since": "2026-09-21T07:04:55.2376698+00:00",
"date_end_support": "2026-09-21T07:04:55.2376698+00:00",
"sales_organization_id": "8aba7f80-0420-4f24-9852-5676d3859fff",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+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-21T07:04:55.2376698+00:00"
},
"project_status_id": "10b7bd2f-5f27-4a57-8539-f40d6a9d6e8b",
"project_status_code": "sample string 10",
"project_status": {
"id": "4695d001-e2ce-42e9-945a-f142bcb0b2a4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dd413c1b-850a-4056-b8a6-00ec0dec7d2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
},
"company_id": "b69540d6-c09a-4da6-8128-3c2c7cac73d4",
"company_code": "sample string 12",
"db_address_id": "6c4807d8-c4eb-40cb-b980-38b91c27f5d7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e20d2c0a-280c-4669-8d95-359af9b97559",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "caeb86da-9928-42f4-9f25-320a0010cebe",
"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-21T07:04:55.2376698+00:00",
"date_create": "2026-09-21T07:04:55.2376698+00:00",
"date_update": "2026-09-21T07:04:55.2376698+00:00",
"updated_by_user_id": "2b0bd43c-cabd-4d1b-8d89-b6060a6542aa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-21T07:04:55.2376698+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-21T07:04:55.2376698+00:00",
"date_last_job": "2026-09-21T07:04:55.2376698+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-21T07:04:55.2376698+00:00",
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00",
"is_mobile_installation": true
},
"job_type_id": "f4f50e0a-1fd5-4af6-83e9-ef91447acfb0",
"job_type_code": "sample string 7",
"job_type": {
"id": "542530e7-de38-42ea-ba8b-b9a91b78cc3e",
"name": "sample string 2",
"sales_organization_id": "7925179b-7030-4589-8193-8053c7e6b7a6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00",
"code": "sample string 7"
},
"job_priority_id": "ee9e838c-56d6-4496-b7c1-8e955feb2e79",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "15d12cf4-d5fa-459d-a0a1-ca42ec53af0a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c29a2641-ce6c-4b26-bdb6-b135f3e74d8e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
},
"job_status_id": "ca8ef336-736a-4f0c-81c0-0ecbb0454c0e",
"job_status_code": "sample string 11",
"db_address_id": "16af4c1f-9230-4384-8ea7-2fefc05ad720",
"contact_id": "364fb30b-50a4-4ec1-8488-183b26fcbe30",
"requested_by_company_id": "e70c0266-ce8a-425d-abb6-51767af42e7e",
"requested_by_contact_id": "09fad016-1cc3-4f74-9fd4-1712a3fb4f6c",
"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-21T07:04:55.2376698+00:00",
"due_date": "2026-09-21T07:04:55.2376698+00:00",
"date_create": "2026-09-21T07:04:55.2376698+00:00",
"date_update": "2026-09-21T07:04:55.2376698+00:00",
"date_closed": "2026-09-21T07:04:55.2376698+00:00",
"suggested_user_id": "d53f5d10-14f6-43bd-971a-5dcac3945b65",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b3b9b5c3-7b71-4e1e-91ff-e9240c602f5f",
"db_language_id": "0c776f4a-c9a5-4e8b-9369-6b1a2434766e",
"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-21T07:04:55.2376698+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1dd7f4d0-4cd7-4cae-a41c-67b3a32dac94",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "df8442c1-35f6-42e8-bdeb-39e6c231e3e0",
"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": "0007ab2f-e641-4ee3-b36c-6b4e1944c4a1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a744e1b4-391e-45a9-8717-1c6884686d41"
},
"suggested_date_start": "2026-09-21T07:04:55.2376698+00:00",
"skill_id": "d9310227-baf2-4a9b-aa32-1ee42377077e",
"skill_code": "sample string 32",
"skill": {
"id": "8c3bbf85-4c66-4b69-935e-141794d69db9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4816ba8f-438f-4340-a9fb-dc11efa62104",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fca30223-5fb1-457f-a753-cfd46a8d1a13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9362be5-4b92-4ca4-b7f6-260a722903dd",
"db_currency_id": "2327eae6-1229-42f0-86a0-3139061fa3ee",
"db_language_id": "09c1e7aa-f967-49b1-af2e-4f9312b1c137",
"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-21T07:04:55.2376698+00:00"
},
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cb49d629-c104-456d-953e-b09d2906aa4c",
"date_reported_by_company": "2026-09-21T07:04:55.2376698+00:00",
"id2": 36,
"company_id": "3bb3cd6f-91e0-4702-b355-2e98c627a33c",
"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": "c644e448-a9d0-47bd-b1f8-355a9c9a84bc",
"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-21T07:04:55.2376698+00:00"
},
"work_instruction_details_id": "4aa0747c-282a-4dc2-9ade-6824227ef0bd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fa87a764-0faa-426a-bcf8-c5338bda8882",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "65c2c0ed-059c-4e6b-9f59-569065254209",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-21T07:04:55.2376698+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": "8e80f9a3-f9e7-42a1-9778-be4257a073b9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-21T07:04:55.2376698+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.