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": "2a997c2d-4757-4841-bc57-9cd7354a5d71",
"jobs_id": "6f84868d-4013-4978-a50c-264ad2b5eb1e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8b670e36-59f0-441b-89bd-6e70bc412ad6",
"_parent_id": "7e9ce75a-5bf7-4883-8c69-c4cccfb517aa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b3191fd8-744c-454b-a35a-102155916cd2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a05b320d-c796-440b-91fc-7165aa35bb01",
"_parent_id": "cb5382cf-1924-4305-b759-e38e3af77b64",
"root_parent_id": "9ca98903-c2b0-4b47-be5b-c5b4cdcf660d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c7be3b3e-f3ac-4747-9ef6-57629807b21f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "69edb70a-b6c2-4e04-9704-48c58630dc73",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e83cd04-64e6-4107-96f2-0576a64d36e4",
"_parent_code": "sample string 6",
"sales_organization_id": "9f6ac597-2354-4691-b0ab-1d610806e224",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"modified_dateutc": "2024-07-26T22:26:05.3243509+00:00"
},
"equipment_model_id": "251e512a-314e-4db0-bfc1-411be63df6e1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ab8fa97e-7fa7-4213-970b-d9652a3f6f04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "640288cd-624e-4990-a811-a69f1a19571a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7a26292e-8343-467d-9846-bf99d60aab01",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cd845739-1528-4058-9f87-752bd12c5bba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"modified_dateutc": "2024-07-26T22:26:05.3243509+00:00"
},
"equipment_family_id": "e5cfa025-1a68-4059-8526-49b8a03f6155",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "69edb70a-b6c2-4e04-9704-48c58630dc73",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3e83cd04-64e6-4107-96f2-0576a64d36e4",
"_parent_code": "sample string 6",
"sales_organization_id": "9f6ac597-2354-4691-b0ab-1d610806e224",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"modified_dateutc": "2024-07-26T22:26:05.3243509+00:00"
},
"date_in_production_since": "2024-07-26T22:26:05.3243509+00:00",
"date_out_of_production_since": "2024-07-26T22:26:05.3243509+00:00",
"date_end_support": "2024-07-26T22:26:05.3243509+00:00",
"sales_organization_id": "5c0153e4-dfe1-44b0-8adb-f034d6bcfab7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+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": "2024-07-26T22:26:05.3399769+00:00"
},
"project_status_id": "3891dbd6-671c-46a6-bb87-5b0a39b44c50",
"project_status_code": "sample string 10",
"project_status": {
"id": "734927fb-0134-41a1-b2d0-c63089e0510a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b473c42f-003b-453a-945b-f01cb6083702",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00"
},
"company_id": "fa01d82e-d533-47d9-b56e-ddd069d02d0c",
"company_code": "sample string 12",
"db_address_id": "5894d916-d1b6-4ac0-b299-eb61ba97a963",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9aa1c3ae-1f54-415d-be11-c4003a91e0b3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e02818d3-b4da-4724-95bb-140676c5e675",
"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": "2024-07-26T22:26:05.3399769+00:00",
"date_create": "2024-07-26T22:26:05.3399769+00:00",
"date_update": "2024-07-26T22:26:05.3399769+00:00",
"updated_by_user_id": "c3b9f8dc-20a4-4dba-a7be-63143b9f377f",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-07-26T22:26:05.3399769+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": "2024-07-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-07-26T22:26:05.3399769+00:00",
"date_last_job": "2024-07-26T22:26:05.3399769+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-07-26T22:26:05.3399769+00:00",
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00",
"is_mobile_installation": true
},
"job_type_id": "274f14b6-c1cc-4f23-b5d1-8f360194504c",
"job_type_code": "sample string 7",
"job_type": {
"id": "ab597103-f537-4c94-8b9e-b77ddf8f4360",
"name": "sample string 2",
"sales_organization_id": "69a0c307-1f5c-48d1-80a1-fa1a10a30e32",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00",
"code": "sample string 7"
},
"job_priority_id": "1b170a38-bada-44b7-aa78-5dcf6a82ea84",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "31dd3963-6cee-48a9-a5f7-23800d63b4ee",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f3f0a0cf-88af-4aef-9949-63edb94c8d13",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00"
},
"job_status_id": "16aa1727-801d-42f1-a694-77db64cdfb5b",
"job_status_code": "sample string 11",
"db_address_id": "ea54fcd7-9009-4a30-b9d0-63498ca10682",
"contact_id": "bfeb5455-4f6a-444b-8dd8-ba995d6e983f",
"requested_by_company_id": "284fafba-9705-4ee2-99c8-ee48c85df75d",
"requested_by_contact_id": "15d6efb8-67e8-478b-b390-4acbabbcf7ed",
"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": "2024-07-26T22:26:05.3399769+00:00",
"due_date": "2024-07-26T22:26:05.3399769+00:00",
"date_create": "2024-07-26T22:26:05.3399769+00:00",
"date_update": "2024-07-26T22:26:05.3399769+00:00",
"date_closed": "2024-07-26T22:26:05.3399769+00:00",
"suggested_user_id": "fb1b275c-39d1-40bf-9ad3-199bb9b1fc65",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cd746674-5a06-4889-907e-fea7e3276ae2",
"db_language_id": "7964f0ad-685c-409c-9d77-9aaf48367c44",
"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": "2024-07-26T22:26:05.3399769+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "37654d4c-dfbc-43c8-92fc-b51ffea1c211",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2ee94eaf-21c5-4897-9783-66ed40df055d",
"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": "e10399a8-a5e4-409c-b9f9-d76bf19ea232",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9270acc2-f4ef-4cbb-96d5-9945c9f4ee06"
},
"suggested_date_start": "2024-07-26T22:26:05.3399769+00:00",
"skill_id": "05212b9f-3edf-496f-b963-382a1676a423",
"skill_code": "sample string 32",
"skill": {
"id": "19a7264b-7af0-43d9-a430-f16010372e00",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0b2f2b39-6edb-4cbd-b461-5ca99325b89f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a15f8579-effd-44ee-baa7-b980882e406c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3fb06e-0ed8-40c0-b1cf-bcb19787026b",
"db_currency_id": "9f82978f-95dc-4b50-8ca2-aafbb98481b7",
"db_language_id": "defa2b02-e689-4b46-957d-d8fac9876c96",
"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": "2024-07-26T22:26:05.3243509+00:00"
},
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "42358b5d-8a28-4988-b79e-bbe95bf1b7fa",
"date_reported_by_company": "2024-07-26T22:26:05.3399769+00:00",
"id2": 36,
"company_id": "120d3e8a-3025-4bea-bf00-ffc24cb30eac",
"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": "d3ce1100-04c4-4d9d-8c72-e05b37c2a45c",
"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": "2024-07-26T22:26:05.3399769+00:00"
},
"work_instruction_details_id": "891415fa-689a-47b5-b5de-9869b6a7fbbb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d8d1521f-8bdb-4229-b0c9-ada31a29acb0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "02dc324b-6ee6-4c65-887b-ccdbc9d1eff0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-07-26T22:26:05.3399769+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": "9eb4ed6d-72bb-4caf-8f37-75c1226674a4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-07-26T22:26:05.3399769+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.