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": "43a209d7-219e-43cd-9b08-38b329a57c75",
"jobs_id": "cb83aa7d-405d-4539-8bae-89b3c5dc2c25",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e59f48cf-88f1-4f07-b573-7895b4e0299b",
"_parent_id": "208e663a-9dcf-4a6b-aebf-4b6e960c3879",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "14afbece-f24c-4b85-a3a4-cf9e0515a8d2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "049f68b5-42ee-409f-a078-2416ca353418",
"_parent_id": "aaaeab70-40d8-4358-b34f-1697a4b379de",
"root_parent_id": "c7c3669b-f385-405a-8a2f-48849b04053a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "19c722de-149b-42d2-82ab-a617a5dc33da",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7648a2f2-1bee-4592-88d1-f0b608516e6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "474d2561-c995-44a1-856a-316ddae7e47b",
"_parent_code": "sample string 6",
"sales_organization_id": "4402f570-af63-43db-b603-b334cddd2777",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
},
"equipment_model_id": "d235f858-384a-4dd0-a7f0-b61165234219",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9c0470f9-f899-45ad-95a3-7d07b103b0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9d2d0efe-e395-4449-937a-3e90fccd8510",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3e07145-fa57-4db0-acd8-555154966dd6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "18e7fe6d-f788-4303-9186-268001accaad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
},
"equipment_family_id": "3e7b711a-5c6a-4baf-9923-41119b0d440c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7648a2f2-1bee-4592-88d1-f0b608516e6c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "474d2561-c995-44a1-856a-316ddae7e47b",
"_parent_code": "sample string 6",
"sales_organization_id": "4402f570-af63-43db-b603-b334cddd2777",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
},
"date_in_production_since": "2026-08-10T05:04:43.1611275+00:00",
"date_out_of_production_since": "2026-08-10T05:04:43.1611275+00:00",
"date_end_support": "2026-08-10T05:04:43.1611275+00:00",
"sales_organization_id": "69af088b-921c-4840-99f3-65d8f37d966f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+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-08-10T05:04:43.1611275+00:00"
},
"project_status_id": "295ac9d7-76cc-4268-86eb-4b983d2246c8",
"project_status_code": "sample string 10",
"project_status": {
"id": "94c14aaf-bbc9-4cd9-9313-36435e1ee61c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2cfb8df4-8bd2-4e08-8930-c3db1550972a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
},
"company_id": "8ee3ecca-3e19-4ca6-828e-1c7b672f6af0",
"company_code": "sample string 12",
"db_address_id": "630a5e35-7739-4801-b08f-0645ca8191e5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9572b208-69da-4c62-90ae-d4c46134af5e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "984db126-39c7-48ec-8a48-577e4bac62c8",
"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-08-10T05:04:43.1611275+00:00",
"date_create": "2026-08-10T05:04:43.1611275+00:00",
"date_update": "2026-08-10T05:04:43.1611275+00:00",
"updated_by_user_id": "9c5cfb9b-dfb4-43bb-ab2a-7a67c43b9691",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-10T05:04:43.1611275+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-08-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-10T05:04:43.1611275+00:00",
"date_last_job": "2026-08-10T05:04:43.1611275+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-10T05:04:43.1611275+00:00",
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00",
"is_mobile_installation": true
},
"job_type_id": "da0fc8b1-a949-4feb-8950-4b137da73a17",
"job_type_code": "sample string 7",
"job_type": {
"id": "b17e7eff-f7d1-4d78-90fe-9cd527d4ed06",
"name": "sample string 2",
"sales_organization_id": "9dcbbbbc-df0f-4478-b0dd-e80a5357e892",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d0fbb48-d004-458c-a6ff-ade86f72b272",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4f8f6930-4076-42b6-a3cd-1346596f7061",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d394c552-a163-4fae-9097-8e57e04f3284",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
},
"job_status_id": "828873a1-541c-42c1-bdd0-0f77e4d4516d",
"job_status_code": "sample string 11",
"db_address_id": "051b940f-9185-4bf4-9398-d468a137bac3",
"contact_id": "9dd4e4f7-e067-4aab-8ef1-c06a02295af0",
"requested_by_company_id": "9160f899-3ab4-4106-bd22-dd24b29b236f",
"requested_by_contact_id": "f2ed222b-dc9d-4380-9f55-82d5192bbd37",
"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-08-10T05:04:43.1611275+00:00",
"due_date": "2026-08-10T05:04:43.1611275+00:00",
"date_create": "2026-08-10T05:04:43.1611275+00:00",
"date_update": "2026-08-10T05:04:43.1611275+00:00",
"date_closed": "2026-08-10T05:04:43.1611275+00:00",
"suggested_user_id": "34e73131-2ea9-4c1f-b42b-b6bf66c23425",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3f1ef445-b95e-4b2d-811d-78562447f0fc",
"db_language_id": "c8433f30-41e2-4b2a-8403-e68dc1aefbd1",
"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-08-10T05:04:43.1611275+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1935862e-d433-4cfa-841b-434585f4378c",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c6c09390-6a91-4544-b8ca-175532915059",
"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": "908e0eba-4f0f-451f-a2d0-85e6e7f519e1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "badd2a9b-da37-4688-9f47-1fe58f239b03"
},
"suggested_date_start": "2026-08-10T05:04:43.1611275+00:00",
"skill_id": "c47feb21-9df6-4a39-a51f-817bafc0fa53",
"skill_code": "sample string 32",
"skill": {
"id": "647cb338-a172-46a0-b792-a0e20e94371c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "801319df-a76b-435c-b954-da7b49f0516f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "917d19bc-b94c-4ca1-98f6-511d9c6a28cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9bfed80b-d932-4945-bce5-c581923f7c01",
"db_currency_id": "59f8f996-c7b5-469a-bab7-027b3a2c0fda",
"db_language_id": "c9e95d62-0fe8-4442-aa22-a1e71977bf77",
"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-08-10T05:04:43.1611275+00:00"
},
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8848e672-3c88-47b3-9690-ee1cd2ecf889",
"date_reported_by_company": "2026-08-10T05:04:43.1611275+00:00",
"id2": 36,
"company_id": "37fa64bf-49f9-4ffb-8577-47ba4b5450b6",
"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": "69ccaf1b-fb5c-4e08-a8c2-0fc3c1a33eef",
"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-08-10T05:04:43.1611275+00:00"
},
"work_instruction_details_id": "fb4d5b19-81ca-47d7-b8ff-391e8edab953",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "52a84bfe-c6fd-4dbc-8d8d-e634a0b6df05",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ca279b08-cb58-4520-a98f-1092c1849952",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-10T05:04:43.1611275+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": "1ea2fdaf-b304-4259-aa52-a8e9c7d505c8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-10T05:04:43.1611275+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.