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": "cbd9eb58-fc08-4fdc-a47f-fde9c3005316",
"jobs_id": "59d571ac-2efc-472c-b514-8066b8f31bf0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f0c8a56b-9372-4fb3-b354-db7ec04e87bf",
"_parent_id": "d98d8f76-e2fe-4825-a605-1b53ed43c3bb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7c50e094-24ea-4642-ae23-0d48805e4710",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a9fd19c2-b79c-497b-8810-410f13f89ba4",
"_parent_id": "b1dc716b-cc6a-4347-ac09-516e34d3441c",
"root_parent_id": "05cc52ec-102a-4c8a-9056-f0ce3cf83a6d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "abaeb355-0079-4465-98a0-88ed1db571b8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "924c164b-3237-419b-ae51-37721caa849f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "77083947-529c-4469-8f2f-f7fe36a3a717",
"_parent_code": "sample string 6",
"sales_organization_id": "13df5ae0-28a8-443b-b1ca-610a7213d65a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00"
},
"equipment_model_id": "b3dcad7d-40e7-4065-99b7-c2199dcde7b8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d72eae66-5376-49c6-911a-517e2aa0394b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a9d61a15-0161-45e5-a4be-ac9cdf2a7858",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "53ed7e78-5024-4c87-b934-f7189b704b46",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "938f276c-dd58-4cd3-a5d6-854b5575c14f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00"
},
"equipment_family_id": "1156665e-8a09-4b17-b24a-0da73eb41312",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "924c164b-3237-419b-ae51-37721caa849f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "77083947-529c-4469-8f2f-f7fe36a3a717",
"_parent_code": "sample string 6",
"sales_organization_id": "13df5ae0-28a8-443b-b1ca-610a7213d65a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00"
},
"date_in_production_since": "2026-08-23T12:00:42.0676702+00:00",
"date_out_of_production_since": "2026-08-23T12:00:42.0676702+00:00",
"date_end_support": "2026-08-23T12:00:42.0676702+00:00",
"sales_organization_id": "d334b0a2-373a-4487-8267-99cc2869c311",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+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-23T12:00:42.0676702+00:00"
},
"project_status_id": "f3a0b6e8-ad71-470a-8e60-5b8cd90912f3",
"project_status_code": "sample string 10",
"project_status": {
"id": "4ef89814-5469-4cb2-9b2e-437ea39958ad",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b1ed3f0e-fc90-4ab2-8bf5-f66ef9886746",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00"
},
"company_id": "b7e2a747-8cff-4fb0-a5d2-432a10736089",
"company_code": "sample string 12",
"db_address_id": "93e76627-5657-4819-9ae3-b387167f7101",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ff6db69a-2bd3-42af-b5ba-7496350daf5e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2e54ce42-6a02-4fa2-b4f4-b3004e252a27",
"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-23T12:00:42.0676702+00:00",
"date_create": "2026-08-23T12:00:42.0676702+00:00",
"date_update": "2026-08-23T12:00:42.0676702+00:00",
"updated_by_user_id": "d44dc1fc-d1b5-4ded-8d5d-b94dec1d31f8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-23T12:00:42.0676702+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-23T12:00:42.0676702+00:00",
"date_last_job": "2026-08-23T12:00:42.0676702+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-23T12:00:42.0676702+00:00",
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00",
"is_mobile_installation": true
},
"job_type_id": "42a4ff19-c20b-4155-a105-c7328b74ad7f",
"job_type_code": "sample string 7",
"job_type": {
"id": "96a50353-c45d-49ef-a205-9f1ed621ad3c",
"name": "sample string 2",
"sales_organization_id": "5a1d832f-9f38-45d5-91cb-bd2ccac48300",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00",
"code": "sample string 7"
},
"job_priority_id": "93bc1b33-0c54-4cee-846e-502df5db9012",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c581dcb2-e33b-4481-b165-4964fdcdbadc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25276efc-e779-4e5f-b7d6-898004964b22",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T12:00:42.0676702+00:00"
},
"job_status_id": "db78fd64-fff6-4e97-a337-14db4a7871f5",
"job_status_code": "sample string 11",
"db_address_id": "2e0b37a8-535d-405a-b299-5fa655ead751",
"contact_id": "e019e081-dc24-48f9-a3c3-9c844f0ed597",
"requested_by_company_id": "057ab5dd-f450-4e57-967d-929744184be5",
"requested_by_contact_id": "8a0d8e40-7c61-4d02-8994-86db92feb429",
"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-23T12:00:42.0676702+00:00",
"due_date": "2026-08-23T12:00:42.0676702+00:00",
"date_create": "2026-08-23T12:00:42.0676702+00:00",
"date_update": "2026-08-23T12:00:42.0832942+00:00",
"date_closed": "2026-08-23T12:00:42.0832942+00:00",
"suggested_user_id": "3ea4ec44-3668-4430-833e-2a43cbdaffb0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "86e2eac9-c1bd-4ebe-ad2e-2133b1c62e5b",
"db_language_id": "14d2165a-798a-446e-89aa-5029e81a0513",
"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-23T12:00:42.0832942+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9ba8008a-afe2-45cc-88d9-371a85178849",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "01e6fd4c-8509-4452-8127-bf8e3aebec36",
"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": "5276a24b-39db-4885-a36a-2244a19ec902",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-23T12:00:42.0832942+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9986bb53-bf37-4eb1-a57d-1312e59b675a"
},
"suggested_date_start": "2026-08-23T12:00:42.0832942+00:00",
"skill_id": "2a56503a-10ff-46a4-a713-e72eb253576d",
"skill_code": "sample string 32",
"skill": {
"id": "448cac3e-18a5-4854-b0bb-0a671d0ed879",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1a38a24b-50f3-4411-97cf-3588512675a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d50b3f8-0a67-4b85-9184-a196f581e6fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a19cd435-9cd1-4287-b7f1-e546dfc32c35",
"db_currency_id": "34ba6bf6-2add-403c-a28e-67522c93ac39",
"db_language_id": "7386c8d4-d87c-4b62-9077-ffc461f45178",
"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-23T12:00:42.0676702+00:00"
},
"modified_dateutc": "2026-08-23T12:00:42.0832942+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9bca98a2-3a09-4016-aafa-5bd3d4c52f7d",
"date_reported_by_company": "2026-08-23T12:00:42.0832942+00:00",
"id2": 36,
"company_id": "f17bc6ed-2c5d-48ce-96e4-344112ec57be",
"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": "d8574dc4-aaf5-4f84-be13-4718f29742ee",
"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-23T12:00:42.0832942+00:00"
},
"work_instruction_details_id": "d3b78b60-6d86-498e-8eb1-3fc4aadfeda4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "15530fde-ca57-4454-8782-7fdc9a60bbd4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c075dc80-32cc-49c0-a8dc-69f3aa6ceb4e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-23T12:00:42.0832942+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": "22475292-57aa-4fa9-a910-e905c3921b89",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-23T12:00:42.0832942+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.