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": "7d68d71e-0be1-47f0-9204-12f1f44125b1",
"jobs_id": "9fe5a032-d821-4263-aeca-8432abae6606",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b2c0b40c-f929-47bd-aa10-e05d93006ead",
"_parent_id": "439846ef-30c0-4c91-bb7c-9af2fbb1163d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9b60fa5d-e4f3-48de-b99b-80a50f6740a6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4ba9679a-588f-49d9-9a3b-ddfce4c8f99e",
"_parent_id": "4fd17df1-fbbb-400a-8d0b-ce2ef12fafad",
"root_parent_id": "41ff5a75-c6f7-4536-ac24-f300ef6abddf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "44a5e039-6d85-4511-a673-e50e8812fab4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "02c5e920-3162-4243-ae32-918e1f4d45f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "37ca1e7a-b666-4ec7-ad2b-c3c5960aafc7",
"_parent_code": "sample string 6",
"sales_organization_id": "43b2cf3a-6722-4452-8c73-42a050440850",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
},
"equipment_model_id": "50cf21d9-8368-4ae1-85ed-0da69a1c8f2f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bb1413b9-f0ca-4e57-963a-2a3c3d559917",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f8115038-6950-419f-b4dd-30514cc988b9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "af06eb57-c7e2-4ceb-9280-9adf17993502",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "de0f3426-0df2-4e03-bf2e-0685e6f56bcb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
},
"equipment_family_id": "a6b962d7-0615-43cb-9f70-0cc2098c4a83",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "02c5e920-3162-4243-ae32-918e1f4d45f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "37ca1e7a-b666-4ec7-ad2b-c3c5960aafc7",
"_parent_code": "sample string 6",
"sales_organization_id": "43b2cf3a-6722-4452-8c73-42a050440850",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
},
"date_in_production_since": "2026-08-10T05:38:30.4983321+00:00",
"date_out_of_production_since": "2026-08-10T05:38:30.4983321+00:00",
"date_end_support": "2026-08-10T05:38:30.4983321+00:00",
"sales_organization_id": "4277c082-2a31-4dbc-b72a-2da3d17d7bb9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+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-10T05:38:30.4983321+00:00"
},
"project_status_id": "fd0c9aa3-a85a-408b-8cb4-d4ce188e0acd",
"project_status_code": "sample string 10",
"project_status": {
"id": "83e45a9f-4954-4be1-8f62-4bb1867164e5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "12e708b5-d9ac-4de7-9b7c-534aa3f7d3d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
},
"company_id": "42d1b8bb-06b1-45f3-ac48-6f2f272235bc",
"company_code": "sample string 12",
"db_address_id": "ba236d34-71f6-4c0f-b200-3471c6acfe57",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f9c03c1e-21ff-4067-96a9-8a8280aa4a28",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9a2d323d-20d9-4c57-9e02-fc2aff3efeb0",
"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-10T05:38:30.4983321+00:00",
"date_create": "2026-08-10T05:38:30.4983321+00:00",
"date_update": "2026-08-10T05:38:30.4983321+00:00",
"updated_by_user_id": "a0734bc5-6fac-4f8a-9065-16a82835b0a7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-10T05:38:30.4983321+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-10T05:38:30.4983321+00:00",
"date_last_job": "2026-08-10T05:38:30.4983321+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-10T05:38:30.4983321+00:00",
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00",
"is_mobile_installation": true
},
"job_type_id": "03d3c83d-d84d-4cca-a629-9a8d5399ce05",
"job_type_code": "sample string 7",
"job_type": {
"id": "65ae7ffb-60a1-4016-a97f-90ac07aa2586",
"name": "sample string 2",
"sales_organization_id": "0e3ca315-e3b2-4dac-81bf-f87646f435f1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00",
"code": "sample string 7"
},
"job_priority_id": "bdb74c84-7ced-4019-a627-18176677858f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8111a2c1-5bb9-43e9-a0a4-f2ffe290b938",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d90cc51-3f02-48b8-87ac-dab8a70a411a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
},
"job_status_id": "61459b1c-c638-41f4-9426-b7f5d7217b51",
"job_status_code": "sample string 11",
"db_address_id": "2b4c09fa-2e2f-44c4-843d-0c4bff551070",
"contact_id": "3e297e00-72be-4073-baa5-d1718160ac54",
"requested_by_company_id": "fc2925d7-89b4-4821-8881-35e2c92a376e",
"requested_by_contact_id": "a7a4346b-01d3-49b7-a9e3-aff00f9d9c48",
"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-10T05:38:30.4983321+00:00",
"due_date": "2026-08-10T05:38:30.4983321+00:00",
"date_create": "2026-08-10T05:38:30.4983321+00:00",
"date_update": "2026-08-10T05:38:30.4983321+00:00",
"date_closed": "2026-08-10T05:38:30.4983321+00:00",
"suggested_user_id": "48d752f0-6719-4524-9571-a2508692284f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9a76531a-1560-4b23-b452-0d49487b45f8",
"db_language_id": "45facdc8-fde7-463c-880e-a6abd555eba7",
"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-10T05:38:30.4983321+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0e3f5fc8-529f-4a3e-9c8d-4c2bdec10778",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ee656597-5fa2-43b0-b6e3-a8a3c74323d9",
"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": "7458eed9-9ca5-48ef-9151-ec1e102274ad",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95ccf20b-a4b0-49cf-a13c-2a6f0a8b9e0a"
},
"suggested_date_start": "2026-08-10T05:38:30.4983321+00:00",
"skill_id": "6f6ef2c7-dcfa-4737-899d-a3adf7f28eea",
"skill_code": "sample string 32",
"skill": {
"id": "65ac2be2-b13c-42a7-b66a-8081dc4f4829",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c1b8405a-ab86-4f49-a7c4-cda5a1f6ea5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5f82db6-b772-4f15-bfe1-f5bb0cdfa81e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70bef819-f114-4e45-960f-e886a5037bda",
"db_currency_id": "b7d55ae5-ea5a-485d-9092-308f1c6426f6",
"db_language_id": "176efbc8-3ed0-409c-8c3b-2158c76b8d04",
"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-10T05:38:30.4983321+00:00"
},
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8908176e-3e2d-4e62-9d7a-4acf5641f0c6",
"date_reported_by_company": "2026-08-10T05:38:30.4983321+00:00",
"id2": 36,
"company_id": "b8f37c89-6758-49f6-b71a-948c8ef9f953",
"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": "5ab6b35d-5371-4854-a477-8e78069cc72b",
"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-10T05:38:30.4983321+00:00"
},
"work_instruction_details_id": "6434b781-d990-47a6-984e-216ca7e42157",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b08e816c-b1bf-43e5-8941-16d0e88b73c1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "30ce82fa-8b3f-492e-bac3-d74e2604c142",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-10T05:38:30.4983321+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": "4a4e3db4-745c-4ce5-b970-d8ff22220666",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-10T05:38:30.4983321+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.