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": "32d0bb2e-95e9-469e-a798-6da3a85e481a",
"jobs_id": "5b2a1b8b-66e7-41ce-8888-a0e67b3068ae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0b5f519d-cb25-4e42-b17d-30487c1b376b",
"_parent_id": "13114c71-851f-4bfa-aac7-d446914ab7d1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4106f5e-d337-49d5-8ef8-fae5b9a32600",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7c49de21-8475-4a58-836f-6256b6c50c8a",
"_parent_id": "101aef63-1b55-4c4f-b1b0-b1e87e9d79f9",
"root_parent_id": "b59f071a-434d-452d-bbe9-b97bf463407d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "abdc7923-c264-4eb4-a6cf-5e296d901361",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ac4b12d1-3790-42b5-8434-98af81bc258a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c33e0814-4a39-4296-8f81-b74ce57533d9",
"_parent_code": "sample string 6",
"sales_organization_id": "ef9f69bf-9846-4a5c-9111-5c0295581e53",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
},
"equipment_model_id": "2bc89759-7cd0-4514-b288-5482a5470fe8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5b55c11c-d323-496a-aa39-87635197b7af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "18d52ac0-5828-49a8-9189-0be346fe1e49",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ebc76593-f6bf-490d-b789-c909f3a0f02e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "54cf9923-02cc-48e8-bfaa-8ddbea92bb38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
},
"equipment_family_id": "ee78efd5-b8ba-4274-9a19-ab028047ab54",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ac4b12d1-3790-42b5-8434-98af81bc258a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c33e0814-4a39-4296-8f81-b74ce57533d9",
"_parent_code": "sample string 6",
"sales_organization_id": "ef9f69bf-9846-4a5c-9111-5c0295581e53",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
},
"date_in_production_since": "2026-05-30T14:54:29.4104562+00:00",
"date_out_of_production_since": "2026-05-30T14:54:29.4104562+00:00",
"date_end_support": "2026-05-30T14:54:29.4104562+00:00",
"sales_organization_id": "409adfb5-9bfb-435f-9080-75b0a197e427",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+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-30T14:54:29.4104562+00:00"
},
"project_status_id": "d2655c17-69aa-402e-bc52-6e21b7218ac5",
"project_status_code": "sample string 10",
"project_status": {
"id": "bdf7580b-4402-45de-91bd-41812becc60e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "922df1ca-a37d-4c6e-b0fe-4054ffbbc1f5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
},
"company_id": "bbcac22c-3000-4799-a07a-c966a06934c3",
"company_code": "sample string 12",
"db_address_id": "1cccb7d5-4458-44d8-ae6d-9b890ed6fd4f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b32063ca-d2d4-419a-8c8b-1388cc276e13",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cb81217a-e1f2-44d8-8468-9e753dc8210f",
"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-30T14:54:29.4104562+00:00",
"date_create": "2026-05-30T14:54:29.4104562+00:00",
"date_update": "2026-05-30T14:54:29.4104562+00:00",
"updated_by_user_id": "e4fe8eb3-4ea1-4cd1-885e-413b55eeb91c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T14:54:29.4104562+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T14:54:29.4104562+00:00",
"date_last_job": "2026-05-30T14:54:29.4104562+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T14:54:29.4104562+00:00",
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00",
"is_mobile_installation": true
},
"job_type_id": "659e775d-8b00-4273-bff7-ac8fa47260a5",
"job_type_code": "sample string 7",
"job_type": {
"id": "ff81391e-2264-41f2-87f4-3e30675c9e6a",
"name": "sample string 2",
"sales_organization_id": "b20ef69c-b36e-44ed-b9b8-2b903d4b7457",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00",
"code": "sample string 7"
},
"job_priority_id": "eb0f15d5-8f75-4274-a123-b353b1501d8b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0eb505ba-d22c-4150-8759-3b61ff745cbe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "51469cab-1dd8-4bc4-b307-a16987266659",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
},
"job_status_id": "32e21a05-12df-416c-9f10-a9d9db85ecb7",
"job_status_code": "sample string 11",
"db_address_id": "6c7e8213-83fb-4c0c-b2ca-8145020c7990",
"contact_id": "ab5bddac-6fb2-4b3f-b91c-c3c8eadf75c1",
"requested_by_company_id": "c6cdf93b-d115-4a12-a966-1b38f5265556",
"requested_by_contact_id": "1b387fd4-28b3-4ac8-8919-480678229f4a",
"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-30T14:54:29.4104562+00:00",
"due_date": "2026-05-30T14:54:29.4104562+00:00",
"date_create": "2026-05-30T14:54:29.4104562+00:00",
"date_update": "2026-05-30T14:54:29.4104562+00:00",
"date_closed": "2026-05-30T14:54:29.4104562+00:00",
"suggested_user_id": "e20988f5-361a-4636-a399-f0062032fee7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "038b7ff2-527e-4e06-a380-8daa568806d1",
"db_language_id": "79097b71-b0bd-4389-89f6-a1e8c617738d",
"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-30T14:54:29.4104562+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a655b37c-bb8b-41f5-a1c8-a289c41c847a",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2380a36-ecd1-43ef-b863-b941ec04ac9f",
"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": "71a768fb-4a06-45b2-9ee4-3ffe25c49cd0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "67c600ce-3b6e-499f-9b88-a7f511c66339"
},
"suggested_date_start": "2026-05-30T14:54:29.4104562+00:00",
"skill_id": "ca852024-554b-4d3b-9c52-b0df847d7f3f",
"skill_code": "sample string 32",
"skill": {
"id": "0d2259f0-37c4-4681-a7df-7dc307d700f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e60167c9-839d-4b48-8e7a-7af4b564098e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3b138fc4-64e2-4ae7-89ee-6232e94bd2b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40b4f2fe-c776-4207-82a9-fc8c94c1f659",
"db_currency_id": "d17f8f82-77a5-4e1f-9cfb-bad3ccb22930",
"db_language_id": "cedb38bb-8abf-4300-b5ba-a39c57311cac",
"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-30T14:54:29.4104562+00:00"
},
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "90989704-3551-4eef-8d28-ce48b588fd71",
"date_reported_by_company": "2026-05-30T14:54:29.4104562+00:00",
"id2": 36,
"company_id": "f5e898ad-0a9c-4a04-8f35-8143769070df",
"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": "3a2f948b-a0cd-4210-80ef-ba9dffded3aa",
"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-30T14:54:29.4104562+00:00"
},
"work_instruction_details_id": "3806f2dc-d38a-49ea-a681-fc748214bab9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0506466a-e093-47d3-9213-fa8597171545",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29e681df-071e-4948-8bd6-8c487191a2f1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T14:54:29.4104562+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": "d63e105a-38bc-409c-9b06-e8fdcf33fefa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T14:54:29.4104562+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.