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": "8503503b-1375-4060-a4c3-67fa2e6ed471",
"jobs_id": "9ecc5fda-330f-44f6-a1dc-57a40e55da77",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a43110a5-37b5-4a97-abd2-2cd1899eaa91",
"_parent_id": "da7b0a6d-a288-4359-b9cb-fafb1cdcfc00",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e5d05b96-aa7d-4815-8c03-253b3df67a9b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2929edf3-b9cf-4c4e-bd8a-752548f35601",
"_parent_id": "45d5a25f-a70b-443d-a479-bd4349a09ea2",
"root_parent_id": "de32cc80-0eb2-4d07-8d6b-ac25d49e9b18",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6f30d9fd-90ba-49f5-ac86-4aa9f067c583",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e7fd8da3-f1be-450f-8763-12554b4452bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2a36201b-c631-453e-880d-26d230fa6718",
"_parent_code": "sample string 6",
"sales_organization_id": "7a322b5c-34d0-4068-bb3a-2d5e6ba35ff9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"modified_dateutc": "2026-03-03T14:29:39.7185919+00:00"
},
"equipment_model_id": "188a0321-8fca-4882-b94c-cc494a946e01",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b037bae-6c46-4ca0-a7e3-1ab211b537ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "554024da-c105-4b32-b969-ef2370dc058c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "46b94336-5b50-4625-8b53-2250c3575fdd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "20785083-a997-4942-ba08-53a9b212c3e7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"modified_dateutc": "2026-03-03T14:29:39.7185919+00:00"
},
"equipment_family_id": "848e6a98-4167-4a43-b66b-44365d960621",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e7fd8da3-f1be-450f-8763-12554b4452bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2a36201b-c631-453e-880d-26d230fa6718",
"_parent_code": "sample string 6",
"sales_organization_id": "7a322b5c-34d0-4068-bb3a-2d5e6ba35ff9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"modified_dateutc": "2026-03-03T14:29:39.7185919+00:00"
},
"date_in_production_since": "2026-03-03T14:29:39.7185919+00:00",
"date_out_of_production_since": "2026-03-03T14:29:39.7185919+00:00",
"date_end_support": "2026-03-03T14:29:39.7185919+00:00",
"sales_organization_id": "de5761e4-9de6-4058-83e2-41dd4a0e4bcc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+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-03-03T14:29:40.2029944+00:00"
},
"project_status_id": "d83b0f15-4b5b-4846-a803-f68b92b4eb5f",
"project_status_code": "sample string 10",
"project_status": {
"id": "f8fd284a-9658-46c8-a615-568b3ef924cd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f20ad132-5741-43ba-b3a0-61d241651369",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00"
},
"company_id": "50aa8c23-d78a-4d81-9d88-415383231902",
"company_code": "sample string 12",
"db_address_id": "eb7216dc-01d3-43b1-9f4b-278bd9b376c8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e77c53b3-39f3-4027-99b8-412c6b8995b1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fe6a40f1-569d-4b16-aead-9a7ecb0f04e7",
"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-03-03T14:29:40.2029944+00:00",
"date_create": "2026-03-03T14:29:40.2029944+00:00",
"date_update": "2026-03-03T14:29:40.2029944+00:00",
"updated_by_user_id": "74e17dae-1f2d-46ab-907b-5baf526ad792",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-03T14:29:40.2029944+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-03-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-03T14:29:40.2029944+00:00",
"date_last_job": "2026-03-03T14:29:40.2029944+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-03T14:29:40.2029944+00:00",
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00",
"is_mobile_installation": true
},
"job_type_id": "86c0703a-343d-494e-bbe7-ef65bad110dc",
"job_type_code": "sample string 7",
"job_type": {
"id": "d4073361-bb90-4e7c-903f-48ace4683822",
"name": "sample string 2",
"sales_organization_id": "9e7bb1e6-e00e-4f35-8857-4ed48b46eef0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00",
"code": "sample string 7"
},
"job_priority_id": "d19af01b-091d-41c2-8b70-4757239425bd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9435a722-4414-4b65-8ee8-ccf7f3c22eb8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c0ba1f05-e7ab-408a-b77f-6063c78b45e2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00"
},
"job_status_id": "b8ddca84-5ea9-45f1-85dd-2c7f83c66524",
"job_status_code": "sample string 11",
"db_address_id": "86b90ab9-de0e-49ad-b7ce-c3ad442c18fd",
"contact_id": "c0305c0a-7c6d-44d5-81e8-3db76f531428",
"requested_by_company_id": "b0a2655e-0919-4224-a734-fb30c0245df1",
"requested_by_contact_id": "5c904ab4-9cf9-47c0-8fab-1ff2d0acda2f",
"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-03-03T14:29:40.2029944+00:00",
"due_date": "2026-03-03T14:29:40.2029944+00:00",
"date_create": "2026-03-03T14:29:40.2029944+00:00",
"date_update": "2026-03-03T14:29:40.2029944+00:00",
"date_closed": "2026-03-03T14:29:40.2029944+00:00",
"suggested_user_id": "f14b15d0-9636-4db7-8fe8-1bbf3ad89ac8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "97b14394-1893-4dc0-aa93-2a24fede09f0",
"db_language_id": "7934ab20-940e-4f45-8b0b-ac230d2cfed1",
"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-03-03T14:29:40.2029944+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "84946566-dd5f-4315-ab26-de02437cb50e",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0e0fb179-9138-4bca-aa23-59cbc0c68c7e",
"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": "a9a93bd4-7853-41f2-913d-417c5f502991",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7265c411-beea-4190-91eb-2dffe9cd4540"
},
"suggested_date_start": "2026-03-03T14:29:40.2029944+00:00",
"skill_id": "14340566-4055-4664-bab5-1adb2edd19de",
"skill_code": "sample string 32",
"skill": {
"id": "dd65e7de-a215-4e99-b08a-f410969d95e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e3386754-be07-4608-9455-8f3f6f83caec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "549a047d-a725-4a54-bb92-b18aad94abfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91f8f709-abf8-4114-95b9-d7f279130707",
"db_currency_id": "ec79f722-fb26-4071-a632-f6f122ef09d7",
"db_language_id": "a5c856ae-7f35-4f40-b8b8-2209a8604ee2",
"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-03-03T14:29:39.7185919+00:00"
},
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4451a33e-7819-4b90-979b-498be3e055ac",
"date_reported_by_company": "2026-03-03T14:29:40.2029944+00:00",
"id2": 36,
"company_id": "930d3e04-a455-4a63-855a-8dfd7c79e0dc",
"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": "41c0a5eb-5493-474d-a3c4-1c03d42d1782",
"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-03-03T14:29:40.2029944+00:00"
},
"work_instruction_details_id": "931c0c78-cc87-43ce-bf0b-e5eff2c14b36",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "baf1a919-aa34-4ea1-a7f2-dcb35f4e994d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2a15e13f-a26e-4053-ba30-e11453ade006",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-03T14:29:40.2029944+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": "63560201-c060-4b71-9cc7-0a2582f9fd5c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-03T14:29:40.2029944+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.