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": "37171886-10d8-4b74-abd5-eb807730a3d9",
"jobs_id": "f2862352-af3d-4e69-8645-c5379cdadddb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a5dfd617-3366-4e36-b6c6-7d8f07227870",
"_parent_id": "b52f5ca5-8027-4a77-a992-fa4c5bb82a0c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dfd25ced-4346-4e27-90c5-930a054db2e8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77e2730e-318e-45dd-9ff0-1053ee40874d",
"_parent_id": "7a282eb2-4ba6-4eb9-9248-b6ec2de4ef2a",
"root_parent_id": "4772ec8f-d3d3-4e04-8849-b10a1ff1c1b9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ad97ea64-3056-42e9-b4b4-c40d57fe60d6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4fb8aa88-56a3-4b3a-b126-168def9aed55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "81894b59-7fd1-4b89-8f30-cb196f2d87a4",
"_parent_code": "sample string 6",
"sales_organization_id": "db1b5df5-2f9f-409e-a8d7-0e0bdc2689b8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
},
"equipment_model_id": "b28e7819-f4f3-4dea-8a45-fd8c09aa8bbd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f9cca428-2704-49bd-8331-69e0a786af0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cea2566b-6cee-476b-930a-04ea9bc29e19",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8079becc-05e6-4d9e-bebb-4e46ebcbf8b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "023253ef-5be2-477c-9602-ae958e5f0e54",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
},
"equipment_family_id": "6fb8ad48-8940-4414-a328-775900971f7c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4fb8aa88-56a3-4b3a-b126-168def9aed55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "81894b59-7fd1-4b89-8f30-cb196f2d87a4",
"_parent_code": "sample string 6",
"sales_organization_id": "db1b5df5-2f9f-409e-a8d7-0e0bdc2689b8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
},
"date_in_production_since": "2026-06-04T05:00:22.1180827+00:00",
"date_out_of_production_since": "2026-06-04T05:00:22.1180827+00:00",
"date_end_support": "2026-06-04T05:00:22.1180827+00:00",
"sales_organization_id": "37bcd088-4bdf-4563-8c2e-c90b621a2e8c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+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-04T05:00:22.1180827+00:00"
},
"project_status_id": "7656e115-7469-4f0f-8ea7-3223206afc12",
"project_status_code": "sample string 10",
"project_status": {
"id": "d38b69c1-8dda-42d9-839e-aea423396e30",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ed0cff18-5966-4472-94e9-3c2e752c09cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
},
"company_id": "e3145766-16bf-4946-a432-983bf5061ae0",
"company_code": "sample string 12",
"db_address_id": "4fc41c74-e4c6-4024-ad48-055b1fe4a84a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "028bac2c-9547-42fa-a0ce-0410c7d19861",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "600e0f84-8769-4b8b-893e-82b6d83a7ea4",
"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-04T05:00:22.1180827+00:00",
"date_create": "2026-06-04T05:00:22.1180827+00:00",
"date_update": "2026-06-04T05:00:22.1180827+00:00",
"updated_by_user_id": "3ec95d50-b5e0-416d-83ec-a93bee7af57e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-04T05:00:22.1180827+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-04T05:00:22.1180827+00:00",
"date_last_job": "2026-06-04T05:00:22.1180827+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-04T05:00:22.1180827+00:00",
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00",
"is_mobile_installation": true
},
"job_type_id": "75cfa24c-a2a4-4a90-9c94-7dd6683ca26c",
"job_type_code": "sample string 7",
"job_type": {
"id": "90558725-c28c-49dc-93d4-a664497ddef9",
"name": "sample string 2",
"sales_organization_id": "a4511779-0d1a-4d2b-992d-06dfaf005be4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00",
"code": "sample string 7"
},
"job_priority_id": "ef9c3546-6dec-470b-905f-fbbafbf34912",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a36a9760-51f5-4ed6-8fe8-dddacde415b1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d1521b8-ffc5-485f-9f5c-2dbd8ca14f71",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
},
"job_status_id": "0166ff59-04c2-4f62-915f-4817f5382181",
"job_status_code": "sample string 11",
"db_address_id": "0bfeef9a-ba1f-4572-a924-5f61d53af0ca",
"contact_id": "ee0c41cf-bdfc-4029-8736-d1fe63d3b2f8",
"requested_by_company_id": "c4ab67b1-f405-47d3-9e47-ccca4964c784",
"requested_by_contact_id": "acae4fd8-db4e-4140-9ddc-4312dc7638e2",
"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-04T05:00:22.1180827+00:00",
"due_date": "2026-06-04T05:00:22.1180827+00:00",
"date_create": "2026-06-04T05:00:22.1180827+00:00",
"date_update": "2026-06-04T05:00:22.1180827+00:00",
"date_closed": "2026-06-04T05:00:22.1180827+00:00",
"suggested_user_id": "500e0b25-1f64-4de6-b8bf-b6fdebedbf29",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "547db8c9-7045-459a-9839-ce2f18b6291b",
"db_language_id": "971a2d46-870f-4e66-822f-a4c95b2ccbc2",
"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-04T05:00:22.1180827+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d1e00fc7-09e3-4043-bd42-8ce5d928d452",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1bc19e79-0327-4182-a600-f013f0b2950c",
"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": "6b515c22-5784-4b20-9756-a9623d107569",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "19144114-73c0-42df-b95b-85fc8a87a4d3"
},
"suggested_date_start": "2026-06-04T05:00:22.1180827+00:00",
"skill_id": "090b5b1d-940c-41c7-a867-d0c9985c4f3f",
"skill_code": "sample string 32",
"skill": {
"id": "8134bc29-4abb-4896-98a0-eefaf1fcbe05",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "881edf02-5edc-4633-8301-cdd1a686e4e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03180e15-470c-4906-a7b3-25882ad47019",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b6afce7-be43-47fd-861f-5f2528400a13",
"db_currency_id": "3b8f4f80-d76e-438d-aa0d-fc4be5bdeebf",
"db_language_id": "6d58b786-dc01-45e2-8f8f-1e57e96379e9",
"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-04T05:00:22.1180827+00:00"
},
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ad6697e2-be36-4f42-a2d1-eb0fdfa067e8",
"date_reported_by_company": "2026-06-04T05:00:22.1180827+00:00",
"id2": 36,
"company_id": "b97f1853-5256-4037-9104-0687692cf819",
"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": "2245da83-ed32-4a45-9c65-27dee08ea9f4",
"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-04T05:00:22.1180827+00:00"
},
"work_instruction_details_id": "8ddad695-2515-4bdf-94cb-6044b03bfc6e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d3b8a91e-4269-49ca-83c6-a2b9bbad2b35",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5dd867fb-0a82-4911-b480-29c8d556abdd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-04T05:00:22.1180827+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": "1242d5a1-f337-4772-821e-ef8df47be68c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-04T05:00:22.1180827+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.