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": "e64e4af1-2ebf-481b-9a79-7d4c2473220f",
"jobs_id": "365eefdc-7fb0-402a-8cdd-8a080239c213",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d87dd639-9539-4634-97bf-009808013372",
"_parent_id": "81f27eff-b80a-44b4-b947-a450a6ca311a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "78bf1662-9cda-428c-9d4c-a3e4e4fd9ad4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "918e6d21-006b-4731-b38b-b78c00287d3d",
"_parent_id": "dc409492-2fd9-48fd-b7c0-cf63079b94bd",
"root_parent_id": "ed4916d6-9a47-4d10-ba17-dddda65e4e2e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "61cfc561-c573-4f4e-ba19-9a47481a2d2f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "67dad64f-da91-41fe-8c65-ac7e3b282f78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c4fe226-0b65-492f-9e90-f2cb66ef9c93",
"_parent_code": "sample string 6",
"sales_organization_id": "df437f2b-bf15-4a4d-af86-6a90d33d9910",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
},
"equipment_model_id": "e714b9f1-1f09-4130-9ddf-35138fb5afab",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "827c00e5-3474-4740-bec1-cf2fc85ac957",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e902ae83-235a-41c1-8bad-59b48da3741b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "29b0eb7a-bee2-4c1e-a3a1-ca71cf708ce8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8118a7af-e73a-4788-8b93-1edd0b2e9c37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
},
"equipment_family_id": "19625ba7-fe06-4f43-9338-9c6a2e63766d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "67dad64f-da91-41fe-8c65-ac7e3b282f78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c4fe226-0b65-492f-9e90-f2cb66ef9c93",
"_parent_code": "sample string 6",
"sales_organization_id": "df437f2b-bf15-4a4d-af86-6a90d33d9910",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
},
"date_in_production_since": "2026-09-25T00:17:13.046933+00:00",
"date_out_of_production_since": "2026-09-25T00:17:13.046933+00:00",
"date_end_support": "2026-09-25T00:17:13.046933+00:00",
"sales_organization_id": "75087b7f-cba0-4d65-a26a-96ab4dc43bc7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+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-25T00:17:13.046933+00:00"
},
"project_status_id": "d26a2718-5140-46b3-8303-61c33d27ed73",
"project_status_code": "sample string 10",
"project_status": {
"id": "fe703d73-e34a-435a-bfd5-da2c41f3de1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "96145276-7f4d-477e-97f0-4fe4b76e477c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
},
"company_id": "d0aae849-7de7-4170-aa5f-742b529d8b24",
"company_code": "sample string 12",
"db_address_id": "4b7e1d58-03dc-4351-ad56-eaedf9cc2bc5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6afa37d1-f706-47e8-b4d9-0621dac7898b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ea510993-309f-491f-9b78-2990eee67ac2",
"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-25T00:17:13.046933+00:00",
"date_create": "2026-09-25T00:17:13.046933+00:00",
"date_update": "2026-09-25T00:17:13.046933+00:00",
"updated_by_user_id": "d01d8888-cbcc-4609-9232-26f561b032d3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-25T00:17:13.046933+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-25T00:17:13.046933+00:00",
"date_last_job": "2026-09-25T00:17:13.046933+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-25T00:17:13.046933+00:00",
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00",
"is_mobile_installation": true
},
"job_type_id": "f70315ea-8c4b-4d44-bc66-180f96a2e214",
"job_type_code": "sample string 7",
"job_type": {
"id": "244d5b59-f4a3-42e8-a6e3-8ffd432faf23",
"name": "sample string 2",
"sales_organization_id": "52002641-2f25-4e76-975d-eede2ab22c80",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00",
"code": "sample string 7"
},
"job_priority_id": "d4a5289c-600b-4f25-8d88-26c586659d1b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bc26a6c8-8ffd-4458-8f9f-5b49dfcd4b7f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f0db93fd-5060-4426-b7b8-77c8e83d8509",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
},
"job_status_id": "9062b68c-faba-4e65-97b4-2e3df4e00c81",
"job_status_code": "sample string 11",
"db_address_id": "c43519e6-aa2f-43e8-a3fb-ed65c6c8b12e",
"contact_id": "fb0a3143-18b0-4bba-b540-2838231ab2bd",
"requested_by_company_id": "405fcb76-1305-45c7-9aef-603ae8ea80d4",
"requested_by_contact_id": "f2f19775-f822-47a1-9679-53388a59b881",
"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-25T00:17:13.046933+00:00",
"due_date": "2026-09-25T00:17:13.046933+00:00",
"date_create": "2026-09-25T00:17:13.046933+00:00",
"date_update": "2026-09-25T00:17:13.046933+00:00",
"date_closed": "2026-09-25T00:17:13.046933+00:00",
"suggested_user_id": "2ce9306e-84cf-4197-9d60-b21eaccdfdfd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5fdc6e15-aee7-436b-94c7-41a8dbf73c93",
"db_language_id": "657f7c11-750b-4474-b40f-8a05317754f5",
"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-25T00:17:13.046933+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f140fee7-31f3-46b3-bde4-32fa6ff566a6",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4af6bfe7-c975-4c07-9f55-ed54259b2082",
"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": "816a441c-d330-4c2c-9388-6b6a548c8c0c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "793af170-91b0-4019-8177-b8a4793306e1"
},
"suggested_date_start": "2026-09-25T00:17:13.046933+00:00",
"skill_id": "5224b2cc-eb99-40b5-a183-3fb16fddff23",
"skill_code": "sample string 32",
"skill": {
"id": "efceb70b-ebbe-4aa9-a26a-c1a8cf7abad8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2a6c96e6-d35a-42e4-8c1b-45ec6e283ebc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6eae7cb0-dcfa-4cc2-a894-fb2957920369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a2145a5c-9836-4339-9c90-854579c919e3",
"db_currency_id": "2651cfbf-c7ee-4cb0-a1f7-bf2370cc08cf",
"db_language_id": "33b10634-31ea-463a-b2f8-71479c94e362",
"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-25T00:17:13.046933+00:00"
},
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "41bce550-1773-4ac9-b967-7cc96e8c2432",
"date_reported_by_company": "2026-09-25T00:17:13.046933+00:00",
"id2": 36,
"company_id": "97cf5236-a03a-4264-aae2-8e66fc8d74dc",
"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": "5c0cb82c-64a7-45df-b837-e73ecc8bd207",
"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-25T00:17:13.046933+00:00"
},
"work_instruction_details_id": "71bd86e1-65c1-4394-9fe9-d358c28c07c4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2f246aff-5627-4a5f-95f9-5feb03552809",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "99e592cd-93af-4bf0-bacd-60f18a2dd268",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-25T00:17:13.046933+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": "93a6ff50-6773-4fac-b58a-3d832470f302",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-25T00:17:13.046933+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.