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": "eb985fc9-e8c0-4fcb-860c-c6490fa328c9",
"jobs_id": "bb5885d3-122d-4c71-ab63-a9fb8204f821",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c3460660-7a63-4cc6-9a3c-24f076b99552",
"_parent_id": "a62ecbb0-8ac7-4127-8304-1ac43ec6323a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1faffb8b-4ba1-402d-9773-4a50b1807fa9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a5057590-49b0-41c0-ba6b-15fe5cc6ad73",
"_parent_id": "b83de7cd-a8c1-4bbb-8fa0-57772c487bb0",
"root_parent_id": "56546d49-c4d1-41e9-98a4-6c0a3b8adfd3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6fca2ed4-5d6d-4007-8d99-1b798ec4744f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "af996490-d365-4c23-9981-beda6f0c3f69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0743215a-713e-4baa-b719-aa998c372bd2",
"_parent_code": "sample string 6",
"sales_organization_id": "af706dc9-72e8-4dee-abb4-02b70945db8d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
},
"equipment_model_id": "95957622-fc65-4189-a32a-f264408a51a1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c8ec8524-dbf0-4d75-a656-62fccf62ac36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b43cd1e-05b4-4af0-ab85-7dc36d8add13",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d78196a1-02bf-4723-ba73-1e50f322a0e7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f4fa50f2-118b-4628-9f8d-2da62a21e91a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
},
"equipment_family_id": "dae476d6-7c8f-4a72-a47c-56ad0be77334",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "af996490-d365-4c23-9981-beda6f0c3f69",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0743215a-713e-4baa-b719-aa998c372bd2",
"_parent_code": "sample string 6",
"sales_organization_id": "af706dc9-72e8-4dee-abb4-02b70945db8d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
},
"date_in_production_since": "2026-03-12T03:54:49.7298567+00:00",
"date_out_of_production_since": "2026-03-12T03:54:49.7298567+00:00",
"date_end_support": "2026-03-12T03:54:49.7298567+00:00",
"sales_organization_id": "d0dd4a28-314d-49e3-ad81-87eb4f15ccf2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+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-03-12T03:54:49.7298567+00:00"
},
"project_status_id": "bfef2b9a-1590-4265-a58d-88ec24bd8981",
"project_status_code": "sample string 10",
"project_status": {
"id": "297a8fa7-af2a-454b-9ec0-893bc4a490a3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50643367-af6d-4031-bec9-60d25ed590fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
},
"company_id": "f4111030-50f6-439d-8898-07acbcd9a666",
"company_code": "sample string 12",
"db_address_id": "a3f8adaa-8d27-47c9-8c9e-0bb5d48feb8d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d8c51266-2f5e-4e2b-83e1-66b0b833e94d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1135deed-95f8-4301-813b-0212138de11b",
"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-03-12T03:54:49.7298567+00:00",
"date_create": "2026-03-12T03:54:49.7298567+00:00",
"date_update": "2026-03-12T03:54:49.7298567+00:00",
"updated_by_user_id": "9ef47d67-b8f9-43e3-9203-b4de4ffb90dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T03:54:49.7298567+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T03:54:49.7298567+00:00",
"date_last_job": "2026-03-12T03:54:49.7298567+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T03:54:49.7298567+00:00",
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00",
"is_mobile_installation": true
},
"job_type_id": "9a3fa949-522f-4873-bcf1-82e877552bf6",
"job_type_code": "sample string 7",
"job_type": {
"id": "7244f025-a866-41b7-9f48-d37afa674add",
"name": "sample string 2",
"sales_organization_id": "0e6c65c1-fcee-4d36-826c-e83dd040c750",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00",
"code": "sample string 7"
},
"job_priority_id": "cc4240ca-9657-407d-85fd-e6f90f59ba73",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "73d955a6-78d1-4f4c-97da-6254b7f273f1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3a79e5ec-9942-4105-904d-3c96fbca68ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
},
"job_status_id": "5a4b1e2a-03ee-40c2-8717-5d3928d90562",
"job_status_code": "sample string 11",
"db_address_id": "26c33a76-5e5a-4fe9-8f42-056d31d19f02",
"contact_id": "0ba03bb8-4795-410b-88c3-1f39193f62f5",
"requested_by_company_id": "4781d7d3-d751-4a8f-93e5-682184deaddd",
"requested_by_contact_id": "346945db-3243-4c38-90dd-c95e8d1de236",
"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-03-12T03:54:49.7298567+00:00",
"due_date": "2026-03-12T03:54:49.7298567+00:00",
"date_create": "2026-03-12T03:54:49.7298567+00:00",
"date_update": "2026-03-12T03:54:49.7298567+00:00",
"date_closed": "2026-03-12T03:54:49.7298567+00:00",
"suggested_user_id": "d0aa0e2c-c94f-485e-90cd-a68aed3ddefa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e95d98be-c35d-495d-ba43-22a763795a14",
"db_language_id": "f153d8b5-7ea7-4c45-82c2-e009046fb290",
"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-03-12T03:54:49.7298567+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f810ebc3-f4a0-47d5-aaa4-e20e3507df38",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2ad1aac5-ac2e-468b-9fe7-171ef6ba58f0",
"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": "266b42f2-fbb4-4d97-89ca-2606a0039d5c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84163251-9ea3-45ee-924b-d1de8c12b938"
},
"suggested_date_start": "2026-03-12T03:54:49.7298567+00:00",
"skill_id": "bef8b9be-01ce-4427-9550-33f63d9206fd",
"skill_code": "sample string 32",
"skill": {
"id": "be66a934-0761-4950-8b0d-7dfd75f6ba19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "429863aa-368c-48be-a0b7-d105b16e4633",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18114c03-ab04-4b0e-bd4b-73ebdfe1db85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98605dcf-65bd-493f-893d-5da4beca2ad3",
"db_currency_id": "f956cef5-fe0c-4126-83fc-ebd72ed34fb4",
"db_language_id": "22f7ace8-0712-4b84-ac23-700754584544",
"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-03-12T03:54:49.7298567+00:00"
},
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9a0c6e3e-b4c0-415b-8680-10e313adb672",
"date_reported_by_company": "2026-03-12T03:54:49.7298567+00:00",
"id2": 36,
"company_id": "d44735c9-df51-41dd-b319-8ea76411ba6d",
"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": "ba4ba2d0-297a-4263-85e3-04be0ce47b33",
"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-03-12T03:54:49.7298567+00:00"
},
"work_instruction_details_id": "7eed2630-704e-47f7-a698-94c1c423aec1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "01c0b5cb-d06c-4b3d-82a4-8acf62b952a3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7e04ab1b-842f-4997-a7a1-cc3c2812a435",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T03:54:49.7298567+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": "740bbf66-3721-402b-8416-18023e617694",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T03:54:49.7298567+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.