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": "d4c206d9-5c8e-4668-9f71-c5ebabb88eb4",
"jobs_id": "4f870ef6-141c-4986-97b6-1de90c907cdb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d054e966-7c68-4420-8205-41d9689f7948",
"_parent_id": "53813af1-7b6e-4892-a50d-a924827a33a6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0ac88059-e7b2-42e3-852c-0ad30fd78d35",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77ee598d-f118-4b7f-84f3-2b8bb9481f09",
"_parent_id": "8d221507-3780-4ded-860a-3ad135db740b",
"root_parent_id": "60743cde-63e3-45bd-ab2e-bcbe334289a8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "95f777ee-3ece-4f03-9b81-6fee3defac44",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eb327a9a-fa06-498f-9359-7fec65dcaa4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1efa5d25-a434-4088-8686-5c89c42aac3d",
"_parent_code": "sample string 6",
"sales_organization_id": "0c9f1b96-757b-4d6f-9fcd-1a8daa431c09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"modified_dateutc": "2026-10-20T16:36:09.1751862+00:00"
},
"equipment_model_id": "92f0e881-1c1d-4d7c-bbbf-16c83ac00aff",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4d3beb25-acd3-4ace-95f6-3f509b2539ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d101bf6d-dad4-4b28-b325-592b6ce2fc44",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "160d486a-d261-411b-b1d6-47225ec7b99b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3aebc7ca-7fd7-4a43-9996-22e8e2de4f54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"modified_dateutc": "2026-10-20T16:36:09.1751862+00:00"
},
"equipment_family_id": "9cb7f60e-f036-4954-a3a1-80857e189338",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eb327a9a-fa06-498f-9359-7fec65dcaa4d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1efa5d25-a434-4088-8686-5c89c42aac3d",
"_parent_code": "sample string 6",
"sales_organization_id": "0c9f1b96-757b-4d6f-9fcd-1a8daa431c09",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"modified_dateutc": "2026-10-20T16:36:09.1751862+00:00"
},
"date_in_production_since": "2026-10-20T16:36:09.1751862+00:00",
"date_out_of_production_since": "2026-10-20T16:36:09.1751862+00:00",
"date_end_support": "2026-10-20T16:36:09.1751862+00:00",
"sales_organization_id": "ec5acb13-fe38-44be-a69c-55b9334861a3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+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-10-20T16:36:09.1880629+00:00"
},
"project_status_id": "e83898e3-ca58-4653-933a-a543cfd5fb0d",
"project_status_code": "sample string 10",
"project_status": {
"id": "3f07980e-8e88-4967-838b-6cefdc8ee581",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e4a8309d-4e20-4b10-ad32-c0d13bc66222",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00"
},
"company_id": "185fc51f-c9ea-4321-bfe9-0c2226f73971",
"company_code": "sample string 12",
"db_address_id": "ec5f6df3-3c88-4d1a-9e90-92531a1a5b05",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2b6d1c91-b87d-4d2c-a47d-2ce3d0a53f2b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f65e9548-0d66-4857-a841-63fd04b94cae",
"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-10-20T16:36:09.1880629+00:00",
"date_create": "2026-10-20T16:36:09.1880629+00:00",
"date_update": "2026-10-20T16:36:09.1880629+00:00",
"updated_by_user_id": "bd0dc2e0-6477-41ad-b1cc-48116a7d636c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-20T16:36:09.1880629+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-10-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-20T16:36:09.1880629+00:00",
"date_last_job": "2026-10-20T16:36:09.1880629+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-20T16:36:09.1880629+00:00",
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00",
"is_mobile_installation": true
},
"job_type_id": "b85dfde5-5e71-4b0a-bad8-8883ec3dfb1d",
"job_type_code": "sample string 7",
"job_type": {
"id": "6563c28d-ceeb-4f52-b0d6-1e039195aa58",
"name": "sample string 2",
"sales_organization_id": "a0347772-d9b2-4527-aeee-61ab413453c6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00",
"code": "sample string 7"
},
"job_priority_id": "0db5cb82-ece5-49cc-aa3c-019ae3f6ace9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f1edc2fa-6114-4f31-9560-8ff4938c438c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9c8de81f-cb9f-402c-9468-9b64bba574c9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00"
},
"job_status_id": "45963a4f-a417-4674-9b7b-219eb9432167",
"job_status_code": "sample string 11",
"db_address_id": "7fd841fa-7bbf-4a55-b747-1b57a9d8c937",
"contact_id": "41e5feb2-4d96-4f13-8ec5-535c81154c07",
"requested_by_company_id": "4a898595-3c9f-4a37-be69-caaf0a91731b",
"requested_by_contact_id": "641d3ddf-5eba-45fd-b085-aee0ee48abac",
"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-10-20T16:36:09.1880629+00:00",
"due_date": "2026-10-20T16:36:09.1880629+00:00",
"date_create": "2026-10-20T16:36:09.1880629+00:00",
"date_update": "2026-10-20T16:36:09.1880629+00:00",
"date_closed": "2026-10-20T16:36:09.1880629+00:00",
"suggested_user_id": "5c1317c7-eb2f-47c8-90a3-5f4af8b1c763",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f116ce12-f26d-47db-afb6-18e8efeae6c1",
"db_language_id": "296b7866-4b7d-4dff-89e8-a01df951cd60",
"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-10-20T16:36:09.1880629+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "662354ea-7dda-46f9-a268-b5e186852739",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "de3cbc2f-04ec-47af-9924-d10d25b75ef3",
"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": "6afb921a-de52-4735-a5ab-dd481af6facc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3df3957e-4451-4cbc-8d3e-31305747f5e4"
},
"suggested_date_start": "2026-10-20T16:36:09.1880629+00:00",
"skill_id": "e1e1ce9f-7d7d-4edd-ac4c-178e37b2a8d2",
"skill_code": "sample string 32",
"skill": {
"id": "938cd6e9-0d35-4f3a-a36e-b417b2963bf4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c08d2096-c509-4524-869d-42941693636a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a6316e82-f6da-4d79-a17c-48641d1948be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1cf591cb-d5e8-436d-8f58-75249edad8a8",
"db_currency_id": "6bae8737-e14a-4afc-be3e-2686efad035a",
"db_language_id": "cf36b00a-5816-460e-8866-d2888852ba26",
"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-10-20T16:36:09.1751862+00:00"
},
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "28d73ca3-be8c-4e4d-8105-1f593b96269d",
"date_reported_by_company": "2026-10-20T16:36:09.1880629+00:00",
"id2": 36,
"company_id": "c156963c-0e56-4ed6-a794-634e1081cee2",
"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": "5b427a7c-6b62-4119-81c1-07c2bd8a6bd4",
"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-10-20T16:36:09.1880629+00:00"
},
"work_instruction_details_id": "2dee2719-cdde-4a6d-926c-65a16454cf14",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9169fa44-834f-4be4-ba81-266139f48ed6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "76ba31f7-21cf-42d0-963c-95badb89a44d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-20T16:36:09.1880629+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": "26b3faed-f2da-4498-a108-54427b3d2e11",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-20T16:36:09.1880629+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.