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": "f400a4e3-73c3-45db-b8b1-32d463ca53cb",
"jobs_id": "10c135e2-683d-4649-a638-c293348bc711",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "380ffb19-32cb-4cdd-96e4-72492f2a844b",
"_parent_id": "97ac4433-3285-4158-b3ee-d717cd4e30fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8623ff0b-fec8-4fc1-a970-c7b66f5364de",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5787439e-8c5c-4bf5-bfcc-31e42a2ded23",
"_parent_id": "dbe83c28-4a4d-49f0-99f0-04a12cd7afd7",
"root_parent_id": "bb24344a-fbc9-4e2f-8d20-43227d7767b1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "03644697-5490-433b-bdaa-7c1e65ae746e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "55f98e50-b833-4e42-9d46-d5323500d4aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "910cfc18-ebf8-46e0-bd8d-a3a3dc55d610",
"_parent_code": "sample string 6",
"sales_organization_id": "9a2a3284-d00d-4bda-96d3-2e219e556de2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
},
"equipment_model_id": "3f67d095-0a0d-494e-8379-3f3c9bd6c20b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8f444c78-9913-4077-9025-c00ffbd6e41b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0b31b392-fdc9-4342-aedb-6c6a6d5df512",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4317f8b3-5e79-49b3-9a60-bcf853394c50",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "577c070b-1993-4380-9534-3deb5417033b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
},
"equipment_family_id": "55aa8b24-72b0-4c2e-9638-f5c5ce9b577e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "55f98e50-b833-4e42-9d46-d5323500d4aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "910cfc18-ebf8-46e0-bd8d-a3a3dc55d610",
"_parent_code": "sample string 6",
"sales_organization_id": "9a2a3284-d00d-4bda-96d3-2e219e556de2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
},
"date_in_production_since": "2026-06-07T00:25:31.2625314+00:00",
"date_out_of_production_since": "2026-06-07T00:25:31.2625314+00:00",
"date_end_support": "2026-06-07T00:25:31.2625314+00:00",
"sales_organization_id": "1566545e-a597-4077-91ac-51733de557f0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+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-06-07T00:25:31.2625314+00:00"
},
"project_status_id": "ef38bd08-200d-49af-9bac-9ba9d82e1d64",
"project_status_code": "sample string 10",
"project_status": {
"id": "3834074d-3dd0-43fb-a6fc-3c6c54a15f61",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "74c9c374-60de-427f-88ba-475b73061699",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
},
"company_id": "79fcb5be-df2c-419c-a7ea-be6bb74c37aa",
"company_code": "sample string 12",
"db_address_id": "f26c56cd-93ba-499a-a181-8313868850aa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "338f29d4-576a-4d43-99d0-d5b9e9a108e2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f0cb7770-053b-4d9e-a538-4ea80440cc52",
"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-06-07T00:25:31.2625314+00:00",
"date_create": "2026-06-07T00:25:31.2625314+00:00",
"date_update": "2026-06-07T00:25:31.2625314+00:00",
"updated_by_user_id": "de5e35de-1ee3-4eda-ab3a-9ad225ee0c99",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-07T00:25:31.2625314+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-06-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-07T00:25:31.2625314+00:00",
"date_last_job": "2026-06-07T00:25:31.2625314+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-07T00:25:31.2625314+00:00",
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00",
"is_mobile_installation": true
},
"job_type_id": "41d8131f-c102-4770-bc26-5c470ddee5ab",
"job_type_code": "sample string 7",
"job_type": {
"id": "9d712029-f8f8-483c-a7a2-a83da7f42705",
"name": "sample string 2",
"sales_organization_id": "44b09e2a-f070-49af-b333-1307318dca1c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00",
"code": "sample string 7"
},
"job_priority_id": "5a0a11b8-09aa-4e32-ac09-a6e8db97ca21",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cba1644a-1a71-4dd7-81d8-906b3ea63d80",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e1f5394b-e17a-4b81-8664-3e7b19091b45",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
},
"job_status_id": "fc2600bf-630b-44d2-987c-3b93713d5fa9",
"job_status_code": "sample string 11",
"db_address_id": "814a3f3d-6802-4a80-8815-75aa207405db",
"contact_id": "1c45b4c6-241c-4c4e-9d62-72c35a33651b",
"requested_by_company_id": "197ebb00-f160-462e-9f40-cb7d2d3fe57c",
"requested_by_contact_id": "d2302cc1-b71c-48b4-9ae4-f39043d17025",
"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-06-07T00:25:31.2625314+00:00",
"due_date": "2026-06-07T00:25:31.2625314+00:00",
"date_create": "2026-06-07T00:25:31.2625314+00:00",
"date_update": "2026-06-07T00:25:31.2625314+00:00",
"date_closed": "2026-06-07T00:25:31.2625314+00:00",
"suggested_user_id": "666445cd-af0f-4941-8703-cc7eb43952a8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f0ba0e6c-e171-4d3e-93db-82b8c28d2ec4",
"db_language_id": "c87d2ff0-efc5-43f9-a8e4-01750f9cf5eb",
"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-06-07T00:25:31.2625314+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "55e92f58-0604-466c-8d35-5ec29f8878e6",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "15b94256-042d-4a65-8788-0842a3886cb8",
"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": "42a08f6d-333a-4eb0-b4e1-e71e2cb20e56",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "912982be-e955-4e89-92a7-78c3423c89ec"
},
"suggested_date_start": "2026-06-07T00:25:31.2625314+00:00",
"skill_id": "f9102227-d7ab-4579-b284-c856018271ba",
"skill_code": "sample string 32",
"skill": {
"id": "03bac0cd-48f1-47c3-85b7-35d187ccd99e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "415b453b-bc90-442b-9948-da3a749ce174",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7016cf98-7d3e-4a2e-bf80-823a9668ada1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "74657b12-1235-4e19-967b-57d16639594b",
"db_currency_id": "89774366-ba1a-431a-995b-623f84040cb4",
"db_language_id": "f3477846-4ea0-42c3-bdb8-868b52f68816",
"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-06-07T00:25:31.2625314+00:00"
},
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d9f3d1eb-b35b-42c8-9820-6ae3f0294fc4",
"date_reported_by_company": "2026-06-07T00:25:31.2625314+00:00",
"id2": 36,
"company_id": "ce1ac4be-4cf4-465b-a810-d085ab4e7c5f",
"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": "7bfcee42-ece8-4133-94c0-64eae556c97a",
"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-06-07T00:25:31.2625314+00:00"
},
"work_instruction_details_id": "719c4280-5c8d-4826-81ec-3ea1781de4a0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "19e9bec3-fcf8-47fb-a29d-52925f6d3dca",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "85b7b23d-4462-4c68-aab4-c89ae99efb3c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-07T00:25:31.2625314+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": "379eeee0-e834-4391-b910-b66dd1b99423",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-07T00:25:31.2625314+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.