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": "a6d1d400-a1ec-4992-b3e1-8cfae22d817e",
"jobs_id": "bd840a64-cc32-411d-945c-44c0276ef84d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d1ee6bb-1738-4100-a90c-678805447b46",
"_parent_id": "ecc66c6a-cbe0-4de5-b0d9-931f2cbfad1f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "02d2c36a-c7da-4222-a045-45f2b3063e8b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f5283334-47ba-4805-b63b-c555fb9a53e0",
"_parent_id": "01b2586e-8eab-4385-a404-d115369eacfd",
"root_parent_id": "184e4f36-6aa4-4370-81f5-1c6f74b2e310",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2ecc0e62-aaf8-4d81-87c3-ead313dc4a05",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f19e1d64-1352-4925-85de-e1a317706a21",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59a79f05-1c58-4ab6-b834-dfb556d98ee7",
"_parent_code": "sample string 6",
"sales_organization_id": "27c7e8e8-f2ad-4bd9-9e88-686780fef1f4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
},
"equipment_model_id": "ec6d2225-9d1b-4a3c-ac7c-7a53b7257a28",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fcbf283c-2cc4-4d9a-aaf5-9250fd01b0be",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b8fec3e-c4df-495a-8584-330a51b86736",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "771e26f7-f761-4c7a-b0c8-63ad2fc57eca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "52b4ff86-5a07-46ee-bfdb-8ec038b44a17",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
},
"equipment_family_id": "2a4c851a-145b-4b0c-9c9b-272324f41110",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f19e1d64-1352-4925-85de-e1a317706a21",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "59a79f05-1c58-4ab6-b834-dfb556d98ee7",
"_parent_code": "sample string 6",
"sales_organization_id": "27c7e8e8-f2ad-4bd9-9e88-686780fef1f4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
},
"date_in_production_since": "2026-09-11T23:23:13.9575354+00:00",
"date_out_of_production_since": "2026-09-11T23:23:13.9575354+00:00",
"date_end_support": "2026-09-11T23:23:13.9575354+00:00",
"sales_organization_id": "36e6d917-a410-482f-b0d7-176db26601e5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+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-11T23:23:13.9575354+00:00"
},
"project_status_id": "f334957c-098e-4720-8479-0027948a37c7",
"project_status_code": "sample string 10",
"project_status": {
"id": "323e21ec-9050-413d-bd3b-aa6354c587ec",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "84d639d0-ad71-44b0-840a-f31133948487",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
},
"company_id": "7dd169a9-af13-475e-9de1-892078a34d51",
"company_code": "sample string 12",
"db_address_id": "8f959ddd-db2d-422f-8fbc-5316a3eb1830",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b5734c9-fdc7-4d11-93c6-2978afd6c4b2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0bd63281-9c56-477e-b21b-e57f054f9fb1",
"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-11T23:23:13.9575354+00:00",
"date_create": "2026-09-11T23:23:13.9575354+00:00",
"date_update": "2026-09-11T23:23:13.9575354+00:00",
"updated_by_user_id": "a2d12eee-1d55-4bbd-8cfa-b48be4753456",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T23:23:13.9575354+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T23:23:13.9575354+00:00",
"date_last_job": "2026-09-11T23:23:13.9575354+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T23:23:13.9575354+00:00",
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00",
"is_mobile_installation": true
},
"job_type_id": "e47120a5-3243-45a0-9f89-4272626abbf7",
"job_type_code": "sample string 7",
"job_type": {
"id": "de3a8aa1-27fd-4730-bbfd-b5eeb1712ae6",
"name": "sample string 2",
"sales_organization_id": "0a684a50-56b4-4b46-b741-698873c5f3ad",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00",
"code": "sample string 7"
},
"job_priority_id": "0b42dc66-8546-4c74-96bd-efc65006b1da",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9be7300a-68bc-4b15-83b5-9b9837ee00b0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6da5402b-7c19-41f3-b3b9-5038df954e6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
},
"job_status_id": "d7a9a527-d599-4d36-8222-0ab7d888bf14",
"job_status_code": "sample string 11",
"db_address_id": "10e7fa8f-e1e9-4bc5-8489-da05945f0128",
"contact_id": "8da361cb-9fbc-408b-8c72-519003f3070a",
"requested_by_company_id": "913879e9-f87d-4d0e-98a2-7f0a7c14ec64",
"requested_by_contact_id": "7104ea92-4eba-44fb-9542-61fb21292cab",
"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-11T23:23:13.9575354+00:00",
"due_date": "2026-09-11T23:23:13.9575354+00:00",
"date_create": "2026-09-11T23:23:13.9575354+00:00",
"date_update": "2026-09-11T23:23:13.9575354+00:00",
"date_closed": "2026-09-11T23:23:13.9575354+00:00",
"suggested_user_id": "ccc8e946-a251-4ee6-910b-da5a069f2f4d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fce26438-b5d0-4bb8-a9db-9436d1149109",
"db_language_id": "f52d394d-ecdf-491d-af16-432fa7654ebb",
"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-11T23:23:13.9575354+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "39d3f6ca-e2c5-4d86-bc12-3c55d325c73f",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "69a68f7e-5aa5-49d4-a3c9-c691d4a675fc",
"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": "f5a6f124-5508-4413-9217-0a9f579b26c2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "11cfce8e-0452-43db-a030-64058f7a2714"
},
"suggested_date_start": "2026-09-11T23:23:13.9575354+00:00",
"skill_id": "e06fa9da-1fef-4d17-bc10-afc39e846f44",
"skill_code": "sample string 32",
"skill": {
"id": "6c4024bf-b2e5-4148-8e1b-3065041144bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "06f12f75-0d9b-4459-bed5-bfa7392834d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9cce2071-0c04-49bb-9428-f88814ae5a4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b176f6bf-497a-4f2a-8adb-6d9dbd8d6d26",
"db_currency_id": "7d321140-d6f4-4958-8f23-d3022e95843f",
"db_language_id": "068b38ec-f007-4b68-8c17-4086745f4a41",
"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-11T23:23:13.9575354+00:00"
},
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ba23c07b-d063-4261-8631-595d06e1e856",
"date_reported_by_company": "2026-09-11T23:23:13.9575354+00:00",
"id2": 36,
"company_id": "b8e0cdd7-97e2-41d2-84fb-13755f4d2a84",
"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": "9083b68c-27d4-4aa2-b9ba-c0dce242d8fd",
"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-11T23:23:13.9575354+00:00"
},
"work_instruction_details_id": "49b2ccd1-f12f-4a6f-b0b5-87fef6934d6e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "77d7701d-354b-4099-ac22-1d17f22da233",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a8a0f9a4-3031-4987-8e28-95957c9ab044",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T23:23:13.9575354+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": "170d9dcc-8e84-4a81-b759-4c91832bf33a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T23:23:13.9575354+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.