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": "cc948c14-f37d-43a5-8aee-aafc25ecf7ae",
"jobs_id": "b475f026-827d-4f55-aecc-465594149bd3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "091175a6-15c0-417a-bfdb-6edd5eb55582",
"_parent_id": "1a76ab0c-576b-429d-ac83-2d5597d05a36",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a6417760-325f-4c3e-af54-93dda1368e07",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ecc06bfa-4f5d-4b66-90ac-52ff83fd9bde",
"_parent_id": "a507b097-dba2-40c3-a2a5-2ee66fa1054b",
"root_parent_id": "30c72eb3-d052-4f57-b21e-0ef20fa57658",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "88215c9a-3552-4f07-a6d0-6937ce437c39",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a964aedc-515f-42f1-9460-aa5ef5e01670",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "84407d14-7837-4c1c-8fc2-f6507eb40b4d",
"_parent_code": "sample string 6",
"sales_organization_id": "9e057312-d4fb-429c-b86a-29a8a47cfc95",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
},
"equipment_model_id": "37aa7baf-fb60-4540-8a37-3fce2b01084f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "96bde0ce-d3e3-4ef0-9c50-2ae8b085eb29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e3e3240c-af2c-4dd0-8592-e4d9b1db73a6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "24f277be-4c0b-4cd6-8a24-982784adddd3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7f714c47-68d8-49b4-83c6-72ea4a7b188c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
},
"equipment_family_id": "9ab07743-dc96-40ad-a044-9bcc75b598cf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a964aedc-515f-42f1-9460-aa5ef5e01670",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "84407d14-7837-4c1c-8fc2-f6507eb40b4d",
"_parent_code": "sample string 6",
"sales_organization_id": "9e057312-d4fb-429c-b86a-29a8a47cfc95",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
},
"date_in_production_since": "2026-01-28T06:46:30.884671+00:00",
"date_out_of_production_since": "2026-01-28T06:46:30.884671+00:00",
"date_end_support": "2026-01-28T06:46:30.884671+00:00",
"sales_organization_id": "d02e159d-211d-4198-aaba-343cbd35c8d5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+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-01-28T06:46:30.884671+00:00"
},
"project_status_id": "0ac87e78-3aca-4715-98a8-206af1dc3654",
"project_status_code": "sample string 10",
"project_status": {
"id": "3f1007c0-2cf9-4858-b473-fc5047b5605c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "00683b2f-320f-49ec-91ff-ae7d76f08af7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
},
"company_id": "c71b2653-367f-4ccd-87fb-93d4543968ef",
"company_code": "sample string 12",
"db_address_id": "0ce85f66-1730-4e28-921d-83c8a28dc482",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c595d6f0-f5bd-4b4a-bba1-f28807abff28",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "03b225c7-8fce-46a4-b70f-1ab8f8cc881c",
"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-01-28T06:46:30.884671+00:00",
"date_create": "2026-01-28T06:46:30.884671+00:00",
"date_update": "2026-01-28T06:46:30.884671+00:00",
"updated_by_user_id": "80d1fd6d-3a79-4bfa-b39d-5f8ed9c08131",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-28T06:46:30.884671+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-01-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-28T06:46:30.884671+00:00",
"date_last_job": "2026-01-28T06:46:30.884671+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-28T06:46:30.884671+00:00",
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00",
"is_mobile_installation": true
},
"job_type_id": "3c689770-b2b9-4d2c-9caf-f37cdd755f67",
"job_type_code": "sample string 7",
"job_type": {
"id": "44b6becc-06b2-4c88-baf4-f24238fb9762",
"name": "sample string 2",
"sales_organization_id": "159cb182-b619-40f3-bbab-cda711cada3e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00",
"code": "sample string 7"
},
"job_priority_id": "ce1b467b-8fcd-4cf1-959c-4d81b0b454a5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b6063c7-83e2-4f3b-be92-b2bf3ca220fd",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e30fd1da-96f5-4ffc-9140-86782c5f25d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
},
"job_status_id": "765d831d-4220-446f-b6ed-1627176bcb6f",
"job_status_code": "sample string 11",
"db_address_id": "79425e55-67ca-4470-9c74-001d7c0caf4d",
"contact_id": "83454406-c09f-4cfb-a11c-f2863d0521c1",
"requested_by_company_id": "b99536c1-8450-4d21-9182-deac268f5ca7",
"requested_by_contact_id": "5b26dc7f-50a0-4eb8-b5fa-276fbc3073a9",
"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-01-28T06:46:30.884671+00:00",
"due_date": "2026-01-28T06:46:30.884671+00:00",
"date_create": "2026-01-28T06:46:30.884671+00:00",
"date_update": "2026-01-28T06:46:30.884671+00:00",
"date_closed": "2026-01-28T06:46:30.884671+00:00",
"suggested_user_id": "c0449a34-1c46-40e5-9600-fc27f8abaeb0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a9a66644-be41-452c-874d-ba1d877de704",
"db_language_id": "52d07ced-bb69-49ed-8dfd-ce5cc2bfcc51",
"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-01-28T06:46:30.884671+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d8671ad3-5dea-4e97-8beb-73742007f15b",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0bf97237-ba22-45c2-9a94-df4fb3ada476",
"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": "6eb4128b-9872-46c4-bae3-5795e6da1ae8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a101a4f4-baff-4ba3-8d41-e1eeae4ab9aa"
},
"suggested_date_start": "2026-01-28T06:46:30.884671+00:00",
"skill_id": "66fcefdd-0467-40e3-b456-2d70dc3517e7",
"skill_code": "sample string 32",
"skill": {
"id": "0e061fc2-ae2e-4efd-83ac-acc20edef128",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "17874186-3bfd-409e-b432-b89f62cddc8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd43e77a-6887-4c44-878f-7dcc529578a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "52b568af-2639-477a-9863-06e2bb3df946",
"db_currency_id": "dc00bb86-ef94-4484-b1af-63058b667a1d",
"db_language_id": "e5d878ab-8adf-41ad-82da-fafad03fb058",
"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-01-28T06:46:30.884671+00:00"
},
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4b917e0-9701-4966-a6f0-6995ae3d0685",
"date_reported_by_company": "2026-01-28T06:46:30.884671+00:00",
"id2": 36,
"company_id": "455efe56-2ebd-4264-a363-9d1a49c07814",
"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": "0aea150c-5884-4dca-848c-2e985ae7cee0",
"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-01-28T06:46:30.884671+00:00"
},
"work_instruction_details_id": "669e02f3-2c65-44c1-875d-d8b7395b48d7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ae9b947-4c45-451b-9b6c-06fbe1ea8c76",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1ef94b8a-5767-4c0a-8206-935ce18864f9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-28T06:46:30.884671+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": "1f821ebc-35b4-4649-a459-ea568955ce3f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-28T06:46:30.884671+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.