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": "b9d05a44-d213-44ed-8596-950631be5026",
"jobs_id": "8ac85a5a-8114-402f-90fa-8721306e7a34",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0d26be3e-b3bd-4782-8da4-64fc7a9840f9",
"_parent_id": "155eb387-d610-492e-8381-19f7675adc24",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "945144bf-efd6-493a-b0bf-713272f0e2a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "83624064-8a39-4c80-a404-50218aebf529",
"_parent_id": "81a818b5-9331-4535-b645-901e841c850a",
"root_parent_id": "cc052ec1-4742-4b54-9404-8e2a503f4082",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "82f9a3f4-b491-4fc2-86c0-3cccc9bf89a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9dd2f1b3-8ba7-48d4-ac7f-d8083f699c3e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0f943b9-f05f-469e-85a5-3e56bb7cae5d",
"_parent_code": "sample string 6",
"sales_organization_id": "f49e4167-ac2e-4bf7-9fc7-fdcc5def9aeb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00"
},
"equipment_model_id": "c8654347-16c3-4c7c-bd7b-9b68d8c3bb3f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b4d57af9-b345-49d8-ac5f-e8cc23b23e36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "811e184a-382a-4852-92df-1bc742f2e207",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cfce0a4d-9ca4-4c44-8fa8-a7a36b434892",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "293caad3-1655-4d68-8de1-7a08e0014d7d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00"
},
"equipment_family_id": "a4673bdc-5657-4c3b-8f6a-9354a3ad58d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9dd2f1b3-8ba7-48d4-ac7f-d8083f699c3e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0f943b9-f05f-469e-85a5-3e56bb7cae5d",
"_parent_code": "sample string 6",
"sales_organization_id": "f49e4167-ac2e-4bf7-9fc7-fdcc5def9aeb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00"
},
"date_in_production_since": "2026-10-29T13:05:43.6068681+00:00",
"date_out_of_production_since": "2026-10-29T13:05:43.6068681+00:00",
"date_end_support": "2026-10-29T13:05:43.6068681+00:00",
"sales_organization_id": "ce022788-680e-4f00-890b-2de1822d65b3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+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-10-29T13:05:43.6068681+00:00"
},
"project_status_id": "dbaa4eff-8542-46f0-9eee-f80de57feb9f",
"project_status_code": "sample string 10",
"project_status": {
"id": "13c1422d-a45c-4469-aaa7-59e4692b537f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8255e9e7-637e-4031-8de1-0899b2ef27ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00"
},
"company_id": "3ed0c3cd-2ba3-49af-a115-4fb5b129b00e",
"company_code": "sample string 12",
"db_address_id": "ff71a48d-a324-434d-851d-920b828f7a91",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "31a3010c-9869-4da1-b0dc-abf2f9b0e0cc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ae3ac3a2-f649-43fd-88a6-fd98a6743b85",
"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-10-29T13:05:43.6068681+00:00",
"date_create": "2026-10-29T13:05:43.6068681+00:00",
"date_update": "2026-10-29T13:05:43.6068681+00:00",
"updated_by_user_id": "2695162d-a225-4e84-afe7-5de87bc0db40",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-29T13:05:43.6068681+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-10-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-29T13:05:43.6068681+00:00",
"date_last_job": "2026-10-29T13:05:43.6068681+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-29T13:05:43.6068681+00:00",
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00",
"is_mobile_installation": true
},
"job_type_id": "876ac9bd-d1bb-45de-a01b-922d358f7685",
"job_type_code": "sample string 7",
"job_type": {
"id": "9517a10a-c576-40b5-861d-d28a48cc0e90",
"name": "sample string 2",
"sales_organization_id": "6fd70f10-15fd-4406-9738-72e510e7d830",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00",
"code": "sample string 7"
},
"job_priority_id": "1c1b62c4-5422-409c-a346-350ecb081bef",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "93436e82-c892-4eb8-af99-18c1ad53746c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0724cf88-7080-46b9-b533-472062dc4c44",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00"
},
"job_status_id": "44699e4b-3fc4-4898-b489-ae2aa61dac9f",
"job_status_code": "sample string 11",
"db_address_id": "2a7487f8-c228-488c-86f0-a97d36b8c2d1",
"contact_id": "ccf2d473-4b99-4b66-9813-1bf8434c64e0",
"requested_by_company_id": "5089bb1f-d23b-4dee-9653-843a2dfbbeae",
"requested_by_contact_id": "6f946c58-bb08-4620-b40b-d6b8646bfe2a",
"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-10-29T13:05:43.6068681+00:00",
"due_date": "2026-10-29T13:05:43.6068681+00:00",
"date_create": "2026-10-29T13:05:43.6068681+00:00",
"date_update": "2026-10-29T13:05:43.6068681+00:00",
"date_closed": "2026-10-29T13:05:43.6068681+00:00",
"suggested_user_id": "d8caa316-265c-472d-a725-5d90bd66028f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5119f03b-765f-406a-ba26-6f3a0dea8ecd",
"db_language_id": "d0e8ae2d-8387-4242-b26e-f8f79a484e1d",
"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-10-29T13:05:43.6068681+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7646785e-6f6e-473a-b075-a8ea97704b47",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6a3e5a67-9e01-464b-be3c-66d575a31732",
"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": "44dea94b-e807-4f71-8dff-9934ef9dbbc1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d53ab1d1-077b-4fe2-a646-4926d2ab228e"
},
"suggested_date_start": "2026-10-29T13:05:43.6068681+00:00",
"skill_id": "4ed9dd1f-f81c-47a7-a37d-44bc8b943f38",
"skill_code": "sample string 32",
"skill": {
"id": "65e58202-fd77-49d8-a0d7-587ec0880f92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cd8ce2bf-d46c-4d51-ae6f-4a8ae10773ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6f37d1ec-36c5-4ef4-a002-927ecafd3cf6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e5fdc8d9-00a7-4e5a-8765-ecefc9e8c844",
"db_currency_id": "07f14590-e16a-4a19-b452-c221e9172f5d",
"db_language_id": "527410ec-61c8-4e1e-94cc-92186fd1e4b4",
"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-10-29T13:05:43.5880413+00:00"
},
"modified_dateutc": "2026-10-29T13:05:43.6068681+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "60531246-4fee-4ff0-9173-d45f507f1889",
"date_reported_by_company": "2026-10-29T13:05:43.6192938+00:00",
"id2": 36,
"company_id": "f5a8eed2-a65e-42a6-b468-c354415a6a29",
"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": "ab78ca7f-2a00-4f81-a0e9-addb59f64e14",
"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-10-29T13:05:43.6192938+00:00"
},
"work_instruction_details_id": "449587e6-8a31-4fcb-82b0-193e5bde4c3a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "936eed11-8c31-4558-8afb-4d83647ba6f6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f7262f50-b1b5-4985-9c99-9d87afed5ffd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-29T13:05:43.6192938+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": "e3873eb6-d410-400e-bff7-5461e4054a47",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-29T13:05:43.6192938+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.