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": "a3729c49-f334-44f8-a6a1-6c938b562503",
"jobs_id": "df98a0d8-bf25-4a5b-833e-d6abfc82ebb9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "745784e0-e361-4fd5-8501-e27fe4edfba5",
"_parent_id": "6e41d542-5602-4fbc-b6e9-4ace41df696a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e499f337-16e1-4bc9-83b7-004d018ac332",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d9b8e7ea-b694-4bf0-8874-14f34b0ae222",
"_parent_id": "c1b95fba-ab8d-4a1d-8236-935706f48fdf",
"root_parent_id": "6a9f67db-4c21-435e-a469-66cf39a93e72",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "88af11be-41b7-4c99-9dbf-72b8c09fd920",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "53c2fbe6-95ff-4452-a52f-3035931c365b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fcdd148d-d9bb-41dd-9f02-65ad36eea52a",
"_parent_code": "sample string 6",
"sales_organization_id": "40308396-b477-4c6c-b4d6-10907c217c1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
},
"equipment_model_id": "4b5ac0cd-1e20-4903-8855-8b97f26275d8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "022b8a5f-8d9f-4566-bc93-939b435e574a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fe7c9c9c-7554-44ce-a337-be4d87e2936a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3344107e-7478-424e-8055-f9511187872a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cfcc7ed3-024d-4c9f-97ae-b2bace0a977d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
},
"equipment_family_id": "47edd34c-13c2-4032-b5a0-18dfffa5f45e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "53c2fbe6-95ff-4452-a52f-3035931c365b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fcdd148d-d9bb-41dd-9f02-65ad36eea52a",
"_parent_code": "sample string 6",
"sales_organization_id": "40308396-b477-4c6c-b4d6-10907c217c1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
},
"date_in_production_since": "2026-09-15T05:58:55.1670282+00:00",
"date_out_of_production_since": "2026-09-15T05:58:55.1670282+00:00",
"date_end_support": "2026-09-15T05:58:55.1670282+00:00",
"sales_organization_id": "1364885f-5a8b-4522-9cfd-7cb27dc49fd2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+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-09-15T05:58:55.1670282+00:00"
},
"project_status_id": "c62f3848-eb60-4150-8798-b8860e5f0f8d",
"project_status_code": "sample string 10",
"project_status": {
"id": "9f0f7b57-1bc0-4c2b-b029-c1a37a0dea95",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "10235aa8-bdff-4fec-8c39-0bd1da2bf0cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
},
"company_id": "bc1284ce-2818-4ad9-8629-57f7402740b2",
"company_code": "sample string 12",
"db_address_id": "81b32659-5d54-4f05-8852-6171fd7c009e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ee344348-b2ed-4ba2-b43c-bbcacac60ddd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "98f7ddc9-1b59-4589-811a-dbc1066d99d3",
"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-09-15T05:58:55.1670282+00:00",
"date_create": "2026-09-15T05:58:55.1670282+00:00",
"date_update": "2026-09-15T05:58:55.1670282+00:00",
"updated_by_user_id": "2982fbe9-dfba-4ec1-8e2a-6e7f02349e09",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-15T05:58:55.1670282+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-09-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-15T05:58:55.1670282+00:00",
"date_last_job": "2026-09-15T05:58:55.1670282+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-15T05:58:55.1670282+00:00",
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00",
"is_mobile_installation": true
},
"job_type_id": "216f68b2-8bfa-4af2-ba14-6769ead127f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "c621b93a-ac3a-4277-89b1-2d63ed08d305",
"name": "sample string 2",
"sales_organization_id": "0a51ed8f-cea5-472a-8d2a-7fbcb7fb4fa7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00",
"code": "sample string 7"
},
"job_priority_id": "3af1a432-32b8-4b30-8796-73a91d46eb11",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b4c93c1a-8848-4844-a4e8-11c05c3543d8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "48514bfb-8195-4949-9c4d-67e15d505596",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
},
"job_status_id": "a890e9d4-f600-464c-9179-fa1244abde79",
"job_status_code": "sample string 11",
"db_address_id": "199caa0c-45a9-476a-a47d-3ac48c02adee",
"contact_id": "16f9ef81-9475-4131-bcac-945f05d29104",
"requested_by_company_id": "db0f3d2f-4e10-4c21-be1f-89f3d6c70a03",
"requested_by_contact_id": "be1b7973-f9c0-4d0b-b886-c5b50f6227dd",
"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-09-15T05:58:55.1670282+00:00",
"due_date": "2026-09-15T05:58:55.1670282+00:00",
"date_create": "2026-09-15T05:58:55.1670282+00:00",
"date_update": "2026-09-15T05:58:55.1670282+00:00",
"date_closed": "2026-09-15T05:58:55.1670282+00:00",
"suggested_user_id": "9598a1a0-5bb7-4212-92da-748b11c00d4c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a11d4b59-7c90-4781-a1ea-906751f56e31",
"db_language_id": "44980f9a-b8d4-475c-bbce-098ae8c92d08",
"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-09-15T05:58:55.1670282+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c901a475-0b08-458a-9f41-f1f92b5a46e4",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "73130d7f-307d-4454-bd9a-8f58b871cc67",
"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": "50de690d-078a-4af5-bd93-b0a2e9ae823b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7d8e3cb3-96fd-48b6-8a1b-0704122feb41"
},
"suggested_date_start": "2026-09-15T05:58:55.1670282+00:00",
"skill_id": "0d0fa799-14e6-4c48-a87b-68b0e57848bf",
"skill_code": "sample string 32",
"skill": {
"id": "34c2b3a4-35e7-47b4-a75f-b7b5d4bf602b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7b501388-c10d-4152-8ce9-de1dfca284e6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac20c846-7b75-4eb1-88d1-66b7df957e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c8c624b-46ca-4f80-b0fe-9c61c2835d7f",
"db_currency_id": "429150bb-3e1d-44ab-8406-a8853d7df36d",
"db_language_id": "87a68913-6c1a-4484-ad7e-bf1e8450cb22",
"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-09-15T05:58:55.1670282+00:00"
},
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4ee64066-c9e7-4ca1-b8ac-5bb215dc441b",
"date_reported_by_company": "2026-09-15T05:58:55.1670282+00:00",
"id2": 36,
"company_id": "8e848566-5c7f-4ebb-a800-fdba83e55e3d",
"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": "ec6e3cf7-6152-46de-b356-3b97d14aadb4",
"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-09-15T05:58:55.1670282+00:00"
},
"work_instruction_details_id": "1acbf206-dda7-4efa-9a31-07d5f7e40486",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8baca5e7-eb71-48d9-9873-b6c346b5a284",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6152f8b9-c489-4a7d-a78f-2d5edadf0da7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-15T05:58:55.1670282+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": "009f63b9-1dc4-4db9-aef9-255d110c9c12",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-15T05:58:55.1670282+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.