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": "4a44afd9-f4b1-46ce-940b-25bf6ef2d945",
"jobs_id": "dfd680f7-8bd5-41e6-9b0b-1fce3a2c3a58",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "89372b88-2785-4ab0-aeda-049fae3728df",
"_parent_id": "f9c6d3b3-8318-4d51-b4f8-e41fb6988f25",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bd2580c2-915a-4ca1-882a-7b07f8b37dad",
"project_reference_back_office": "sample string 5",
"project": {
"id": "79e25587-0eef-4c56-8112-6df16a791b67",
"_parent_id": "e8e782df-8be9-4b92-838d-f0ab2f6384ec",
"root_parent_id": "6d38f432-bd85-4a9f-aa9e-89fe8f2d4a6a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "19d642c0-4c5d-4b85-8802-74f35e44eecb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b75f32ab-24e4-47eb-a3c7-32e331bf67f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a5abcbe9-c984-4729-a66d-eda253f15598",
"_parent_code": "sample string 6",
"sales_organization_id": "463ded5a-488b-475e-a586-00393dc32f34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"modified_dateutc": "2023-03-23T15:03:32.4765801+00:00"
},
"equipment_model_id": "ee03baa1-fa94-456c-b8f7-588cfa0007a4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "70ff8597-72ae-4d58-8601-fea7f85e1bb5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "45e42936-37d0-49ff-ad89-2c3512563e5b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d1c0768c-acd8-41bc-8c02-cb3839d903af",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bfb35d30-58aa-46df-a4c4-01df1a57e430",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"modified_dateutc": "2023-03-23T15:03:32.4765801+00:00"
},
"equipment_family_id": "c3ae4654-3422-47f7-aef2-984b7e703de0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b75f32ab-24e4-47eb-a3c7-32e331bf67f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a5abcbe9-c984-4729-a66d-eda253f15598",
"_parent_code": "sample string 6",
"sales_organization_id": "463ded5a-488b-475e-a586-00393dc32f34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"modified_dateutc": "2023-03-23T15:03:32.4765801+00:00"
},
"date_in_production_since": "2023-03-23T15:03:32.4765801+00:00",
"date_out_of_production_since": "2023-03-23T15:03:32.4765801+00:00",
"date_end_support": "2023-03-23T15:03:32.4765801+00:00",
"sales_organization_id": "7670e081-073e-405f-bbb6-951bdb159274",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+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": "2023-03-23T15:03:32.4922033+00:00"
},
"project_status_id": "23f1175a-c270-451f-9fa0-f983ab28d555",
"project_status_code": "sample string 10",
"project_status": {
"id": "a1189eb9-734d-43ba-9f4f-7e95a50fa2b7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2e3978a0-6857-4582-b21f-03245ba7b83b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00"
},
"company_id": "b0523004-e71d-4c4a-97bf-8fbc18b9b4b9",
"company_code": "sample string 12",
"db_address_id": "f8fc6f0a-10dc-43ea-a0b0-60005db960c6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eae4b6b9-ffd2-467a-9fe3-aed52c073487",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c3ad2c9a-b31e-419d-a515-914d39fcfcd4",
"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": "2023-03-23T15:03:32.4922033+00:00",
"date_create": "2023-03-23T15:03:32.4922033+00:00",
"date_update": "2023-03-23T15:03:32.4922033+00:00",
"updated_by_user_id": "12031d60-e7fe-4089-8de2-00a34453c42a",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-03-23T15:03:32.4922033+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": "2023-03-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-03-23T15:03:32.4922033+00:00",
"date_last_job": "2023-03-23T15:03:32.4922033+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-03-23T15:03:32.4922033+00:00",
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00",
"is_mobile_installation": true
},
"job_type_id": "43c19f38-3ec1-4f33-873a-046bb17bdacc",
"job_type_code": "sample string 7",
"job_type": {
"id": "1564c051-7f72-444f-88fe-028cd854218c",
"name": "sample string 2",
"sales_organization_id": "d4eb0d3b-1a47-4289-acc4-7a230f6fb238",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00",
"code": "sample string 7"
},
"job_priority_id": "d47222d2-746e-4cc8-b856-3392dd21d7e3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "011ebf32-544f-4a26-8652-1201838dd68b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ea1d82fd-55af-4d34-9965-e1007335108c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00"
},
"job_status_id": "22ed9593-ba5f-4895-afb5-8ab296fdfc00",
"job_status_code": "sample string 11",
"db_address_id": "2eebca46-c047-4bdd-a8ba-9d993c47b5ad",
"contact_id": "d07c6af8-e860-4125-94f9-f36e0c421629",
"requested_by_company_id": "c0d3a2f9-2da5-4ef3-b718-ccf62eda1cb3",
"requested_by_contact_id": "532c63f9-93a1-4285-bfd6-6d4e02db98f1",
"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": "2023-03-23T15:03:32.4922033+00:00",
"due_date": "2023-03-23T15:03:32.4922033+00:00",
"date_create": "2023-03-23T15:03:32.4922033+00:00",
"date_update": "2023-03-23T15:03:32.4922033+00:00",
"date_closed": "2023-03-23T15:03:32.4922033+00:00",
"suggested_user_id": "59ed7ba2-4e9d-4282-9b08-a68283c99a55",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d777aba3-21b4-4714-b829-c026ffb3eb33",
"db_language_id": "91ff66a8-150a-4159-886c-74ee9c653213",
"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": "2023-03-23T15:03:32.4922033+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89c63ee9-00d8-4424-83c7-4a0858833c6a",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "01e4560a-154f-412f-b50d-5eb324df5149",
"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": "ee6a1911-c21f-4a15-b94e-b3ed0498cad9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "152d88a4-f3eb-48c5-b3eb-6b56c3d09733"
},
"suggested_date_start": "2023-03-23T15:03:32.4922033+00:00",
"skill_id": "7482f5c8-f0ba-4334-9b17-bdbff52fc86a",
"skill_code": "sample string 32",
"skill": {
"id": "01971c3c-1bd4-46b8-9446-7d5bc55c46c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5869a2ec-ea79-4b67-8f61-dc5cb7ae7c1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8ea80dfa-2bdd-43db-84a5-7480ef22d4a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "602a1c14-8425-49fc-b22c-a757515ceb54",
"db_currency_id": "6f59f96a-3b44-4f3c-a99b-5d568c1eaac1",
"db_language_id": "8e20324e-b3a9-45ae-bbc3-3d4752860ea6",
"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": "2023-03-23T15:03:32.4765801+00:00"
},
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "430d3f38-471f-4119-91f7-b855df63fbf5",
"date_reported_by_company": "2023-03-23T15:03:32.4922033+00:00",
"id2": 36,
"company_id": "aa1c0b34-2e12-493e-bf49-45ef2d1aa386",
"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": "3aa5ad32-0b8e-43b9-8b71-61d0940ad6cc",
"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": "2023-03-23T15:03:32.4922033+00:00"
},
"work_instruction_details_id": "acec9e52-893a-419c-9dcd-11ae3e5be28c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4eccbcde-ade7-4ba8-ba05-3ca932591172",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "833bf70f-de7f-426d-83f2-d194be490982",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-03-23T15:03:32.4922033+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": "6abf9f18-5684-41c0-adb1-1ece851202eb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-03-23T15:03:32.4922033+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.