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": "c3ea35eb-795d-4a35-94b4-1dcf11030c35",
"jobs_id": "c52d5dfc-f357-44a5-992e-f9cb50d60079",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fc994de1-4617-49df-b78d-a50bbdc3e98f",
"_parent_id": "3ca2526b-3f39-43cb-8362-70fdf32b6ac0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1f17fb15-c492-48c4-96e6-a1d3df8df72e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "78cf644d-968c-4306-afa5-4b1c34760ba7",
"_parent_id": "9e618faf-1f66-495e-a500-5aea0547e052",
"root_parent_id": "e09d0c87-6b1f-4e7f-81f5-9521ef06ae7b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "752b9014-696c-4766-8479-de9c063e7386",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4998f6de-9723-4044-ae00-cc189cf3d68a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "033e890c-c0a7-4160-86d6-b15ffe23c5ed",
"_parent_code": "sample string 6",
"sales_organization_id": "52bd4b86-b349-4edc-879a-20a24bb6b389",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00"
},
"equipment_model_id": "89fd2c88-b308-413d-bdc7-5f2141637eb9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aab661fe-f37d-494e-a7bc-0b59855ebfce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c026bedd-e23f-4355-8550-aa4b4e28f915",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "87cb1595-c572-45cd-80a3-a79cb121c384",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "154178f0-f887-40dc-9eec-b2035020ec48",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00"
},
"equipment_family_id": "4554ab4e-c758-49ed-9762-465478ce2b55",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4998f6de-9723-4044-ae00-cc189cf3d68a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "033e890c-c0a7-4160-86d6-b15ffe23c5ed",
"_parent_code": "sample string 6",
"sales_organization_id": "52bd4b86-b349-4edc-879a-20a24bb6b389",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00"
},
"date_in_production_since": "2026-11-15T18:03:09.3392475+00:00",
"date_out_of_production_since": "2026-11-15T18:03:09.3392475+00:00",
"date_end_support": "2026-11-15T18:03:09.3392475+00:00",
"sales_organization_id": "0b638b5f-30fc-4e60-a07d-0b17577b7245",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+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-11-15T18:03:09.3392475+00:00"
},
"project_status_id": "3e93ed30-981f-42ff-bd5d-9b4fca5d70bd",
"project_status_code": "sample string 10",
"project_status": {
"id": "e8a3f367-e853-4939-883e-c51fc54e9b1e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "34fcc754-2dba-44ca-a38b-38445a206920",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00"
},
"company_id": "38fd30b8-8514-4e10-9889-6330e494123d",
"company_code": "sample string 12",
"db_address_id": "a07abae2-58d6-44df-840f-7cf0e4fc920c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2913a9e0-e95f-43c9-9fc6-f746ab88620a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "32f242cb-d873-47af-b281-ef6e6367d8c3",
"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-11-15T18:03:09.3392475+00:00",
"date_create": "2026-11-15T18:03:09.3392475+00:00",
"date_update": "2026-11-15T18:03:09.3392475+00:00",
"updated_by_user_id": "63646c88-5b08-451a-9e81-646e38b4a3d7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-15T18:03:09.3392475+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-11-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-15T18:03:09.3392475+00:00",
"date_last_job": "2026-11-15T18:03:09.3392475+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-15T18:03:09.3392475+00:00",
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00",
"is_mobile_installation": true
},
"job_type_id": "9c0d6d4a-4c86-4f6c-bc60-4edf80a0a91a",
"job_type_code": "sample string 7",
"job_type": {
"id": "39d69b3e-97c5-448d-a50b-6ae8d8889695",
"name": "sample string 2",
"sales_organization_id": "5727e066-9c84-4ab7-bf73-76da7c3fafe9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00",
"code": "sample string 7"
},
"job_priority_id": "f65ff8b8-8575-46fb-a1a3-0ab6cae1a92a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a4561ec5-20a1-4fc3-8645-453dddba7f12",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "74f9d320-58b0-421c-b98f-8b4ffb9ff636",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00"
},
"job_status_id": "c8ac6019-acbd-48f1-bdec-9add2ae4e640",
"job_status_code": "sample string 11",
"db_address_id": "5d709f61-c51c-4b74-8506-b2207f52ff38",
"contact_id": "48fe27a2-d606-45e0-bd40-3d75bb1265f0",
"requested_by_company_id": "3fe10b13-ad80-48ae-9c00-83110ecf8ef0",
"requested_by_contact_id": "30ce6080-725d-4749-bab7-3f507f33eee6",
"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-11-15T18:03:09.3392475+00:00",
"due_date": "2026-11-15T18:03:09.3392475+00:00",
"date_create": "2026-11-15T18:03:09.3392475+00:00",
"date_update": "2026-11-15T18:03:09.3392475+00:00",
"date_closed": "2026-11-15T18:03:09.3392475+00:00",
"suggested_user_id": "5b512191-c7a5-405c-9ca1-afc3ad064fc8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "67fde136-bbc9-4ac4-bb48-a6bbd5471677",
"db_language_id": "c1bd60d7-cca5-485b-b243-4bd8cee86af9",
"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-11-15T18:03:09.3392475+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e375c777-748a-4ca4-b991-37c7f27b943d",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "994b6a7a-5559-4f18-943a-c00237d11770",
"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": "a4b106ce-688b-4062-a849-e0c784a15bb5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-15T18:03:09.3392475+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ba08c9e4-a89d-4cec-a52d-a76d6de17c70"
},
"suggested_date_start": "2026-11-15T18:03:09.3392475+00:00",
"skill_id": "cbe09807-1b6b-4a6d-b17e-346142442111",
"skill_code": "sample string 32",
"skill": {
"id": "1afeb3c9-a1af-4c6a-a499-5ecec033039a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "92b90e32-2b8e-4960-9771-0be9606a711c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74d06c95-0a14-4d2d-97b5-8458e9f2d2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47f41f85-447c-4288-a430-872495bc63b5",
"db_currency_id": "7121bcc9-df91-463d-9ac0-0fe0fdb45da2",
"db_language_id": "1654169d-9dc8-46f7-9e4e-86b94473bcc7",
"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-11-15T18:03:09.3392475+00:00"
},
"modified_dateutc": "2026-11-15T18:03:09.3517943+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aa109657-e80e-466e-82e2-3250ff88ec67",
"date_reported_by_company": "2026-11-15T18:03:09.3517943+00:00",
"id2": 36,
"company_id": "dc94d697-1a13-478a-bf3d-53fe74836526",
"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": "fc2bf7fb-81f2-45e9-86d4-601293ca0156",
"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-11-15T18:03:09.3517943+00:00"
},
"work_instruction_details_id": "72c6b973-a653-4c2d-b8fa-a84f18ed7587",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ca5dca7-b6bb-4e81-878f-661c1b1fe201",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a85659e7-22b5-4f47-a31d-7b5ad596438d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-15T18:03:09.3517943+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": "0a40ae83-a8b2-4072-adb9-d5d16111675f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-15T18:03:09.3517943+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.