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": "5a57b163-9284-4345-8d80-d53f926ff99d",
"jobs_id": "e47bd1d9-ee25-47c2-880d-eaf06d779057",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "81bb6eec-6ba8-48f0-90bb-e574d041f5c2",
"_parent_id": "38bc803c-8af3-4cfd-9cf1-0e14c8f4827d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "64a0e26f-bcd5-49d7-885f-8966828b758f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "430a03f3-824b-4a83-a6c9-3c33aa1b09f1",
"_parent_id": "08b8fd25-4d09-4b00-8c21-11f3ad410bf9",
"root_parent_id": "a6f07a2f-354e-417d-8068-56de29325154",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e7597029-3ea4-4976-b986-8f885038d3d0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "95ae0d91-ba6f-49be-87bb-21ac48036a58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8e1c6ed-425a-4571-8710-62382fd0ae76",
"_parent_code": "sample string 6",
"sales_organization_id": "abdad658-c3db-459b-8138-710be6bf488b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
},
"equipment_model_id": "f5e494e8-105f-4a33-88ff-2de33ef80275",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc7e84e7-76df-4ac5-80b0-9ef1eed9f9c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "55de2129-8eec-4eb7-bc43-96f77aa3a19f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "90b53d94-4ada-425b-af0b-18baf4dd4222",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c676decf-3aba-40a0-a3b7-c80e62727fbf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
},
"equipment_family_id": "b2ffa198-5a6e-4303-bb4b-3e21fd210a76",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "95ae0d91-ba6f-49be-87bb-21ac48036a58",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8e1c6ed-425a-4571-8710-62382fd0ae76",
"_parent_code": "sample string 6",
"sales_organization_id": "abdad658-c3db-459b-8138-710be6bf488b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
},
"date_in_production_since": "2026-08-26T23:41:53.413319+00:00",
"date_out_of_production_since": "2026-08-26T23:41:53.413319+00:00",
"date_end_support": "2026-08-26T23:41:53.413319+00:00",
"sales_organization_id": "f30b7916-19f1-4940-9eef-4c83160039b5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+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-26T23:41:53.413319+00:00"
},
"project_status_id": "edafa288-f5ac-40cf-816b-8d3c2d810d53",
"project_status_code": "sample string 10",
"project_status": {
"id": "eb3967d4-4dd1-44f4-a3bd-3cdaaa16ae1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c482f99d-6b1f-42ff-be39-69ff2f766b9c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
},
"company_id": "fb9859bb-0216-4e87-8bee-4d80181f15f6",
"company_code": "sample string 12",
"db_address_id": "8c99f1e9-e919-47f3-9617-09a84c2e81b9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c4b4c166-026c-4a09-8683-cabc2a23884c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "655981b6-7e3e-4d2e-9a22-3891d94b4101",
"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-26T23:41:53.413319+00:00",
"date_create": "2026-08-26T23:41:53.413319+00:00",
"date_update": "2026-08-26T23:41:53.413319+00:00",
"updated_by_user_id": "1abe331b-5559-4aad-9303-ccfe8bdf673d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-26T23:41:53.413319+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-26T23:41:53.413319+00:00",
"date_last_job": "2026-08-26T23:41:53.413319+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-26T23:41:53.413319+00:00",
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00",
"is_mobile_installation": true
},
"job_type_id": "4a0bf6ff-94c7-44f7-9092-cd23df8cc94f",
"job_type_code": "sample string 7",
"job_type": {
"id": "668d8792-ea66-43d2-a7cd-ca506615a6d3",
"name": "sample string 2",
"sales_organization_id": "0d634efa-e805-4e49-81cf-7b47ee7592ae",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00",
"code": "sample string 7"
},
"job_priority_id": "847a65f4-d583-4dda-9b51-8fefcf61bdeb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "efbe973c-cfa9-4a7f-9d2d-c65952380b24",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e81f6490-44e9-4455-a39d-67d0080c8121",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
},
"job_status_id": "0174cccb-f81e-4eca-b850-715ff514ebfd",
"job_status_code": "sample string 11",
"db_address_id": "838f0a7d-0ff6-4e68-838c-d295fcea6304",
"contact_id": "95bcab96-7284-46c1-8dd0-a7a94f132bef",
"requested_by_company_id": "5b7aad1c-8163-41c0-b8d7-c062666d4d52",
"requested_by_contact_id": "bad78cbf-6fb5-4f8c-b4db-66495380432c",
"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-26T23:41:53.413319+00:00",
"due_date": "2026-08-26T23:41:53.413319+00:00",
"date_create": "2026-08-26T23:41:53.413319+00:00",
"date_update": "2026-08-26T23:41:53.413319+00:00",
"date_closed": "2026-08-26T23:41:53.413319+00:00",
"suggested_user_id": "76aeb145-5c1d-41a8-82b7-2b069bc70672",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9c71197b-05ac-4be8-bcdb-c80f50c1e383",
"db_language_id": "9a13cdfe-3918-4744-8dd7-57442e000edb",
"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-26T23:41:53.413319+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "41a3ff90-0822-4305-84b9-0f51406d2b0e",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "006a762c-0f7f-40f3-8110-765323a12193",
"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": "c0702924-9370-4c33-9b8c-8e59a51b3c67",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2138d960-be8f-47e8-86a5-a6b360f4c9f5"
},
"suggested_date_start": "2026-08-26T23:41:53.413319+00:00",
"skill_id": "db5ebb26-d220-41c4-8408-cb0f59a206d8",
"skill_code": "sample string 32",
"skill": {
"id": "712b00f4-fd36-4c03-981d-1ac8e77a1e63",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bdb73e8f-b1fa-45cb-8cf0-e139af8dc109",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ba4f32c-92a8-4980-a7d3-01cc958c3cb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0c0bc2ef-2e06-4edc-ac46-b8e2722e0933",
"db_currency_id": "bfee531d-8eeb-42b1-98d2-f599e4518b06",
"db_language_id": "270f99d5-5523-4629-8365-31a234ca0608",
"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-26T23:41:53.413319+00:00"
},
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d1a9f34d-0f8b-4b48-b1ed-e1ffb21f977b",
"date_reported_by_company": "2026-08-26T23:41:53.413319+00:00",
"id2": 36,
"company_id": "f6994761-f98d-4643-899c-2fa37d2e500a",
"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": "fbd7209f-70f7-4304-b283-dae58e0e3adf",
"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-26T23:41:53.413319+00:00"
},
"work_instruction_details_id": "2ca6b49d-2e1d-42dc-93c3-4430a9b2655d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "15573fa9-a5a9-4213-b519-94d705847c13",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f7912d58-1998-418a-9025-27711cb52e8d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-26T23:41:53.413319+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": "0d8594d5-1e88-4037-a0f4-a8e3f7ddbb0b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-26T23:41:53.413319+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.