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": "57c5a2a3-4fe9-4b39-81b5-42616eed1b32",
"jobs_id": "0ac6cc75-9a06-4aff-9cff-699a786628d9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "963982f8-b86e-40a1-bb45-8d81609fe15e",
"_parent_id": "a91f3c3c-2ab4-46ef-9449-c1c98b8026fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "07b868c2-762c-4a95-b59f-9dbce611cb34",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fedee312-c822-4d1c-8945-6cb35a52d790",
"_parent_id": "1854abd6-0b51-42fd-b72a-911720cf4a06",
"root_parent_id": "5da80a73-1039-468e-bbe6-b9b74624cf0a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "12bc0b5b-5ac1-4f3d-a3b1-eece51b27606",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1abbec57-fa16-44ab-928a-ec91dc356637",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e4c05be-4dd1-48e3-88f5-f8cea5295d4f",
"_parent_code": "sample string 6",
"sales_organization_id": "7228c987-31f9-4dfd-8dc4-0ff5e76c7860",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
},
"equipment_model_id": "fcc2504d-7995-4031-9d32-453de334ec39",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3d55b4bf-c530-411a-acf2-f8e10da8d81b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "84a6bfe8-8c83-4d1b-bec5-fb2d888edb8f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fe62b6dd-557c-4bd3-ab1c-214a3e6e1c88",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "05ab2ebd-6cf8-4c8d-b1d8-975d3d7f9dae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
},
"equipment_family_id": "6222c3ee-1847-4251-9ad8-0f39212bdefb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1abbec57-fa16-44ab-928a-ec91dc356637",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e4c05be-4dd1-48e3-88f5-f8cea5295d4f",
"_parent_code": "sample string 6",
"sales_organization_id": "7228c987-31f9-4dfd-8dc4-0ff5e76c7860",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
},
"date_in_production_since": "2026-09-06T22:30:55.0770618+00:00",
"date_out_of_production_since": "2026-09-06T22:30:55.0770618+00:00",
"date_end_support": "2026-09-06T22:30:55.0770618+00:00",
"sales_organization_id": "2986a0c4-51ef-4da3-85dd-a3b408fcfddd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+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-06T22:30:55.0770618+00:00"
},
"project_status_id": "fdd86b77-7586-4e71-a7e6-2805ef33f9f2",
"project_status_code": "sample string 10",
"project_status": {
"id": "371929f9-d2b7-479e-9916-7393392d8423",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8936afe-6e33-4f93-bfaf-d73c3f0f43aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
},
"company_id": "dc31efab-564f-4c47-96fd-3ee7debe6ff6",
"company_code": "sample string 12",
"db_address_id": "fb4a0913-44f7-4611-a1b6-1dbebda9e671",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "99117352-932a-49c9-8585-202758ebc0f2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2704f4ef-4912-4ec0-bdbd-c1d22232a7bd",
"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-06T22:30:55.0770618+00:00",
"date_create": "2026-09-06T22:30:55.0770618+00:00",
"date_update": "2026-09-06T22:30:55.0770618+00:00",
"updated_by_user_id": "ac51786b-20e0-46f9-b546-5e22f8db4a0d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-06T22:30:55.0770618+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-06T22:30:55.0770618+00:00",
"date_last_job": "2026-09-06T22:30:55.0770618+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-06T22:30:55.0770618+00:00",
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00",
"is_mobile_installation": true
},
"job_type_id": "eb18c393-2e32-415b-bb6f-031bddb3519a",
"job_type_code": "sample string 7",
"job_type": {
"id": "3b602b5f-cc88-436e-9b5d-d92c6f1c95ba",
"name": "sample string 2",
"sales_organization_id": "e685a37a-2ddd-48ef-a4be-472c0b8b4b07",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d4c46f8-fafb-4102-81a7-f2b17a836495",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "53d50b8e-fdb0-4849-a2fa-105fa190c53f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5a8af521-f829-4b68-88d8-a8282216ff4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
},
"job_status_id": "be135d39-834b-4652-8003-0275e7ea50b2",
"job_status_code": "sample string 11",
"db_address_id": "e890a9aa-bd3a-4474-a622-cf45f3a151a4",
"contact_id": "046ebe5c-2e84-464e-98f4-3b5dd7c6af8c",
"requested_by_company_id": "7e18447b-1afb-4c02-921a-6a6d5b2566ce",
"requested_by_contact_id": "3364b13e-d1fe-4d2f-923b-4c515ac1e558",
"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-06T22:30:55.0770618+00:00",
"due_date": "2026-09-06T22:30:55.0770618+00:00",
"date_create": "2026-09-06T22:30:55.0770618+00:00",
"date_update": "2026-09-06T22:30:55.0770618+00:00",
"date_closed": "2026-09-06T22:30:55.0770618+00:00",
"suggested_user_id": "fe51349d-e297-4eba-9fe2-7557065e3e40",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "84b6e202-7ab2-4cd5-a2b9-c166e5aee19f",
"db_language_id": "89038829-009a-4edd-a1b3-b6c40e578ddb",
"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-06T22:30:55.0770618+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "807c2d75-afc1-42c7-a1b9-7c062f60a5b3",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "54f19a7a-c5be-4b4c-b263-4527707a7107",
"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": "2b82f6cf-d9b7-4154-866a-18267400c450",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "615ef4e0-fc97-4cd8-bd08-3fdf4605e407"
},
"suggested_date_start": "2026-09-06T22:30:55.0770618+00:00",
"skill_id": "f3e1e91c-4808-44f1-b358-a09c658946b2",
"skill_code": "sample string 32",
"skill": {
"id": "8de343d7-6308-47de-98f8-727a5e3aa648",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dfed2d30-0c09-4f99-ac70-f734a092cd3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25d371ce-a05a-4c37-bd5f-40e3aa83b201",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ca01343d-96e8-41b7-b32f-f44194f09960",
"db_currency_id": "7e478cde-ae27-4e58-aa16-f48e887696e7",
"db_language_id": "13b769a3-e28d-4a2d-82fe-94d026de2b3c",
"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-06T22:30:55.0770618+00:00"
},
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e35dd579-53e1-4c58-b939-e058c3e01b80",
"date_reported_by_company": "2026-09-06T22:30:55.0770618+00:00",
"id2": 36,
"company_id": "8da40865-5989-4419-99bb-e1eaa1114f31",
"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": "d79d8f3c-b8a1-4728-ab01-27ea2bfef95e",
"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-06T22:30:55.0770618+00:00"
},
"work_instruction_details_id": "b8de7aae-924d-4354-9997-6afbc09f8727",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5f782374-b7d8-4522-8909-883f979cd1a0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0937bf8a-fbb2-4861-be1a-c62ab090590e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-06T22:30:55.0770618+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": "a5e51bbd-c9eb-4aa3-a6f0-2984d891af1e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-06T22:30:55.0770618+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.