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": "cc97fc67-3001-4389-98b0-21190e272e46",
"jobs_id": "2983349b-d5af-40df-b037-1255c091cf51",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a2fb334a-4b4e-41d1-a3f9-233879b16db8",
"_parent_id": "8168e893-7250-4484-87f7-d2aca6ba6ae2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "04a41d8d-4649-4548-ac8a-5b1608c8a14a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1306937f-7bd4-4619-bde9-e6480802dd12",
"_parent_id": "906297cf-867d-4437-89e8-d83990622c89",
"root_parent_id": "04ea36be-05a9-4979-8c74-c694a3b749db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b3306ff3-94d0-4b17-bbce-58ffb982755f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b921c254-46c8-441c-8494-b6fcf462b83e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f6493473-0295-4291-aa2d-52c1bbc63767",
"_parent_code": "sample string 6",
"sales_organization_id": "7cc3dec3-785e-467b-94d8-97bf51f7a3f7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
},
"equipment_model_id": "f8cd97d6-3237-4708-a94b-6b8fa6f4c010",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "66dbbb2a-9dfc-4e26-9b61-4937f38bd0a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4ee192fa-dcbc-4833-a1d1-ab1acb7377eb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "45b8e0df-a8c3-4d34-b9fa-6f860705c6d6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c360fa4-740c-4261-b416-2caba6469124",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
},
"equipment_family_id": "30964d07-967b-436d-9934-4ce8982dbd20",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b921c254-46c8-441c-8494-b6fcf462b83e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f6493473-0295-4291-aa2d-52c1bbc63767",
"_parent_code": "sample string 6",
"sales_organization_id": "7cc3dec3-785e-467b-94d8-97bf51f7a3f7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
},
"date_in_production_since": "2025-06-01T00:18:53.984385+00:00",
"date_out_of_production_since": "2025-06-01T00:18:53.984385+00:00",
"date_end_support": "2025-06-01T00:18:53.984385+00:00",
"sales_organization_id": "a1887cfd-0d42-47d3-9c4b-35f2e4496e01",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+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": "2025-06-01T00:18:53.984385+00:00"
},
"project_status_id": "83b925b6-a07f-49b2-8678-eb791dbc7cf8",
"project_status_code": "sample string 10",
"project_status": {
"id": "c0ab3b4f-d1fe-4463-8650-a62ddb35f23f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8301897b-56ed-452d-8de9-629d20836e6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
},
"company_id": "f94ef4ae-3f5c-426b-897d-712cf01e2bf3",
"company_code": "sample string 12",
"db_address_id": "76f40705-a2c3-440a-8ef1-4862ed74a4ac",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9399dbad-8881-4cb8-980e-dc45535b8e51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "590474b2-d082-4545-9dd2-537082b355aa",
"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": "2025-06-01T00:18:53.984385+00:00",
"date_create": "2025-06-01T00:18:53.984385+00:00",
"date_update": "2025-06-01T00:18:53.984385+00:00",
"updated_by_user_id": "9c5007de-f75f-4f5d-a724-4b2f1b797041",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-01T00:18:53.984385+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": "2025-06-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-01T00:18:53.984385+00:00",
"date_last_job": "2025-06-01T00:18:53.984385+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-01T00:18:53.984385+00:00",
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00",
"is_mobile_installation": true
},
"job_type_id": "93f4bfd2-fbaa-431d-a73f-2580ac707475",
"job_type_code": "sample string 7",
"job_type": {
"id": "647880de-8767-4aef-b606-955ac61b087d",
"name": "sample string 2",
"sales_organization_id": "7eb32c9d-9663-4fde-a59d-8b4a41bfa8a5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00",
"code": "sample string 7"
},
"job_priority_id": "2f8b143b-90ad-4be4-aa18-c5b21cc8641d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "df3c2adf-31dc-428d-a581-5b124e0b8226",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b38bf67e-b576-433f-ab79-c8096d8815e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
},
"job_status_id": "eeabbeac-f11c-40a1-8a06-8c3767943040",
"job_status_code": "sample string 11",
"db_address_id": "f65da745-82e8-46e4-86e7-9a6d5af3d70a",
"contact_id": "e86887da-cfd4-440c-9d69-7c1bf404b33f",
"requested_by_company_id": "82252ce8-ff35-430d-9f36-84586a56cd3b",
"requested_by_contact_id": "e239cbf7-df01-4ed3-bb97-152e171cdb58",
"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": "2025-06-01T00:18:53.984385+00:00",
"due_date": "2025-06-01T00:18:53.984385+00:00",
"date_create": "2025-06-01T00:18:53.984385+00:00",
"date_update": "2025-06-01T00:18:53.984385+00:00",
"date_closed": "2025-06-01T00:18:53.984385+00:00",
"suggested_user_id": "f5de664b-53ac-4c40-94b9-62eb4be20a24",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "151ab73f-84ba-493a-9a45-f1f7f49ae688",
"db_language_id": "bf1a83ff-378a-4810-93bc-07b7e81aabc2",
"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": "2025-06-01T00:18:53.984385+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "71de44af-849f-4126-8f40-bb9061382cce",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ae767b52-a764-4ae4-aea6-ad4dc5e3e359",
"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": "c9f783ca-3162-407c-a41f-2f284dd89518",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "06fe37d7-7f1e-476b-8138-c6d8884d4fe6"
},
"suggested_date_start": "2025-06-01T00:18:53.984385+00:00",
"skill_id": "62eeeb78-4898-4edb-920d-9abb0ee2609e",
"skill_code": "sample string 32",
"skill": {
"id": "4612e36e-9938-4da4-acc7-623be8be9fdf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c88e7f76-17b8-4811-985e-1c3370a00aa7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6e63d64-c7c4-4453-b595-87c690cd21fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "af94a64e-bf92-425f-b33d-c18585155f79",
"db_currency_id": "811eff08-37a8-4ec4-a88c-cdbd47b51c4b",
"db_language_id": "e9610d3e-5244-4a52-a0b7-d763fdfd2bd2",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "efa06557-4e6f-4ffb-88f9-4e53e5674487",
"date_reported_by_company": "2025-06-01T00:18:53.984385+00:00",
"id2": 36,
"company_id": "75dfe01d-c9f6-47ae-8fa0-74e23b89e156",
"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": "2d6b1f8e-4b73-4b52-a67c-fab7d87c2abb",
"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": "2025-06-01T00:18:53.984385+00:00"
},
"work_instruction_details_id": "e8dfde00-2379-479c-b8d1-34d06b6945ea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2be13082-15f9-4bb0-8327-e642cda8d710",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a6891106-3dc2-478c-bf22-7be9298a5703",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-01T00:18:53.984385+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": "28f33cc9-4bf4-4c16-b985-beec4bcc4f6d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-01T00:18:53.984385+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.