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": "2e8818d5-8fec-46cd-bec9-01cf61bf58ac",
"jobs_id": "54407a68-77fb-4e6f-ba24-25d5c2f06cf8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eec76725-094d-4a7e-829f-3a5b29d58aa9",
"_parent_id": "244322da-09a2-473e-8a75-cfdb5fd6b94b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "634c0322-4792-4b65-93d3-ccdd9bba4ac5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e8c81080-9072-42c7-8b0e-a15c9d73e62e",
"_parent_id": "d9f2661b-0162-4f90-90cc-2b3cea3c2aff",
"root_parent_id": "2c9bbbad-6e41-4aed-9969-6fa9994f25ab",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d642ccce-0d77-436c-a7fb-e0fa5b246422",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "30c028f2-01e3-48f2-8ada-e407c7f36096",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d4e1bd1-790d-4514-9671-028f47172d65",
"_parent_code": "sample string 6",
"sales_organization_id": "278447c4-87f6-49a3-a3f0-bbe1d169982a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
},
"equipment_model_id": "f1f55e9e-73a2-4d47-b473-3659b62c924b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e3bfb01b-1720-4bbe-9c0c-e4e4295e927f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7181f036-e8f9-45d2-a619-f5473708a04c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ef6f4320-0707-4a0a-8b74-b265f4c097cd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eeb524c2-ac2d-4c12-9f6e-25b78f8eb627",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
},
"equipment_family_id": "db2aba72-e93c-4f15-aa94-8a30c7247aa0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "30c028f2-01e3-48f2-8ada-e407c7f36096",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2d4e1bd1-790d-4514-9671-028f47172d65",
"_parent_code": "sample string 6",
"sales_organization_id": "278447c4-87f6-49a3-a3f0-bbe1d169982a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
},
"date_in_production_since": "2025-12-31T08:45:48.3583349+00:00",
"date_out_of_production_since": "2025-12-31T08:45:48.3583349+00:00",
"date_end_support": "2025-12-31T08:45:48.3583349+00:00",
"sales_organization_id": "1b8fbc31-f76a-463b-9463-8be7acbca3c6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+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-12-31T08:45:48.3583349+00:00"
},
"project_status_id": "3650da38-a2f0-4516-ab0c-24e4c4b3c4f4",
"project_status_code": "sample string 10",
"project_status": {
"id": "6624ac80-4318-4d8f-a989-cf9bc1c76b2c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d50183bd-92d1-42b0-ac7f-f8114601426a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
},
"company_id": "a98ce8dd-a6cf-41de-b7d8-d54126046f31",
"company_code": "sample string 12",
"db_address_id": "870c1b44-a58c-48f7-84c1-4020d4d35c23",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "35055e76-218c-4066-9d4f-87d4da3ce45e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2db6e9b4-fcc6-4215-844b-3521b9dd3609",
"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-12-31T08:45:48.3583349+00:00",
"date_create": "2025-12-31T08:45:48.3583349+00:00",
"date_update": "2025-12-31T08:45:48.3583349+00:00",
"updated_by_user_id": "b81c16fa-2e15-416a-a7e6-142dc51d3975",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-31T08:45:48.3583349+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-12-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-31T08:45:48.3583349+00:00",
"date_last_job": "2025-12-31T08:45:48.3583349+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-31T08:45:48.3583349+00:00",
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00",
"is_mobile_installation": true
},
"job_type_id": "c1662b71-cf75-45ff-9cc3-1939db26dffc",
"job_type_code": "sample string 7",
"job_type": {
"id": "6ecdf293-04e3-41d6-96a1-125fb6eb0631",
"name": "sample string 2",
"sales_organization_id": "1c72e5b5-1162-4290-beca-b382da6474e5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00",
"code": "sample string 7"
},
"job_priority_id": "38ffc52d-6ed4-4205-92ae-013dde895c6d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a409f1c0-af43-4f46-a0fc-d29066ed8f71",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6d72536a-f00d-42dc-9a9c-02309d2f8b59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
},
"job_status_id": "40543312-5904-4b6c-a87c-56bd1f875012",
"job_status_code": "sample string 11",
"db_address_id": "c59ccdfd-2b92-4771-a5f7-162cfcd24b49",
"contact_id": "1299a93f-e6ea-445f-91b7-67ae77ab932f",
"requested_by_company_id": "9ae2bf73-052a-41f3-99f2-286c9eb9e7ba",
"requested_by_contact_id": "062a3eec-adee-4138-b23e-43cbdde2d870",
"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-12-31T08:45:48.3583349+00:00",
"due_date": "2025-12-31T08:45:48.3583349+00:00",
"date_create": "2025-12-31T08:45:48.3583349+00:00",
"date_update": "2025-12-31T08:45:48.3583349+00:00",
"date_closed": "2025-12-31T08:45:48.3583349+00:00",
"suggested_user_id": "ab2202be-1771-4772-a11f-825c252c20ef",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5dbddab9-2b21-42dd-bfd4-4335c15f11d2",
"db_language_id": "1f482b99-a012-49f3-9e1b-37037f7f01c8",
"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-12-31T08:45:48.3583349+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8c0479cb-d6ef-4a3d-983f-709e834493a7",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a12c7c21-2304-4e21-90c6-e82c4fdfdf5b",
"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": "41644faa-bfb5-4db5-82de-a52487780a0a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0459cded-fbb1-4720-8bc0-c47fa26bcd16"
},
"suggested_date_start": "2025-12-31T08:45:48.3583349+00:00",
"skill_id": "d327c2d5-5211-4f7b-9129-2f268d4e1ddb",
"skill_code": "sample string 32",
"skill": {
"id": "12ca859d-0b86-4d21-9b16-766fff9fec95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9fe11bad-7c7f-49ec-b3cc-01e41e70044a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "baa1bae0-6a19-402d-b2eb-3e18be3e1654",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3623594b-3633-4426-a494-1a470e5e0422",
"db_currency_id": "ff8d2b06-cefa-4780-a152-b962686a89ed",
"db_language_id": "a749d76c-c516-4bcc-82f5-ca52f9d5e857",
"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-12-31T08:45:48.3583349+00:00"
},
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ef14f4ec-aaa0-47e5-93f2-f4fd941daafe",
"date_reported_by_company": "2025-12-31T08:45:48.3583349+00:00",
"id2": 36,
"company_id": "a8df13ab-5741-4cd4-bc89-c56d00661822",
"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": "917893c6-fde8-4f25-8db0-9f64f9bfe620",
"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-12-31T08:45:48.3583349+00:00"
},
"work_instruction_details_id": "8e77fe3f-f277-48db-8bd0-1198c2dd7e79",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "081eb634-972c-4b3f-b8f9-0f04b991e203",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "03e530f1-356a-4406-a9e4-95525ee48b22",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-31T08:45:48.3583349+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": "c96d5cac-3e42-4ecc-9312-f7609e27d0d9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-31T08:45:48.3583349+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.