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": "4fc1fe77-bbac-4fe3-b2b1-8683470eee2f",
"jobs_id": "fa7ed9d6-3054-4eb0-ac9e-810e1f215c9b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d4f73601-125c-440f-84a2-0cc54bfcaebd",
"_parent_id": "686a9b5e-8c78-4be4-811a-b19e2bc2ad8d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf268a38-17a4-42b6-8166-368d3007d716",
"project_reference_back_office": "sample string 5",
"project": {
"id": "89ff40f5-b159-42f7-ac70-47e2f6e10182",
"_parent_id": "41bc79fa-c576-4232-9e53-86656f446d3e",
"root_parent_id": "94f70470-0b6d-4cd5-98d9-0fe868fce553",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "201e6312-6581-4c93-bcf4-af2c0053508d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6a0480ec-deaa-499d-9a30-734ae7a14683",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b16b993-f5f1-463a-bd07-1818945f2ef8",
"_parent_code": "sample string 6",
"sales_organization_id": "79f0ca76-cec7-4ada-b637-ab43b0cee246",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00"
},
"equipment_model_id": "0b18c86a-effb-41d4-a8b7-2d199fbf64a0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b4b30de0-2661-483e-944d-6c54d2900463",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e95f5413-a953-452e-9c5c-1b4f3172876d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bda779ba-4848-40af-b897-9b210c6390fc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3ed27d1e-093d-4fad-afcc-73cc60a32211",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00"
},
"equipment_family_id": "d1b8bc2b-fcdd-4adb-9b74-c4ccbe07e2af",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6a0480ec-deaa-499d-9a30-734ae7a14683",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b16b993-f5f1-463a-bd07-1818945f2ef8",
"_parent_code": "sample string 6",
"sales_organization_id": "79f0ca76-cec7-4ada-b637-ab43b0cee246",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00"
},
"date_in_production_since": "2026-08-01T05:16:58.1117982+00:00",
"date_out_of_production_since": "2026-08-01T05:16:58.1117982+00:00",
"date_end_support": "2026-08-01T05:16:58.1117982+00:00",
"sales_organization_id": "42292cc9-1461-42d0-b607-a49f16fff88c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+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-08-01T05:16:58.1117982+00:00"
},
"project_status_id": "37010c61-b0bf-43ef-a26b-3b4e1efe7705",
"project_status_code": "sample string 10",
"project_status": {
"id": "617c8b50-c5b9-4b03-a5de-5a7812ee1344",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "54c59e3f-a25b-481a-bd3f-43313afec528",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00"
},
"company_id": "a3c46bb6-6be6-4101-af39-2035b6af4196",
"company_code": "sample string 12",
"db_address_id": "d50845e6-fd9a-4aa0-b600-81f9fba40d5a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0c37ec6c-727b-412f-9da9-71b52da7b5ff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b9187ac4-79de-4f39-b377-feaaecd0d71f",
"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-08-01T05:16:58.1117982+00:00",
"date_create": "2026-08-01T05:16:58.1117982+00:00",
"date_update": "2026-08-01T05:16:58.1117982+00:00",
"updated_by_user_id": "4bd8e644-d5c9-4480-8ba9-8b4133fffcff",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-01T05:16:58.1117982+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-08-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-01T05:16:58.1117982+00:00",
"date_last_job": "2026-08-01T05:16:58.1117982+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-01T05:16:58.1117982+00:00",
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00",
"is_mobile_installation": true
},
"job_type_id": "e55468ba-cddb-4614-a627-abf2b1098d4d",
"job_type_code": "sample string 7",
"job_type": {
"id": "67b7deae-e764-4526-8efa-fc6eca7cdea1",
"name": "sample string 2",
"sales_organization_id": "eecf3f51-e14b-498d-a0d1-46e9c5af5625",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00",
"code": "sample string 7"
},
"job_priority_id": "7f4b7ff8-9e29-4a98-80e3-8dd44f11ee25",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1f3382d6-5d71-4f6c-8047-97807001c27b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "84a5dc4e-7197-438d-940f-3706dc0868ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-01T05:16:58.1117982+00:00"
},
"job_status_id": "681a093e-ff7c-4b88-97a1-afbd2eee2890",
"job_status_code": "sample string 11",
"db_address_id": "2cb57847-6587-43b0-8c80-d063a59c9fa7",
"contact_id": "3cb80e73-8c2d-4c61-9444-ec8d340580f7",
"requested_by_company_id": "f5ff2345-05da-4de9-8c25-be75ad5ebdd2",
"requested_by_contact_id": "75b6df97-6b7f-40ec-8c5d-364430075e2e",
"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-08-01T05:16:58.1117982+00:00",
"due_date": "2026-08-01T05:16:58.1117982+00:00",
"date_create": "2026-08-01T05:16:58.1117982+00:00",
"date_update": "2026-08-01T05:16:58.1117982+00:00",
"date_closed": "2026-08-01T05:16:58.1117982+00:00",
"suggested_user_id": "130df369-15e8-4130-9e84-66d922082109",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fff540c2-fd0c-4b8d-bdcd-70d7e63c2163",
"db_language_id": "7d629368-31cf-4e4a-8098-285bf33637b0",
"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-08-01T05:16:58.1117982+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8d9799a7-e086-497f-8c87-25947ad012f6",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "64811b53-3cef-4844-a3c3-62d9a5538124",
"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": "313cae7a-aebd-4eab-bdd8-41d89519eaf3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-01T05:16:58.1274225+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1cafbecc-0174-4789-bf2b-9e2a2171d341"
},
"suggested_date_start": "2026-08-01T05:16:58.1274225+00:00",
"skill_id": "1c97b894-b7f8-46b4-b586-f66fc06f98b2",
"skill_code": "sample string 32",
"skill": {
"id": "a047d7d5-65d4-49ad-913a-6e97c405c570",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "13efc7fb-b149-47b0-8390-15dccaeb182f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5272956b-589f-4282-a1d0-18119d11946d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7c9e5fe-0be8-4821-8717-ae3f08a17bd0",
"db_currency_id": "a25d4691-1028-443e-b609-8b954c92ba3c",
"db_language_id": "d806e1fb-74f4-4009-82a8-0a0926bdc9d4",
"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-08-01T05:16:58.1117982+00:00"
},
"modified_dateutc": "2026-08-01T05:16:58.1274225+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4b0ed367-062b-4921-880e-dc307d521d4d",
"date_reported_by_company": "2026-08-01T05:16:58.1274225+00:00",
"id2": 36,
"company_id": "81b76f3a-72be-4ed1-b812-d0ece34cee71",
"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": "08067900-cc8a-48b2-a111-41e00c3e56c4",
"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-08-01T05:16:58.1274225+00:00"
},
"work_instruction_details_id": "5130ea17-4752-46dd-be1b-bdbd898b843e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0d8f92e8-95b1-41b8-ada6-54aadb6ad83b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "41292468-fb2b-46d4-ab28-ae395c40af62",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-01T05:16:58.1274225+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": "2a591619-b31c-451d-b0a6-f525ad39890a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-01T05:16:58.1274225+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.