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": "8a19fbed-65cf-4c1b-b412-1054ecbe8873",
"jobs_id": "b83d9248-6c21-4b97-8afe-b22781a41cc1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "138ea4e5-47ed-4906-a696-ced4cbcad656",
"_parent_id": "e175a3aa-ef11-45d3-afe2-9489299ba397",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2c822063-b314-474d-b0da-83db09421f2c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "784a5b78-4302-4650-8cfe-f9814be193b5",
"_parent_id": "73001d7b-b589-4ab6-ae16-fce93f891c1c",
"root_parent_id": "053676b8-9bbf-47d2-beee-dc67cdd5ee0c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a8f05a97-f181-44fc-a213-c9e50dfd041e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1e109b98-b774-4adb-9e88-cc65cb9e56cd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "68343031-e5bc-44fe-96d0-154d0ee48097",
"_parent_code": "sample string 6",
"sales_organization_id": "2d41dd48-eb65-43c2-8fa4-223046da4829",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00"
},
"equipment_model_id": "1030c2f3-1344-4cfb-8d2a-1a06fd58518b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "97a58230-0a2f-41b7-9663-fa89edc620fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4949d6c7-2d78-44eb-99ee-32ac873021f2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ceedb768-f3ac-46b9-a165-2452bb9c7c40",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cb6de7f7-0904-4f88-b156-2640c3ae83c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00"
},
"equipment_family_id": "1d046d53-4730-4ed0-9f16-c5169e02a04e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1e109b98-b774-4adb-9e88-cc65cb9e56cd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "68343031-e5bc-44fe-96d0-154d0ee48097",
"_parent_code": "sample string 6",
"sales_organization_id": "2d41dd48-eb65-43c2-8fa4-223046da4829",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00"
},
"date_in_production_since": "2026-01-22T22:40:19.8971388+00:00",
"date_out_of_production_since": "2026-01-22T22:40:19.8971388+00:00",
"date_end_support": "2026-01-22T22:40:19.8971388+00:00",
"sales_organization_id": "66925936-890c-405c-a95c-25fc4e6b8a0e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+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-01-22T22:40:19.8971388+00:00"
},
"project_status_id": "cdd7cbab-2fa4-4201-a353-82cdca26f392",
"project_status_code": "sample string 10",
"project_status": {
"id": "4d5e03c7-4389-4832-96e4-1ebc37e368d9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1a44a362-ecbb-48c3-b175-a27c79cb9049",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00"
},
"company_id": "01f14dff-99fb-43b4-9915-db689f0f3439",
"company_code": "sample string 12",
"db_address_id": "23f88d85-99ce-49ba-aaf5-c533abdd9443",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5dddf090-3f35-4420-987d-5675603c485f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2fe06a65-ef77-4cd4-9d76-82cdd76ea983",
"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-01-22T22:40:19.8971388+00:00",
"date_create": "2026-01-22T22:40:19.8971388+00:00",
"date_update": "2026-01-22T22:40:19.8971388+00:00",
"updated_by_user_id": "5e711303-352c-4646-a6b0-f3f79d21699b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-22T22:40:19.8971388+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-22T22:40:19.8971388+00:00",
"date_last_job": "2026-01-22T22:40:19.8971388+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-22T22:40:19.8971388+00:00",
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00",
"is_mobile_installation": true
},
"job_type_id": "1ab00580-5a36-46bc-b528-c798ff575174",
"job_type_code": "sample string 7",
"job_type": {
"id": "7468fccf-baa9-440f-9126-46fa6fd2541d",
"name": "sample string 2",
"sales_organization_id": "da6ec133-2537-4d9b-adf2-387c3fafa6b6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00",
"code": "sample string 7"
},
"job_priority_id": "c4279af1-06e8-4913-8d7b-396485264d2e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5d4800d4-2c7a-49f8-9d44-64a94e8dc3ef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4230f040-5a71-4ed3-8d5c-ef5f29edc98d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-22T22:40:19.8971388+00:00"
},
"job_status_id": "5a6f0f6f-9c88-4e4d-bb42-a9d971424ea2",
"job_status_code": "sample string 11",
"db_address_id": "423e6da6-5fcc-4fa8-b123-0ba9160794be",
"contact_id": "c3cdafd6-8a64-4ce5-b268-82b85e72a92a",
"requested_by_company_id": "67ccd85b-5fbd-4251-a454-dc581c6103d9",
"requested_by_contact_id": "2b8fb54d-29ea-4202-ba6f-a1d40f924aa2",
"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-01-22T22:40:19.9127506+00:00",
"due_date": "2026-01-22T22:40:19.9127506+00:00",
"date_create": "2026-01-22T22:40:19.9127506+00:00",
"date_update": "2026-01-22T22:40:19.9127506+00:00",
"date_closed": "2026-01-22T22:40:19.9127506+00:00",
"suggested_user_id": "57d0e5e0-6c65-42d9-b012-4d25cee22d6d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fcc44d3e-6d05-4410-a152-4be89f3e911f",
"db_language_id": "84719e57-577b-4212-9672-552b88455763",
"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-01-22T22:40:19.9127506+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a672ce4e-d4f7-41a2-9d02-85000ea08102",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4b018184-0f25-4ec7-94a5-066e16e8c1eb",
"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": "159936fc-40f4-41a7-81ec-cec74dd2280d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-22T22:40:19.9127506+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f15b2ab9-e7f5-424f-88f8-025b81d7b72b"
},
"suggested_date_start": "2026-01-22T22:40:19.9127506+00:00",
"skill_id": "9c015cb9-6b04-4906-88fb-f4e603ae91f9",
"skill_code": "sample string 32",
"skill": {
"id": "0cb45ed5-ea78-4232-977a-a6c8abd7f3fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2d51e4bc-362b-42de-bcd6-1880aa792209",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "44c4843d-18c2-4a95-9653-f22af24f2685",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2afa3de1-c83b-41f0-b632-84d03020a7ee",
"db_currency_id": "b8cb3484-4a61-4a49-ba3e-fd4ba559de0d",
"db_language_id": "0a69093e-8016-4670-827e-da750a6fd882",
"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-01-22T22:40:19.8971388+00:00"
},
"modified_dateutc": "2026-01-22T22:40:19.9127506+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "88eaf304-6dd2-4ede-8f20-847a2fe0ebb3",
"date_reported_by_company": "2026-01-22T22:40:19.9127506+00:00",
"id2": 36,
"company_id": "a071aca3-916c-496e-b808-39f7a03520a4",
"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": "309d3465-def2-4022-aa4b-85a0931d6bbb",
"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-01-22T22:40:19.9127506+00:00"
},
"work_instruction_details_id": "dc31c6b4-1d30-4c10-96aa-a42f5bfc9f0b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2d205f76-4548-465b-82fb-741c27c74d15",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c49328b2-a046-464b-ac65-e591c3d757b1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-22T22:40:19.9127506+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": "52dd8792-4f62-45b2-8a42-521953284b97",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-22T22:40:19.9127506+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.