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": "2f0e77fb-df5c-4b6b-8843-3c18a9bfe5c1",
"jobs_id": "ba7f261c-da16-45d3-8f72-145427a11acf",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c6a533e1-a085-4be5-b303-c590f4c8d304",
"_parent_id": "99c26f76-924d-49b6-81dc-7c4e95837cce",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "31a500dd-af17-4b93-b592-452f08ac732a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "60b37879-f8d0-42c4-abb9-dc6cb7740bb3",
"_parent_id": "edec25f7-c6d5-483d-b80d-98ffe01871cc",
"root_parent_id": "18c0abfb-32b6-4096-ab73-80222822444d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "679ec8d0-a03e-4e88-ab99-59b17ac42283",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3ca388db-5fa1-4544-828f-085272c6fa78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a3df915e-4c1c-4532-a96d-04d83c3f785e",
"_parent_code": "sample string 6",
"sales_organization_id": "e982af18-2c04-4970-bcd4-b097fc572262",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00"
},
"equipment_model_id": "5234ae8a-7deb-426a-a4d8-f737b12b5606",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3e282b0b-44cc-4c8b-ad40-7ae49b38f26d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "773f0c08-c42a-4af1-89bc-8708ad6502b9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6f87f95f-7bc8-4f2b-8fd9-f99bacc92d4b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3c44ecc6-96ad-46d6-8073-8c5ab382fd77",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00"
},
"equipment_family_id": "4e2dc6bc-8a00-451c-8013-ef8a39734d91",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3ca388db-5fa1-4544-828f-085272c6fa78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a3df915e-4c1c-4532-a96d-04d83c3f785e",
"_parent_code": "sample string 6",
"sales_organization_id": "e982af18-2c04-4970-bcd4-b097fc572262",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00"
},
"date_in_production_since": "2024-11-20T11:16:06.2321113+00:00",
"date_out_of_production_since": "2024-11-20T11:16:06.2321113+00:00",
"date_end_support": "2024-11-20T11:16:06.2321113+00:00",
"sales_organization_id": "a4d785ea-fb9e-4e36-bb13-bfa90a40472a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+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-11-20T11:16:06.2321113+00:00"
},
"project_status_id": "f140cdbc-5cd0-4056-bccc-e456379be232",
"project_status_code": "sample string 10",
"project_status": {
"id": "f70f355c-81b2-4b36-ad26-870e4793d065",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b2287209-9df0-461c-9745-f1f8c812418f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00"
},
"company_id": "54f8d267-8cb6-4163-84f1-9ea06f8ad5a7",
"company_code": "sample string 12",
"db_address_id": "a3bcaeeb-c97d-424c-a07a-dfd2fe7423b1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aa0d6eef-926a-464f-b840-200845554583",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "35fab2d1-c0d6-4f2b-98e4-584f7be8cfc0",
"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-11-20T11:16:06.2321113+00:00",
"date_create": "2024-11-20T11:16:06.2321113+00:00",
"date_update": "2024-11-20T11:16:06.2321113+00:00",
"updated_by_user_id": "d1510e50-578f-4924-9f4f-b22fe241f7ce",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-11-20T11:16:06.2321113+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-11-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-11-20T11:16:06.2321113+00:00",
"date_last_job": "2024-11-20T11:16:06.2321113+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-11-20T11:16:06.2321113+00:00",
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00",
"is_mobile_installation": true
},
"job_type_id": "99b37da3-9ba0-4b27-93a0-ab2e5a3ba0a3",
"job_type_code": "sample string 7",
"job_type": {
"id": "3ae1c944-a35f-4926-9721-8e8ab5c4fb6f",
"name": "sample string 2",
"sales_organization_id": "79debf39-fc0e-4a27-8829-61585efc8928",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00",
"code": "sample string 7"
},
"job_priority_id": "d44f84b5-6d1a-4831-a21c-a3b9bd8715d7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b19ccb16-913a-47c3-b031-a6fdcdf55da3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9888e449-8850-4f9e-8c66-8a7fb9ca4f59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00"
},
"job_status_id": "65d704a7-c1d3-45ae-8119-4ec6395904f1",
"job_status_code": "sample string 11",
"db_address_id": "b55b6709-a37c-4b11-a613-563737f5ebeb",
"contact_id": "c591b99b-d5a0-45e6-a07e-3684f292b75a",
"requested_by_company_id": "7671ef30-8bde-4e13-97b9-ed6b60810d2c",
"requested_by_contact_id": "876ef332-d7c4-4a65-befb-371845c75518",
"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-11-20T11:16:06.2321113+00:00",
"due_date": "2024-11-20T11:16:06.2321113+00:00",
"date_create": "2024-11-20T11:16:06.2321113+00:00",
"date_update": "2024-11-20T11:16:06.2321113+00:00",
"date_closed": "2024-11-20T11:16:06.2321113+00:00",
"suggested_user_id": "e94f699c-e32b-485b-8c36-743cca0184c0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8b13e7ca-d06d-4732-b557-be1d1d15fb97",
"db_language_id": "22790e9d-4f87-4ae7-a23d-017b53c5f232",
"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-11-20T11:16:06.2321113+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cf2295d4-e473-4d96-bbd0-1cf978d6b8dc",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "834317a3-fee5-46f7-8cd5-ad7eacdbafe3",
"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": "73161901-f927-464f-b9ee-98345171a34e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "404e1222-1c88-4f64-9352-46053f495424"
},
"suggested_date_start": "2024-11-20T11:16:06.2321113+00:00",
"skill_id": "d811823a-3535-48df-85f7-b1a65e5aeed4",
"skill_code": "sample string 32",
"skill": {
"id": "c13bf93e-c6ab-4d6e-8c8c-eb677692ca36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8cdd3437-4e6f-4990-8e27-c026c8dc7ef6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "54af0ffa-e2ad-483a-b663-8e80e29cfa40",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e35a418e-d684-4c2f-88da-1b56eb690fd5",
"db_currency_id": "b106d258-5f8e-46d0-b986-6d59bba090aa",
"db_language_id": "dfeee29b-215a-4606-b60e-9d4223d689af",
"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-11-20T11:16:06.2321113+00:00"
},
"modified_dateutc": "2024-11-20T11:16:06.2321113+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "180923c1-1082-45f7-8589-f3e713d67f42",
"date_reported_by_company": "2024-11-20T11:16:06.2321113+00:00",
"id2": 36,
"company_id": "74705a35-92d4-4850-b606-af256d3741b7",
"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": "7c29e924-8ba4-4e09-91c7-ef5903ed5e7f",
"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-11-20T11:16:06.247737+00:00"
},
"work_instruction_details_id": "f1d804e0-6da4-47bf-83c6-6fe286d9e43b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2fcdb82c-1a79-48c1-b435-23d8b32060f5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f49825f-12e2-4636-a14e-0743011616c2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-11-20T11:16:06.247737+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": "8134409a-f3ee-45ed-b920-95e8e292d1d5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-11-20T11:16:06.247737+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.