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": "1a4be80f-e55d-4ae2-a5b9-44e446da02e5",
"jobs_id": "d55340a9-c13c-45a7-a230-1ec76a0add28",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b5e6eb80-c4b2-449c-a373-1a4e6dcba07b",
"_parent_id": "a4d43b72-47c3-4de0-8f8a-9a9bd4362e7e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "08022ae5-a6a9-4e1b-a722-d6ca3d5fe585",
"project_reference_back_office": "sample string 5",
"project": {
"id": "43cc7b32-e522-4d87-bc6c-0323bda491ad",
"_parent_id": "b6974b5f-1900-425c-bef4-1ba8ea1a8096",
"root_parent_id": "f36cb040-b9d0-49d9-ad00-f70085046253",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9a0ab2c2-9eaa-4cb9-8527-b992ed01d233",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3c3168cd-8f52-4260-9901-d943aebab709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3a37405c-319f-4a9c-bc45-c6ca2e36e4f5",
"_parent_code": "sample string 6",
"sales_organization_id": "6932da1d-3289-4d28-9ebb-8357882f59c0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
},
"equipment_model_id": "c1d0b18b-bc9c-485d-b3a1-ea8f94b6c060",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bf1455cd-dc9b-42ad-9924-cd181e7c623f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8384d0da-e03b-403a-99ef-66af2657bf1f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "793a2111-e04e-4edc-bae8-60f628a575d5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "dcb6d1e8-9633-453e-9785-aa57d145cf58",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
},
"equipment_family_id": "ea7cc206-5e06-43ea-ba8e-863e8a15a4d1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3c3168cd-8f52-4260-9901-d943aebab709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3a37405c-319f-4a9c-bc45-c6ca2e36e4f5",
"_parent_code": "sample string 6",
"sales_organization_id": "6932da1d-3289-4d28-9ebb-8357882f59c0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
},
"date_in_production_since": "2026-08-30T16:53:55.6446807+00:00",
"date_out_of_production_since": "2026-08-30T16:53:55.6446807+00:00",
"date_end_support": "2026-08-30T16:53:55.6446807+00:00",
"sales_organization_id": "39bc089c-caef-4ca9-91a7-4438390bd927",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+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-08-30T16:53:55.6446807+00:00"
},
"project_status_id": "0cabf1d9-bd01-484e-b7bc-f164aacb91b8",
"project_status_code": "sample string 10",
"project_status": {
"id": "d3a6a44e-ef07-4e95-ae76-5a53716701b9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5c0e1eec-17e4-4f65-a15d-35b7bb762ce0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
},
"company_id": "1749b4d5-5483-4c7c-9134-50e4f312b4d0",
"company_code": "sample string 12",
"db_address_id": "f2a209b2-de71-443d-a2d4-43596555b69d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "99a40970-dd10-42cc-8f35-8e274bd641a2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6bef01cd-e7a9-4ab5-b6ca-ba15e75058b6",
"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-08-30T16:53:55.6446807+00:00",
"date_create": "2026-08-30T16:53:55.6446807+00:00",
"date_update": "2026-08-30T16:53:55.6446807+00:00",
"updated_by_user_id": "92e886f1-ef67-4d32-a8fc-546c4cac78fe",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T16:53:55.6446807+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-08-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T16:53:55.6446807+00:00",
"date_last_job": "2026-08-30T16:53:55.6446807+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T16:53:55.6446807+00:00",
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00",
"is_mobile_installation": true
},
"job_type_id": "2093786c-366a-4ed5-896e-326fe016c819",
"job_type_code": "sample string 7",
"job_type": {
"id": "a0fcb64d-58d3-4ea1-ad20-e39098c843d4",
"name": "sample string 2",
"sales_organization_id": "0e561465-0d18-4205-bc4d-b80d74133ec4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00",
"code": "sample string 7"
},
"job_priority_id": "4b335e6e-461c-4f8d-a156-d021cc57e8d7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5a8255ab-f4fe-4690-b60a-ee1fa07715db",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a799286d-9cbc-4b6d-8af2-07f8637d3cf4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
},
"job_status_id": "e581b1f6-52b5-4ed1-bcd3-bfa560fd1898",
"job_status_code": "sample string 11",
"db_address_id": "af74a1dd-8b18-4eaf-b386-78a809e172ca",
"contact_id": "8a64954a-ba7c-4eab-8b3e-567cf7582699",
"requested_by_company_id": "d6da5224-04af-44d9-8b8e-8d315c0030cb",
"requested_by_contact_id": "ea52e0ba-7aab-48cf-a0b3-d368f33eb1e8",
"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-08-30T16:53:55.6446807+00:00",
"due_date": "2026-08-30T16:53:55.6446807+00:00",
"date_create": "2026-08-30T16:53:55.6446807+00:00",
"date_update": "2026-08-30T16:53:55.6446807+00:00",
"date_closed": "2026-08-30T16:53:55.6446807+00:00",
"suggested_user_id": "dfa87209-2f27-4051-b229-57f5bae44efa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "48555264-2ad4-4233-878f-2ddb0af932a5",
"db_language_id": "8ca4ef75-31d8-4fe6-bec2-afefec097ffb",
"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-08-30T16:53:55.6446807+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4ede4f9b-8ae3-487c-872f-51d278550b30",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51be6962-d3ad-4a97-8ab1-35ce18326df3",
"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": "55fa0cad-c513-40ac-848c-37fed8fb8bc1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "50135bb3-2f32-4232-917c-344a1d65c9d6"
},
"suggested_date_start": "2026-08-30T16:53:55.6446807+00:00",
"skill_id": "6128b207-5345-42b4-902d-6388a652e148",
"skill_code": "sample string 32",
"skill": {
"id": "7a557ab3-06e8-4378-98da-cfafbd5043ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e2538077-34f9-4559-a70e-b74d9566589d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a45ddb22-09a8-4262-9de4-b1e87fdccafe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d4c566ca-d1dc-41c1-978d-306d157266b6",
"db_currency_id": "db841c1a-3c95-4e4c-afdb-0079c930bc03",
"db_language_id": "ef188bc0-0229-404b-8eb6-886d34d3e60e",
"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-08-30T16:53:55.6446807+00:00"
},
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78b310d3-7922-433d-a299-4f97acd2d89c",
"date_reported_by_company": "2026-08-30T16:53:55.6446807+00:00",
"id2": 36,
"company_id": "8576e7b4-ee8b-4931-9dc7-ab7dad27248f",
"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": "cd502edf-d77b-4e5f-a448-3c93afc2b1c6",
"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-08-30T16:53:55.6446807+00:00"
},
"work_instruction_details_id": "a4412b37-2d89-4784-ab22-f26036b182ab",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "49afc30d-5d23-438e-bd6e-67eff55fb226",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9bc831bd-6e08-4f34-86b6-e2967042b768",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T16:53:55.6446807+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": "eb2aeada-dc8b-40b0-ab6c-3d9f9477e22b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T16:53:55.6446807+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.