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": "16807857-021e-4cce-a942-c82ffef876ac",
"jobs_id": "4b5da264-4abf-44a8-adac-8dfd491c23e8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2ac317cf-85e2-43f6-98ee-342ba1f5b528",
"_parent_id": "843d0767-bcef-43d5-b286-d4e7d2e2fb7e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "62672896-75c0-4498-bb64-499fc17099fe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "51f99ddf-b0e9-48eb-a993-6b04179a6faa",
"_parent_id": "7da73c37-95d4-40ae-9a7d-14341ae5b7b6",
"root_parent_id": "44b97bf1-bd78-404b-bc82-b032b9f52dba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ee0d474d-380c-4aec-b7c4-b3f26a674996",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6b441b3f-3394-411f-b2d6-16161dab0ef7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b3726e7-60ef-4dbc-bd87-2c89dc20ba56",
"_parent_code": "sample string 6",
"sales_organization_id": "3736b325-c94e-4210-98c8-87bde3e49141",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00"
},
"equipment_model_id": "c7468691-8dba-4d09-897d-ee37a0690190",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e1e6c9ab-4c2e-4a0c-ab5f-14557316cdf4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f2b4aaa2-e6bd-4844-8edd-bbc367f5cc05",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8c310754-6e3b-40c2-802f-f517a90b31c8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7a9ac024-3df3-4703-b985-6430dda565b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00"
},
"equipment_family_id": "5ddfc451-e8a1-412e-ba65-020f204adff9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6b441b3f-3394-411f-b2d6-16161dab0ef7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b3726e7-60ef-4dbc-bd87-2c89dc20ba56",
"_parent_code": "sample string 6",
"sales_organization_id": "3736b325-c94e-4210-98c8-87bde3e49141",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00"
},
"date_in_production_since": "2026-05-19T19:29:35.0539877+00:00",
"date_out_of_production_since": "2026-05-19T19:29:35.0539877+00:00",
"date_end_support": "2026-05-19T19:29:35.0539877+00:00",
"sales_organization_id": "2d2a9377-a7bd-4c5d-8290-2e7d89d20ac9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+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-05-19T19:29:35.0539877+00:00"
},
"project_status_id": "f31c3fea-29f4-4c10-a16f-8bb401c62a27",
"project_status_code": "sample string 10",
"project_status": {
"id": "189040b8-b98d-42a2-a5de-23b6d36de928",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7e5e34fd-1f8f-44a1-a9a4-5a70932c2400",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00"
},
"company_id": "0cb90851-82df-4d03-9688-510ba6a8d0c0",
"company_code": "sample string 12",
"db_address_id": "c6b83e7a-c7a5-4818-a247-237ac95357d2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "97dfdac8-de93-4d91-bef2-70532797b776",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7136a673-7c3a-4421-850e-7de9a0d323bc",
"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-05-19T19:29:35.0539877+00:00",
"date_create": "2026-05-19T19:29:35.0539877+00:00",
"date_update": "2026-05-19T19:29:35.0539877+00:00",
"updated_by_user_id": "dde8312e-573f-48fb-98cb-a119443bb94b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-19T19:29:35.0539877+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-05-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-19T19:29:35.0539877+00:00",
"date_last_job": "2026-05-19T19:29:35.0539877+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-19T19:29:35.0539877+00:00",
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00",
"is_mobile_installation": true
},
"job_type_id": "e96845bc-7634-4173-bf41-c9d9eefdd795",
"job_type_code": "sample string 7",
"job_type": {
"id": "d4acc8d4-20fd-4553-884a-a9dbaf88a7f4",
"name": "sample string 2",
"sales_organization_id": "c0db7047-79f3-4035-92c9-e6d9aa324efd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00",
"code": "sample string 7"
},
"job_priority_id": "f7f18e32-7928-4c23-8a54-6393dd169e21",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2ee4faca-983c-4ee9-81ef-dacff98421ac",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c44ad0d7-9084-4071-8037-9675bd3e6370",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00"
},
"job_status_id": "443ddc74-597e-4d2c-8232-9546f1ef2ffb",
"job_status_code": "sample string 11",
"db_address_id": "148cf044-17ba-42b6-a188-d7c9397cc37a",
"contact_id": "ead6eb7c-4f32-4a6b-892e-562be75a4783",
"requested_by_company_id": "45b659db-165d-44de-a65c-3ddbf3ab6b52",
"requested_by_contact_id": "9e7fc7a8-aaf2-4a95-9bee-094073e1aa8d",
"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-05-19T19:29:35.0539877+00:00",
"due_date": "2026-05-19T19:29:35.0539877+00:00",
"date_create": "2026-05-19T19:29:35.0539877+00:00",
"date_update": "2026-05-19T19:29:35.0539877+00:00",
"date_closed": "2026-05-19T19:29:35.0539877+00:00",
"suggested_user_id": "3a685b03-377a-413a-a1f6-fe76f3c77aae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7b4405ff-c18a-40ec-9b11-5edb0f1e7591",
"db_language_id": "ae2273e0-772b-4d5f-96e7-101b17027149",
"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-05-19T19:29:35.0539877+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f70d83c6-89c5-4b9c-a563-8570d6fcbdeb",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5d14bdd5-f45b-4ad7-bb20-06b2e88475d4",
"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": "d24bd2a4-e029-402f-8096-c6eb9266655c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-19T19:29:35.0539877+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "239b46fd-aeca-437d-8aa1-21652d90a432"
},
"suggested_date_start": "2026-05-19T19:29:35.0539877+00:00",
"skill_id": "22fda857-b827-4efc-91f9-8b8405d568d8",
"skill_code": "sample string 32",
"skill": {
"id": "b80a059c-48e2-458d-b897-fcf01f6aa895",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c1d90fd7-94ee-42fc-9ec9-d62c3e114205",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91e1e48f-abcf-4fea-a647-5a2025227561",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "51731771-4f15-4913-b4e1-a36418fbf747",
"db_currency_id": "2af2cc28-7469-494a-9d7d-a6c4d9ab0edb",
"db_language_id": "82aa2c21-6707-49f0-80d8-f85f78c0908c",
"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-05-19T19:29:35.0539877+00:00"
},
"modified_dateutc": "2026-05-19T19:29:35.0696189+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0f36e477-8ce8-4bc4-a529-3daf2dcd5339",
"date_reported_by_company": "2026-05-19T19:29:35.0696189+00:00",
"id2": 36,
"company_id": "e7880da6-ac61-4ad7-bead-8b2ae0baa432",
"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": "43b568d9-25f8-475c-a0a4-49dcf0c6fd56",
"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-05-19T19:29:35.0696189+00:00"
},
"work_instruction_details_id": "6b8c0022-a8fc-4310-8b37-7bba7db9dd66",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ec787aff-2d58-4276-a273-28f007affaf2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b09ec505-d503-46a0-ae25-27f8b78c060b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-19T19:29:35.0696189+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": "7d55a515-0729-4b1a-ab29-f0e17e31275d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-19T19:29:35.0696189+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.