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": "66245048-c5a6-43bd-a897-eb81c2bbffb9",
"jobs_id": "e2ae6929-11e2-4d2b-9a91-65c922cf1c63",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c7ee51c-a411-42b2-bb7e-51ae4038806c",
"_parent_id": "2f2ed6b3-d55f-4d74-a4d5-46e8212cb9b2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4181d9f6-3517-4ab2-ae56-50a95f8cc521",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e614ab10-2bcb-4d96-9bb3-2e4d003025e5",
"_parent_id": "b98fa68e-85df-4c67-9ca2-1154f4c8233a",
"root_parent_id": "5f1453a7-47f5-429c-9e70-b17870d58e62",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2c118649-9c23-442a-a41e-340e5ccbf131",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c29fafc3-0376-4da5-8e1c-7a9c2eb6b278",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2af16b54-cae8-468e-8f01-ccc981dfbd23",
"_parent_code": "sample string 6",
"sales_organization_id": "01f4976a-d149-4988-af42-a7054b078b4a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
},
"equipment_model_id": "3af3d523-100e-4af6-bfc8-fd2d7c1290e8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b14bda03-1b80-44ef-b365-20cd42dbdbc3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "68f45bf3-2997-40c3-934b-09533344bead",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8f06680d-f694-454e-b95b-78641f3101de",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c463c4e-6643-48ab-ac52-710609a0cfd6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
},
"equipment_family_id": "0227997f-1dc7-45c8-a00d-09c353ae876b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c29fafc3-0376-4da5-8e1c-7a9c2eb6b278",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2af16b54-cae8-468e-8f01-ccc981dfbd23",
"_parent_code": "sample string 6",
"sales_organization_id": "01f4976a-d149-4988-af42-a7054b078b4a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
},
"date_in_production_since": "2026-06-05T07:34:33.0185877+00:00",
"date_out_of_production_since": "2026-06-05T07:34:33.0185877+00:00",
"date_end_support": "2026-06-05T07:34:33.0185877+00:00",
"sales_organization_id": "20efec00-ef4b-43b6-aed3-3ae6227b7656",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+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-05T07:34:33.0185877+00:00"
},
"project_status_id": "e9311372-6b4f-4fbc-a112-5d6676777649",
"project_status_code": "sample string 10",
"project_status": {
"id": "c2efb445-9eb9-4b76-b87a-9f3abdb88358",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d9594038-8c31-4572-a316-e8cef3e38060",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
},
"company_id": "32205bd0-a447-4a5a-a394-2a343ffc4e22",
"company_code": "sample string 12",
"db_address_id": "49974a34-6206-406e-aec9-a9042a39aadb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9aa483d3-917f-45f1-97ba-4f113ad155ee",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "323a78da-e227-42d8-b1db-355df85332a0",
"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-05T07:34:33.0185877+00:00",
"date_create": "2026-06-05T07:34:33.0185877+00:00",
"date_update": "2026-06-05T07:34:33.0185877+00:00",
"updated_by_user_id": "28a894e4-1402-43a8-84e1-738f272876da",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-05T07:34:33.0185877+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-05T07:34:33.0185877+00:00",
"date_last_job": "2026-06-05T07:34:33.0185877+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-05T07:34:33.0185877+00:00",
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00",
"is_mobile_installation": true
},
"job_type_id": "1ecc1b93-c226-4d3d-b45f-6fa8a5c79a1b",
"job_type_code": "sample string 7",
"job_type": {
"id": "10022789-5cdd-498c-838f-30a882e5f93a",
"name": "sample string 2",
"sales_organization_id": "d9cff58c-1534-4963-aedf-dd52516ac215",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00",
"code": "sample string 7"
},
"job_priority_id": "737ef814-a8af-4140-9564-9913e9fb08af",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "89d3071d-584b-49f9-b7d9-2f28099d075c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d17c0d0c-f028-477a-9ad9-3fdcad67a14f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
},
"job_status_id": "e9fa9769-520b-4917-8b70-687c93b98387",
"job_status_code": "sample string 11",
"db_address_id": "5de0c554-afbc-4f37-8cb6-20a0239d9cec",
"contact_id": "73296dc4-fed6-4469-974f-40a5f09cd4d3",
"requested_by_company_id": "f9a1b864-e87d-4c70-8408-d472b8324aff",
"requested_by_contact_id": "8be769ed-2ecd-4f44-8b21-8628ba5519d1",
"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-05T07:34:33.0185877+00:00",
"due_date": "2026-06-05T07:34:33.0185877+00:00",
"date_create": "2026-06-05T07:34:33.0185877+00:00",
"date_update": "2026-06-05T07:34:33.0185877+00:00",
"date_closed": "2026-06-05T07:34:33.0185877+00:00",
"suggested_user_id": "5be96b82-1244-4d2b-af5c-960f9f07abe1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fa177320-7adc-417c-8bef-fce1ec1d2600",
"db_language_id": "c0d667ec-aca2-45bd-8a32-bf0c9cc2d2a3",
"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-05T07:34:33.0185877+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "995802c6-afca-448a-a54d-37b78ee2df82",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d5051c6c-984c-4fce-8bb2-675a7b07a560",
"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": "7a149bb4-4e1b-4a51-b019-c8ee8d3dd524",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c56a32ec-0e98-43cf-ac03-e3595a3a705a"
},
"suggested_date_start": "2026-06-05T07:34:33.0185877+00:00",
"skill_id": "9da9d3ec-0d44-4c4c-a595-952bd534e924",
"skill_code": "sample string 32",
"skill": {
"id": "d28124b7-fb92-42aa-9c2c-fbb070ac7e31",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dc73fdb1-ae58-4aab-a929-982a44a298b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae07d6b4-48f1-4c28-8af8-864591fe4387",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf543816-d415-431d-b51d-8248e6f31204",
"db_currency_id": "33115d63-2779-4ec2-be14-248055cbc504",
"db_language_id": "9385be8c-ed50-40b6-ad20-ac659b2c296c",
"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-05T07:34:33.0185877+00:00"
},
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "db3ba75c-81f6-477d-95b7-88b12626b28c",
"date_reported_by_company": "2026-06-05T07:34:33.0185877+00:00",
"id2": 36,
"company_id": "81b75459-e190-42db-b06d-841fe171392b",
"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": "e5e7af46-1fa3-408f-a848-65dfd6e00417",
"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-05T07:34:33.0185877+00:00"
},
"work_instruction_details_id": "bb78c86e-ad50-4aad-81ec-b5f451f4cfa5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7cda11e4-42ff-4810-9681-fb6ba5e4af3c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "94d61561-b3b3-438a-8192-28d0025d64d3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-05T07:34:33.0185877+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": "5a813f51-75e1-40bc-9b40-9de0f585d395",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-05T07:34:33.0185877+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.