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": "6d9a16b5-3c37-4b14-9b23-b4a30000a299",
"jobs_id": "70ffb1f2-332e-4ab4-8a86-53a7403c06b6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "94392736-cbc9-4e97-b833-ab5f6a1ede6a",
"_parent_id": "485c00cc-28ea-4320-9c26-c250943982e5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fbe7cd96-2f59-473c-9b59-370d6a6e0afa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aeb609ca-1d2e-42d3-a74f-b8d947ea34bb",
"_parent_id": "6e574ff1-7e94-4d75-9bc8-8d664bf8e398",
"root_parent_id": "55dc113f-b4b1-4d9b-856b-af2bce83e632",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "be47edbd-f14e-426f-8337-e5f986e891d8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "949ce665-f060-4454-90e3-abfecc038608",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a0744ee4-29ca-4daf-81ce-48189d9ddc68",
"_parent_code": "sample string 6",
"sales_organization_id": "9d3cd670-0083-4d66-b9f2-00f7933e8f08",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
},
"equipment_model_id": "d5521a04-ce0d-4ed6-b20b-e6f8dcb65f48",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d31af81f-f94b-4161-b7cc-08e20a6a6549",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "05fede7f-524f-467e-9177-ea699ad7dd87",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6bc790f0-39b1-4458-b738-f526cfa31f8b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0131085-2a4f-4f2b-bc48-b78ffa44b0cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
},
"equipment_family_id": "204a42dc-a8ba-499e-83b9-bf13f43aa977",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "949ce665-f060-4454-90e3-abfecc038608",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a0744ee4-29ca-4daf-81ce-48189d9ddc68",
"_parent_code": "sample string 6",
"sales_organization_id": "9d3cd670-0083-4d66-b9f2-00f7933e8f08",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
},
"date_in_production_since": "2025-12-20T13:10:46.5813824+00:00",
"date_out_of_production_since": "2025-12-20T13:10:46.5813824+00:00",
"date_end_support": "2025-12-20T13:10:46.5813824+00:00",
"sales_organization_id": "e103e0fc-906f-4624-b12b-2ea6186f8ede",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+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-20T13:10:46.5813824+00:00"
},
"project_status_id": "d12394f4-974a-4165-9560-a42ed3b1489f",
"project_status_code": "sample string 10",
"project_status": {
"id": "cdd1061d-abaf-4282-9e4d-ec7e15c58d4f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7d813eae-4f55-459b-a315-500cc9ef4424",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
},
"company_id": "1aac0970-1ea8-4dc1-9f5e-fc07020083f7",
"company_code": "sample string 12",
"db_address_id": "0fe9829e-d2c2-4e82-a27d-ee18570a1451",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "73e00df2-2140-4738-ace0-39a0405eca53",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "48321723-e924-4dd9-bc56-73d1a5e4081b",
"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-20T13:10:46.5813824+00:00",
"date_create": "2025-12-20T13:10:46.5813824+00:00",
"date_update": "2025-12-20T13:10:46.5813824+00:00",
"updated_by_user_id": "350ee8e1-0831-496b-8be0-e55e6fa2947b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-20T13:10:46.5813824+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-20T13:10:46.5813824+00:00",
"date_last_job": "2025-12-20T13:10:46.5813824+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-20T13:10:46.5813824+00:00",
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00",
"is_mobile_installation": true
},
"job_type_id": "0079103d-b215-4f92-b268-948a9c74fc07",
"job_type_code": "sample string 7",
"job_type": {
"id": "855b040a-14d5-47b3-9f2d-e5adb5d1cd66",
"name": "sample string 2",
"sales_organization_id": "ceb150f0-679b-4d65-9d23-8685e2e02e34",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00",
"code": "sample string 7"
},
"job_priority_id": "a0fab8b4-3c55-4387-af78-53a2522393be",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d2f96963-45c3-4d30-bef3-166a93512352",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6c50c2f8-f7be-4ed6-8fad-7505125cabe7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
},
"job_status_id": "ccff6018-46d0-4027-818b-24beb78efc12",
"job_status_code": "sample string 11",
"db_address_id": "36ea123a-3c10-4464-9021-7a4b5a18030f",
"contact_id": "57a6dd0a-1a6a-457d-99ec-496d3d7c3800",
"requested_by_company_id": "281f3783-b00b-4d00-8f1b-531c9003d25c",
"requested_by_contact_id": "7e5fa228-4b57-43a7-a035-8147ff93ffed",
"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-20T13:10:46.5813824+00:00",
"due_date": "2025-12-20T13:10:46.5813824+00:00",
"date_create": "2025-12-20T13:10:46.5813824+00:00",
"date_update": "2025-12-20T13:10:46.5813824+00:00",
"date_closed": "2025-12-20T13:10:46.5813824+00:00",
"suggested_user_id": "91f4b7d7-c3c8-4df9-bbc2-4c86c669afcf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fb1a3fab-30c8-4637-8d53-06c0a76cc513",
"db_language_id": "74ed6ef3-d93d-4c28-b710-6d3dd781400c",
"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-20T13:10:46.5813824+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aa9cf9fe-e93c-4c64-8b73-8f1ad69b6d7e",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4b2b9c7f-496a-4e4c-a892-154671354bce",
"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": "ebd2e0f3-d539-4e3b-ae73-351ead274f10",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41cbbf23-cf27-4133-8dc9-5386df673207"
},
"suggested_date_start": "2025-12-20T13:10:46.5813824+00:00",
"skill_id": "b4b8f000-f3ce-4ba1-a4e6-e639ba29048b",
"skill_code": "sample string 32",
"skill": {
"id": "266011d6-d6d7-4722-9dc0-688624e141e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "be950a7a-749b-46e9-b66e-edabb7ca6db9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f11c7ff0-84ce-4c28-80ed-1d84c313f40a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "97bf2015-e4d0-4941-b510-c3c44930bfeb",
"db_currency_id": "b48c3fd9-7fec-42fa-aa5c-a259fb6ec6be",
"db_language_id": "e94c3b7d-1e3e-49a1-b694-200e941297ab",
"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-20T13:10:46.5813824+00:00"
},
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a65fc4d5-4b48-4e4c-9ec0-2ed11db569c5",
"date_reported_by_company": "2025-12-20T13:10:46.5813824+00:00",
"id2": 36,
"company_id": "18dda1ac-5e47-4e7e-b69c-af2572e21b56",
"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": "f00fe655-68dd-408b-a52b-e636141e3101",
"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-20T13:10:46.5813824+00:00"
},
"work_instruction_details_id": "5257566f-7025-45dd-85c9-cbcea6b9c9ae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d96a2c4b-da15-4a0c-b36d-a08e2ecaed9e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "65382224-5664-4952-b099-6470347a8e9c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-20T13:10:46.5813824+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": "a92dc085-21a6-43e1-b607-47e3570b4e20",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-20T13:10:46.5813824+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.