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": "71ee1d2d-822d-4769-acfa-de285835b843",
"jobs_id": "9c9df867-8c88-462f-ac8e-7c3116d1fe53",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "31f6d604-4f97-4b03-a9c7-f738d71fe48d",
"_parent_id": "12979d11-3035-4e50-9a90-22dda868c2e0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d4b1daba-9a21-4829-b85d-b875de30f3c9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0222613f-8555-485e-8dea-68ca75703721",
"_parent_id": "a4c1e370-3e50-42ec-9875-1f89e9e7eec9",
"root_parent_id": "9fcc3f95-8e4f-45e9-bf0e-cf6e699835ec",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e95bfb56-cce8-4a5d-9dac-51f5a5741bee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "54ddfb6f-9873-4d87-b995-459fd454c6bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73b4c54f-c1cb-457d-8777-c6e90f5fd813",
"_parent_code": "sample string 6",
"sales_organization_id": "10c3234f-f064-424e-9c6b-3bf8d2ff5ce3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
},
"equipment_model_id": "8792b048-56eb-4931-9f21-6a3c6ad1027f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "01ecbdd5-e01b-4d4a-8b3c-03c102f690d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "61119123-6bd9-4ca2-9eb1-d360e22486a8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "03556c8c-f203-48bc-a051-c69391455935",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c41658c-3309-485b-a351-d3195187a3e8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
},
"equipment_family_id": "84631e63-32c9-43a0-8783-190c71c09179",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "54ddfb6f-9873-4d87-b995-459fd454c6bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73b4c54f-c1cb-457d-8777-c6e90f5fd813",
"_parent_code": "sample string 6",
"sales_organization_id": "10c3234f-f064-424e-9c6b-3bf8d2ff5ce3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
},
"date_in_production_since": "2025-10-08T10:28:28.8398298+00:00",
"date_out_of_production_since": "2025-10-08T10:28:28.8398298+00:00",
"date_end_support": "2025-10-08T10:28:28.8398298+00:00",
"sales_organization_id": "e7e79448-cb17-4fe9-8d07-69fa5836c484",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+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-10-08T10:28:28.8398298+00:00"
},
"project_status_id": "92e48980-cfe2-496d-b0f0-f2d22b2869c1",
"project_status_code": "sample string 10",
"project_status": {
"id": "03eee52e-c16f-442a-a42c-63c2c4f44df6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2ba048d-3332-4da1-9740-3b576d85d13b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
},
"company_id": "5f3b1346-fa34-4599-aeb9-7d15766b948c",
"company_code": "sample string 12",
"db_address_id": "46b2c86b-3dde-4c31-b821-5a03552a716f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "507297b9-dc29-4bb8-b59f-c5f6f8082016",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "09a412d2-def8-4cec-88eb-c555fdf02d15",
"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-10-08T10:28:28.8398298+00:00",
"date_create": "2025-10-08T10:28:28.8398298+00:00",
"date_update": "2025-10-08T10:28:28.8398298+00:00",
"updated_by_user_id": "7e57dcc6-2d3f-485e-a98b-e4fc351c99b9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-08T10:28:28.8398298+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-08T10:28:28.8398298+00:00",
"date_last_job": "2025-10-08T10:28:28.8398298+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-08T10:28:28.8398298+00:00",
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00",
"is_mobile_installation": true
},
"job_type_id": "d31f9929-bcbb-49c0-8168-d5b209535376",
"job_type_code": "sample string 7",
"job_type": {
"id": "8ff2c5a4-f216-42ea-a10f-8e3264b14915",
"name": "sample string 2",
"sales_organization_id": "e9fdc063-7e8b-40f9-a8b7-1771e0b1dd5c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00",
"code": "sample string 7"
},
"job_priority_id": "eec7e958-c753-4f8e-a4df-ff65d0725dde",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "03669060-e340-434d-a57e-af8792ebf2f2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7735534e-6cb6-484d-9b72-c2bbcc7e0432",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
},
"job_status_id": "838a2d0a-a40d-44fd-b092-c2b60cf9384c",
"job_status_code": "sample string 11",
"db_address_id": "bc9b1600-85d2-4ba9-b596-8c346d7c75ae",
"contact_id": "81079f7c-40b8-4e6b-ae1f-9cd1d683b581",
"requested_by_company_id": "d4cac4f8-0a7f-4314-b987-b9bdf36769c0",
"requested_by_contact_id": "0a265481-41c7-4d55-ace0-150af9ed08c0",
"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-10-08T10:28:28.8398298+00:00",
"due_date": "2025-10-08T10:28:28.8398298+00:00",
"date_create": "2025-10-08T10:28:28.8398298+00:00",
"date_update": "2025-10-08T10:28:28.8398298+00:00",
"date_closed": "2025-10-08T10:28:28.8398298+00:00",
"suggested_user_id": "ce2780c2-9e85-44f4-a2fc-eaeb514cd2ad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0c1595fc-b878-4478-a882-5cd07141ec81",
"db_language_id": "c473c982-6ebf-42c0-9dc2-ef85897034d3",
"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-10-08T10:28:28.8398298+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "373d4ed1-eb20-452a-b0c8-68b04e74a89b",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "39f10641-6073-4bc5-840a-7adcbe1fcc08",
"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": "f5b6a4c5-6cd9-4860-9b79-cc9ef398a905",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "08e4b3b5-d4df-4a67-b231-4dbea73b3067"
},
"suggested_date_start": "2025-10-08T10:28:28.8398298+00:00",
"skill_id": "bb5fccd2-b31c-431e-bdac-40411feba3a8",
"skill_code": "sample string 32",
"skill": {
"id": "e48784d6-2f3b-4e45-a2d9-9c2a755936d2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "60963687-e464-42b5-a963-c2852a39c8bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c0e72cb8-92a8-4869-bd4e-70111ab7667c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5097656f-e602-4526-a4f3-79b43a2ee8eb",
"db_currency_id": "e5456132-c8b5-420b-bb97-b0cce2ed8eab",
"db_language_id": "2d996a3a-4132-4595-b8fc-e5abc3d9f802",
"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-10-08T10:28:28.8398298+00:00"
},
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "52f0cde2-8b49-4b38-ada7-ae5b3a384471",
"date_reported_by_company": "2025-10-08T10:28:28.8398298+00:00",
"id2": 36,
"company_id": "cdbd12e7-b78f-4180-b944-3d75e48a6635",
"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": "e142fe7e-5e70-47fb-ad6b-2c571f3577d2",
"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-10-08T10:28:28.8398298+00:00"
},
"work_instruction_details_id": "c780551c-8a86-4f76-a1c6-7a3359ef3945",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6e84ed85-94b7-4a71-a754-ea2ba66f2a11",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b348e39b-cdb4-4876-9674-4ea8fad7d38a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-08T10:28:28.8398298+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": "3c3838db-0c33-4fe9-ad2b-7b0f87ee5e96",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-08T10:28:28.8398298+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.