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": "d16c0b54-fe0a-4989-8dd7-aa064ae88c6d",
"jobs_id": "f8963e65-8d0e-4732-8106-a5541080a514",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aea2dfd6-8100-4904-ba0f-df2a1d8ad78b",
"_parent_id": "c9de9779-b5cc-4ece-ba01-f664487a70c9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dfcd8768-d697-4264-bcae-5ac69b263491",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b06060b8-b10d-4ed5-a5e5-40a2e20afd3b",
"_parent_id": "34bbc270-736a-4b73-9e35-44370c791041",
"root_parent_id": "2ea73982-ab1c-4ca3-83a5-58f928ac8a78",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b4ef10f-cc24-424a-a912-cb1464f374d8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6df891d2-e3e8-4a2c-8faf-9e2c2e5556e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd83fba3-7f07-4eed-933c-3cd26c2a06d8",
"_parent_code": "sample string 6",
"sales_organization_id": "ec7c029e-52fa-4fcb-b6ac-0639d52d8467",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"modified_dateutc": "2024-05-08T14:31:08.1127226+00:00"
},
"equipment_model_id": "e3f9efa9-216c-4352-9d74-ab188e01604a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e44b6242-aa77-4e3c-98c2-d4df047dc2ec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7c483dea-c4b2-4304-b1f8-aaf9ee9edc5a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "58c53c34-108f-49ce-96f2-ce7ed2d1492b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a34d8717-8341-471e-a173-81d88beacbb3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"modified_dateutc": "2024-05-08T14:31:08.1127226+00:00"
},
"equipment_family_id": "f02fc4ce-86f2-45b0-b4fd-bec175d74166",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6df891d2-e3e8-4a2c-8faf-9e2c2e5556e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd83fba3-7f07-4eed-933c-3cd26c2a06d8",
"_parent_code": "sample string 6",
"sales_organization_id": "ec7c029e-52fa-4fcb-b6ac-0639d52d8467",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"modified_dateutc": "2024-05-08T14:31:08.1127226+00:00"
},
"date_in_production_since": "2024-05-08T14:31:08.1127226+00:00",
"date_out_of_production_since": "2024-05-08T14:31:08.1127226+00:00",
"date_end_support": "2024-05-08T14:31:08.1127226+00:00",
"sales_organization_id": "19b16232-ba68-48eb-9380-e04815cb4de3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+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-05-08T14:31:08.1283471+00:00"
},
"project_status_id": "10fdf091-2b4d-46ab-b0a6-bb7a065a0dab",
"project_status_code": "sample string 10",
"project_status": {
"id": "8c798f2c-ac58-4b60-8cf8-82dcd6f03b55",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "227eaa0a-fa5b-44df-86c7-402e3562db52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00"
},
"company_id": "0973267d-09c2-4c50-a485-3da951bdd472",
"company_code": "sample string 12",
"db_address_id": "e5bf2e27-d9d0-41c6-a5c3-462fb86061ec",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "594cfd95-bb97-4b66-864b-f5d5289ecb08",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "16632bc3-e723-44b3-8c72-d1177f914106",
"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-05-08T14:31:08.1283471+00:00",
"date_create": "2024-05-08T14:31:08.1283471+00:00",
"date_update": "2024-05-08T14:31:08.1283471+00:00",
"updated_by_user_id": "c39b81e7-8fa2-451c-a60e-3f87f86238c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-05-08T14:31:08.1283471+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-05-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-05-08T14:31:08.1283471+00:00",
"date_last_job": "2024-05-08T14:31:08.1283471+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-05-08T14:31:08.1283471+00:00",
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00",
"is_mobile_installation": true
},
"job_type_id": "89ace7f9-65e0-49cf-b0f7-d159845076fa",
"job_type_code": "sample string 7",
"job_type": {
"id": "88fbdfb8-0454-486d-80d8-56a4ba945eb6",
"name": "sample string 2",
"sales_organization_id": "375f15ce-c5b7-4c67-9008-51d57945a2fe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00",
"code": "sample string 7"
},
"job_priority_id": "4054e8b7-db02-47f5-95db-c36b55c41975",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f66ce66b-cc4c-4576-9dd9-be2fd86b8164",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "417927c1-e500-44a3-94da-577567db2072",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00"
},
"job_status_id": "b50c24da-cb8c-4549-a873-a97172a083e6",
"job_status_code": "sample string 11",
"db_address_id": "46eb7aeb-eaa7-4756-89c7-ce58f6b5206d",
"contact_id": "30d8cadb-39d0-4696-9fc2-a6924685d4b6",
"requested_by_company_id": "1d286c6d-7187-4895-b602-99dddb9631db",
"requested_by_contact_id": "504e6753-569c-4b2d-8f2d-5e06fc0cfa26",
"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-05-08T14:31:08.1283471+00:00",
"due_date": "2024-05-08T14:31:08.1283471+00:00",
"date_create": "2024-05-08T14:31:08.1283471+00:00",
"date_update": "2024-05-08T14:31:08.1283471+00:00",
"date_closed": "2024-05-08T14:31:08.1283471+00:00",
"suggested_user_id": "eb1c4cf4-4e5a-425d-9114-c8e437defdbc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "580f0451-d630-4d89-8ece-24ff16ac9eae",
"db_language_id": "ba4893cc-024d-452d-9541-56f4c5f09a63",
"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-05-08T14:31:08.1283471+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a3b8f22e-fb4c-44dd-a0d1-b327c43bed3d",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "86f984e8-f587-441e-8eb8-a8a4e0882064",
"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": "28d4f4ef-5ef5-4028-b2ef-7b5e47bb56d7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b6b162f6-b0f5-4cf0-927d-64ca20617881"
},
"suggested_date_start": "2024-05-08T14:31:08.1283471+00:00",
"skill_id": "4d26cdd3-a0f4-4c77-8679-6519a2a8affb",
"skill_code": "sample string 32",
"skill": {
"id": "d9dc4426-c813-435b-b326-fd5c9374edc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9aa97487-8993-4b88-881e-0c29a825d60d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a88e0e93-1ecf-4d3b-8955-7da5046baad3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfafb40f-20d8-4552-884d-37eb0a5b9b30",
"db_currency_id": "cd82daf8-1bca-4e2a-a8db-66abf8885efd",
"db_language_id": "fd7c5911-3235-4b14-b5ff-6e1aacc073db",
"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-05-08T14:31:08.1127226+00:00"
},
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0d020ea4-e929-4dc4-8f43-18200e82f94f",
"date_reported_by_company": "2024-05-08T14:31:08.1283471+00:00",
"id2": 36,
"company_id": "d68d3276-65cc-4908-846c-c5df491a73d8",
"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": "897db5ba-c84c-4696-9a40-3e0199548345",
"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-05-08T14:31:08.1283471+00:00"
},
"work_instruction_details_id": "c63e76eb-0c7d-4521-b511-e26672e7b31d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cb803ca1-4257-43ae-99bf-381b4d7f0f65",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6cd7705d-ab07-4a9a-8cc4-1c6128abd30d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-05-08T14:31:08.1283471+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": "93baa32f-6c89-4b12-9b7d-c78b613b2592",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-05-08T14:31:08.1283471+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.