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": "cd37c5c0-015f-4a91-a166-fdf2a7d4301d",
"jobs_id": "493d2439-da6f-43a9-8dba-fa3cd9cb0d19",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "132a6273-0d70-43af-9924-1a9a4959eab2",
"_parent_id": "d09fc3d4-dc71-4191-acc4-9c013285f6ec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "35c78e2c-8dde-4a26-b521-2687cb9fde6f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8be86a1c-d072-4f97-94e3-1c15ad749a50",
"_parent_id": "e17d8946-9cd1-4fe6-8e46-c0ee6f36ff7f",
"root_parent_id": "c6a62aef-a534-4a43-bbe4-25ed5eba55cf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "40b440fd-3bb3-48d0-9750-f34175830ef9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "96086b02-fe39-42e6-851e-fd6bd76e5d5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9c79db5b-bda8-423d-8903-07fdbe71ece3",
"_parent_code": "sample string 6",
"sales_organization_id": "ce35bfa0-8101-416f-8c8f-097b32967945",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"modified_dateutc": "2026-01-14T18:30:33.1276163+00:00"
},
"equipment_model_id": "916dbc7b-0979-40d7-99b6-82cad71878c3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9b215388-1b2d-4460-9cc1-299c846893b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "833536cb-946d-496a-8413-f24666682af2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b99b9194-f70c-4280-9b86-f6f068c14ce7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "62de0252-8ece-40ed-ad0b-17555fa7ec84",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"modified_dateutc": "2026-01-14T18:30:33.1276163+00:00"
},
"equipment_family_id": "5df15f5e-a060-4406-b09e-3cbcef383dbe",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "96086b02-fe39-42e6-851e-fd6bd76e5d5d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9c79db5b-bda8-423d-8903-07fdbe71ece3",
"_parent_code": "sample string 6",
"sales_organization_id": "ce35bfa0-8101-416f-8c8f-097b32967945",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"modified_dateutc": "2026-01-14T18:30:33.1276163+00:00"
},
"date_in_production_since": "2026-01-14T18:30:33.1276163+00:00",
"date_out_of_production_since": "2026-01-14T18:30:33.1276163+00:00",
"date_end_support": "2026-01-14T18:30:33.1276163+00:00",
"sales_organization_id": "09bac054-157f-4d59-8b21-a23dcdfab293",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+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-01-14T18:30:33.1432336+00:00"
},
"project_status_id": "95412eb5-5999-4361-a45e-1d28c675a926",
"project_status_code": "sample string 10",
"project_status": {
"id": "dd5803fa-9e62-4618-a6ca-7baffe5c6fcd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0526441-7837-4b31-bfe3-3b68d8c0305d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00"
},
"company_id": "9d660786-de37-4078-8be8-53f20157198d",
"company_code": "sample string 12",
"db_address_id": "4686bd62-8d87-4aec-8375-490a6b6c3bd1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b27cbfa3-905a-4719-8695-3dbefbfe615f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7ab70790-229b-4251-ab84-00eaaa2a2774",
"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-01-14T18:30:33.1432336+00:00",
"date_create": "2026-01-14T18:30:33.1432336+00:00",
"date_update": "2026-01-14T18:30:33.1432336+00:00",
"updated_by_user_id": "fd817a00-f4f4-4165-9f80-74206ceca555",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-14T18:30:33.1432336+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-01-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-14T18:30:33.1432336+00:00",
"date_last_job": "2026-01-14T18:30:33.1432336+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-14T18:30:33.1432336+00:00",
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00",
"is_mobile_installation": true
},
"job_type_id": "d41d72f5-ce77-441d-98d8-2742db437bfb",
"job_type_code": "sample string 7",
"job_type": {
"id": "de5b2e1c-ae73-4e89-99ec-fab80c54ed05",
"name": "sample string 2",
"sales_organization_id": "76a9e09a-df3c-4ab2-a00b-3922ca923e45",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00",
"code": "sample string 7"
},
"job_priority_id": "44864885-32bf-451a-a702-ddac95e6594f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "05dd0aa1-0ff2-4639-8f52-4a0a31b207e9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9516a0b5-7382-4d7d-bf4b-31ecf9cd6cad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00"
},
"job_status_id": "ae7043b7-05ba-4fa7-afb0-eff8ac8c0b0b",
"job_status_code": "sample string 11",
"db_address_id": "553cca19-3f1f-4a9c-ad84-a2aefd6401f0",
"contact_id": "938fefa1-483a-4500-abfd-0e7abd30e244",
"requested_by_company_id": "4a1ad8c6-8120-445f-9817-4a7cf012bf5e",
"requested_by_contact_id": "eeb24766-a4cd-41c3-8346-ee398db4fdab",
"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-01-14T18:30:33.1432336+00:00",
"due_date": "2026-01-14T18:30:33.1432336+00:00",
"date_create": "2026-01-14T18:30:33.1432336+00:00",
"date_update": "2026-01-14T18:30:33.1432336+00:00",
"date_closed": "2026-01-14T18:30:33.1432336+00:00",
"suggested_user_id": "06baa8cb-c059-4591-8aba-baa49b54182d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a0e66675-ed1a-4d3e-bd38-a3a462837c89",
"db_language_id": "19a43306-c1e0-4ab9-88c6-5dc60392db58",
"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-01-14T18:30:33.1432336+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "139adc44-3727-475f-970e-83dd10497688",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "701438a4-be68-4471-bf62-31f004a9ebb5",
"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": "0005e730-6080-49f4-a8c4-a890e442a451",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c3af353e-245a-4501-98a8-7ede1d9caeea"
},
"suggested_date_start": "2026-01-14T18:30:33.1432336+00:00",
"skill_id": "fe661560-9be5-4adf-8f14-4f5c63210705",
"skill_code": "sample string 32",
"skill": {
"id": "28f89c95-bd07-4522-bd15-78969db39d0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4bc1b5fb-207d-4228-af14-6811b5a6ddb8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3c4e9d7a-3d7e-40e7-a574-b5ab06da564f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "464e4c02-7892-4c38-8637-898bc3d098da",
"db_currency_id": "56e57e8f-08b8-4099-bde3-a1d6f9303b2d",
"db_language_id": "f12f725c-7777-4711-a2a7-7da0e59b9a62",
"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-01-14T18:30:33.1276163+00:00"
},
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a31bd89f-5bb4-4b66-b81e-b2c57e61b95b",
"date_reported_by_company": "2026-01-14T18:30:33.1432336+00:00",
"id2": 36,
"company_id": "a0d32f34-5e6d-4ef0-b4f7-556cd15e08fe",
"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": "e0026c9d-8232-4d68-9ddf-da4e54f8eb71",
"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-01-14T18:30:33.1432336+00:00"
},
"work_instruction_details_id": "3f59cf65-de17-4b40-9572-7c5645fa0bfd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "844f3f25-db6b-4460-a243-168f08bd5d63",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5c10cb60-1fa2-44a1-8d43-6cf341e29822",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-14T18:30:33.1432336+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": "50995fbb-6d8d-4ed8-b712-a280116e8c90",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-14T18:30:33.1432336+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.