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": "0fc5660b-3b1a-4f96-baa1-382bca46d872",
"jobs_id": "bc64d638-1343-4334-947c-71513e6aac6f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8d7d3501-9491-47cd-8353-31b1cece2e62",
"_parent_id": "a23579e0-d919-4559-a49c-6b924002e8fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "58407ad0-602d-4ceb-83ee-c66b55991192",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3598ba6-1f0f-4dcb-8ac7-f604d71a86fd",
"_parent_id": "cdbdece9-3858-4935-87d4-5b72d12fac02",
"root_parent_id": "dc5c65a9-4e7d-4eda-b7fa-6c8d9dd2af1c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0e264d5-b96c-48b9-a51c-3d9568bf3065",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "783fdc94-ceb3-419e-ae49-2c3bcefac6c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "568238a6-125d-4077-b36d-c4913d6567da",
"_parent_code": "sample string 6",
"sales_organization_id": "9b2a3d66-9725-4c82-a313-3cc041cb1dbc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
},
"equipment_model_id": "ea02f1bc-315c-4d44-837a-8d595d28cf4c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5679abc0-1089-426d-89de-9606064756f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fc482220-1b83-4c00-b3e8-10c79bc42472",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "582df74a-d9ce-4c1e-b24f-5746f0375c56",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "424bf285-cf81-40ce-afeb-429bdfee0e06",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
},
"equipment_family_id": "c07f2a74-9330-47b6-b80c-47a7d6bddae7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "783fdc94-ceb3-419e-ae49-2c3bcefac6c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "568238a6-125d-4077-b36d-c4913d6567da",
"_parent_code": "sample string 6",
"sales_organization_id": "9b2a3d66-9725-4c82-a313-3cc041cb1dbc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
},
"date_in_production_since": "2026-07-27T07:42:12.6419979+00:00",
"date_out_of_production_since": "2026-07-27T07:42:12.6419979+00:00",
"date_end_support": "2026-07-27T07:42:12.6419979+00:00",
"sales_organization_id": "a2ede229-e93e-4743-98a1-78d6e8b59739",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+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-07-27T07:42:12.6419979+00:00"
},
"project_status_id": "1c55c802-23f4-496e-893c-4c0b84464b83",
"project_status_code": "sample string 10",
"project_status": {
"id": "e4b46d20-3aa1-460e-960b-2ea5b98d2d19",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9813757e-7413-4302-9a2e-7aa3b167ff1a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
},
"company_id": "dda11df4-607c-45fd-94b8-9404cedba746",
"company_code": "sample string 12",
"db_address_id": "bf18c8f0-a86f-4d10-bce2-294fdd43cf6f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "24fc1010-53de-4348-98bc-abd412a34b88",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "520911e5-7dc2-48c0-8b6d-e805f60fdfc2",
"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-07-27T07:42:12.6419979+00:00",
"date_create": "2026-07-27T07:42:12.6419979+00:00",
"date_update": "2026-07-27T07:42:12.6419979+00:00",
"updated_by_user_id": "05210d9f-f96d-447c-bcf1-580d22b25e4a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-27T07:42:12.6419979+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-07-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-27T07:42:12.6419979+00:00",
"date_last_job": "2026-07-27T07:42:12.6419979+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-27T07:42:12.6419979+00:00",
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00",
"is_mobile_installation": true
},
"job_type_id": "7b82d768-f78b-4c89-80ed-ca6454e348fb",
"job_type_code": "sample string 7",
"job_type": {
"id": "c9ff9f0b-bc46-43c6-be58-651c87e26bdf",
"name": "sample string 2",
"sales_organization_id": "c473431a-ac02-432c-b915-cb4123e3b218",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00",
"code": "sample string 7"
},
"job_priority_id": "7454159a-703b-4b1b-b635-bf4a49c399db",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e280f0f4-96c2-42f2-aae5-9e342626142e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e73323db-a02b-4c6c-aa79-d08a367af9ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
},
"job_status_id": "58d263d4-e467-46cc-a7e2-c09a421c7bff",
"job_status_code": "sample string 11",
"db_address_id": "3138ade3-c000-4116-a112-1c162760145c",
"contact_id": "d0710db7-1100-41bf-b781-14f137ce9494",
"requested_by_company_id": "e75a308a-88e6-473e-94a5-e11be070bd81",
"requested_by_contact_id": "931b3ce3-58fb-40aa-a196-c051466b416d",
"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-07-27T07:42:12.6419979+00:00",
"due_date": "2026-07-27T07:42:12.6419979+00:00",
"date_create": "2026-07-27T07:42:12.6419979+00:00",
"date_update": "2026-07-27T07:42:12.6419979+00:00",
"date_closed": "2026-07-27T07:42:12.6419979+00:00",
"suggested_user_id": "365448bc-e20a-4ade-bcbe-124d5672a0cb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b579770b-84bf-463d-8f8b-edf9ba5fd281",
"db_language_id": "fd5e5f68-9017-419c-b9f4-bf5156e60362",
"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-07-27T07:42:12.6419979+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9f1c466b-0bbb-447c-8ab2-9e6a79fbf9c4",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4a081012-2ebe-4bf1-bb2c-76bd4b788600",
"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": "c54fec9d-dffe-44fd-b71b-7486c1e4b1d3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e867872e-55c5-4d6d-8ac0-9fe72dbf9a53"
},
"suggested_date_start": "2026-07-27T07:42:12.6419979+00:00",
"skill_id": "8387f5fb-79bc-4482-9009-a0ae77f86f99",
"skill_code": "sample string 32",
"skill": {
"id": "deaf2d8c-c03b-445a-8fb9-c443e2c85760",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "861d31db-580e-42f7-8041-9b4a871355ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8844c16-c8a9-41a2-9525-518b780132bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5b8d186-a809-458d-8f96-822721ef763a",
"db_currency_id": "0962932b-8115-45c6-945a-dae96bfbbb2e",
"db_language_id": "63a13415-a7a9-48c2-9ba9-04b94cba6b9e",
"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-07-27T07:42:12.6419979+00:00"
},
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1592456e-21fe-4557-b1ae-2613c544b56a",
"date_reported_by_company": "2026-07-27T07:42:12.6419979+00:00",
"id2": 36,
"company_id": "8d62af39-716c-45fa-b30e-be04156bd291",
"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": "e2755885-2ba5-4414-a606-52e9c4781b25",
"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-07-27T07:42:12.6419979+00:00"
},
"work_instruction_details_id": "7d1f6c6f-dc5f-4851-885f-418f7cd464f2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bb6be174-b8a7-45eb-be42-5872c2d3a228",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6e146d40-3107-485c-b7ec-e1ca96557fd6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-27T07:42:12.6419979+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": "878c6de7-cee5-43ff-818f-194c572981b4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-27T07:42:12.6419979+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.