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": "9e44b0b4-8247-4c74-834d-87cf78c76ba6",
"jobs_id": "3593b7b3-18e3-4c54-b8fc-5b481e07c2ad",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "480d494b-e564-4aea-8efd-0c0c027a2c26",
"_parent_id": "4c6c402c-1516-4527-9f34-34d88a9e6fc3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1f29ee67-818d-436a-a904-1a55cf0bfab5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "101c49a4-f1bf-451b-95ed-1b16d7b37f67",
"_parent_id": "ac781484-5653-4356-a4b1-cee2d492fe80",
"root_parent_id": "03347fbe-474c-4901-86bc-f780c5b603d8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d129e69a-ad30-4e2c-accb-bb925cf776af",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1d8fffa2-36e7-4861-a9ee-5e5a95422880",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1abd53be-d741-4d4c-b9d9-f4ba92aaacce",
"_parent_code": "sample string 6",
"sales_organization_id": "ae64f6f9-8336-44b0-acf2-4336db64523b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"modified_dateutc": "2026-11-07T07:56:03.8786077+00:00"
},
"equipment_model_id": "dfda96e1-27e6-44cd-b627-f0ab0a7f178b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6ef4bc08-2548-41a8-95ce-c677a52fafc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c48db746-a5a5-4a82-95cc-b0dd7e722c0f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4d5a03c9-bf60-4cc2-acf8-51cdc16cafce",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "68fd33bd-a353-4989-883d-7922056eaac6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"modified_dateutc": "2026-11-07T07:56:03.8786077+00:00"
},
"equipment_family_id": "02ed7832-f22d-4054-a8f7-1039e144741e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1d8fffa2-36e7-4861-a9ee-5e5a95422880",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1abd53be-d741-4d4c-b9d9-f4ba92aaacce",
"_parent_code": "sample string 6",
"sales_organization_id": "ae64f6f9-8336-44b0-acf2-4336db64523b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"modified_dateutc": "2026-11-07T07:56:03.8786077+00:00"
},
"date_in_production_since": "2026-11-07T07:56:03.8786077+00:00",
"date_out_of_production_since": "2026-11-07T07:56:03.8786077+00:00",
"date_end_support": "2026-11-07T07:56:03.8786077+00:00",
"sales_organization_id": "3354ad74-92c3-4491-ad65-b82542014ffa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+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-11-07T07:56:03.8786077+00:00"
},
"project_status_id": "05283007-1f80-4670-b78e-8b95838f0afa",
"project_status_code": "sample string 10",
"project_status": {
"id": "75986bc0-9aa2-4be0-b6ec-271d43566b55",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f951a1b0-ce24-4905-b9f1-a79baa9b3c2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-07T07:56:03.8912504+00:00"
},
"company_id": "a6b34d72-cd88-4915-b37b-a7609456c24d",
"company_code": "sample string 12",
"db_address_id": "58e4b527-bb47-4a3b-a2f8-cf47ddb161ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b0636d0b-3fe0-4604-bf06-69202a657002",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2f321ee0-ba10-412b-b4aa-3cc28ca04256",
"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-11-07T07:56:03.8912504+00:00",
"date_create": "2026-11-07T07:56:03.8912504+00:00",
"date_update": "2026-11-07T07:56:03.8912504+00:00",
"updated_by_user_id": "4d566157-81d2-49cc-9e60-69b0c4807066",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-07T07:56:03.8912504+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-11-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-07T07:56:03.8912504+00:00",
"date_last_job": "2026-11-07T07:56:03.8912504+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-07T07:56:03.8912504+00:00",
"modified_dateutc": "2026-11-07T07:56:03.8912504+00:00",
"is_mobile_installation": true
},
"job_type_id": "4c6229ea-9471-408f-804b-0a405619a286",
"job_type_code": "sample string 7",
"job_type": {
"id": "a84f03ce-a3af-4fdc-a677-ef73cbcc40d7",
"name": "sample string 2",
"sales_organization_id": "28baa898-5447-45f2-9cd7-ae150c6274ed",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-07T07:56:03.8912504+00:00",
"code": "sample string 7"
},
"job_priority_id": "b7d4fe62-2cd9-41ac-9c55-f285c854cbe3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3ac3ed2a-1f12-4478-bb08-7c0df662e989",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "14482494-ab09-4aef-b723-d200c593dff8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-07T07:56:03.9074346+00:00"
},
"job_status_id": "b48ec7a5-a1b7-45f4-91e1-2a0ccafed773",
"job_status_code": "sample string 11",
"db_address_id": "0589e156-787c-4034-bbf3-01e3cda60493",
"contact_id": "356b15d0-6889-48c2-8903-cdb70c87c39d",
"requested_by_company_id": "9abe76be-a7d8-4702-a5b5-a9df3ce9f048",
"requested_by_contact_id": "92f49ae2-ddfc-456d-bbb4-617aa05590ca",
"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-11-07T07:56:03.9074346+00:00",
"due_date": "2026-11-07T07:56:03.9074346+00:00",
"date_create": "2026-11-07T07:56:03.9074346+00:00",
"date_update": "2026-11-07T07:56:03.9074346+00:00",
"date_closed": "2026-11-07T07:56:03.9074346+00:00",
"suggested_user_id": "3b86749b-54cd-4093-876c-eb57166359e8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "03d2f761-3169-464d-a74d-eaa8cc6872ed",
"db_language_id": "00e69beb-3e58-436b-aa77-859ea4ba8c39",
"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-11-07T07:56:03.9074346+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0a037eb1-d5b0-45c1-aa2b-4ae5d9da1ec8",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6d5d7429-b551-4ee1-bafd-ebc9ab67bf3b",
"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": "d2155064-a2d9-457e-af5d-c66741d9207c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-07T07:56:03.9074346+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7c79e2cc-3e0b-4915-8b6a-efbe5b51be7a"
},
"suggested_date_start": "2026-11-07T07:56:03.9074346+00:00",
"skill_id": "a61d3d03-d958-4c6d-954e-be481a816084",
"skill_code": "sample string 32",
"skill": {
"id": "2ef16eeb-a999-488c-b876-86d6e67a55c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6667afa2-2ba2-43da-9b89-38bb1155e03e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ce3af30b-b651-4fa0-9c3c-d50bb6f4156e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8764016d-d362-4520-89c1-fba9d0f76ac6",
"db_currency_id": "bc0e9a2a-41da-4b99-86e3-ff0ee9e04bda",
"db_language_id": "4bf9ad26-334c-494b-9e9f-f5f88d6a8534",
"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-11-07T07:56:03.8786077+00:00"
},
"modified_dateutc": "2026-11-07T07:56:03.9074346+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1cb15971-3f9b-4cb3-933f-37f20c30dbab",
"date_reported_by_company": "2026-11-07T07:56:03.9074346+00:00",
"id2": 36,
"company_id": "3f6fa513-c328-4422-ab0a-69b72f287563",
"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": "111bad9b-5cd0-437a-8130-fb70888cf232",
"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-11-07T07:56:03.9074346+00:00"
},
"work_instruction_details_id": "cb61508b-31e2-4249-833f-6a11b0192013",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "966d4ef7-f90d-4d37-82ff-9534c089be8c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4edb707c-c05b-4c39-a597-67a3b5be4dc8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-07T07:56:03.9074346+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": "2965d981-caf3-403e-ad5b-9eb563250465",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-07T07:56:03.9264955+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.