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": "5b975b7f-5dea-4324-9984-c3f5c735bc79",
"jobs_id": "0d15a833-b05d-464c-80a8-f7177782a57b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "627a2395-c8fc-409e-8444-c5aee1979ca1",
"_parent_id": "ac6c12fe-53f2-45ef-b9d1-be86c3963a64",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f63e993e-8e65-4503-97ed-26758ce3c5df",
"project_reference_back_office": "sample string 5",
"project": {
"id": "503e4f16-a1f8-4995-9441-830ccb4a40b2",
"_parent_id": "4fa4b8f6-a1ab-49b3-a671-bab699823223",
"root_parent_id": "58ebb076-fef6-4a5e-b7ea-a77399215a5b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f18ba32d-e6a9-4812-af29-4f9a5771ac2f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c452a8a8-f82e-4693-9c5e-06cb33bf07f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0395888b-535b-417b-923f-d0e1ca6d5c0c",
"_parent_code": "sample string 6",
"sales_organization_id": "427a0043-9df8-4e77-85bd-e6b4ab2810fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
},
"equipment_model_id": "be4dc188-60d0-4810-9598-154adf53ed1d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f8189483-c66e-44f8-ac15-f02816672cfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0d880074-97d0-4ae5-9b85-5bee070dbbe0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e6ee805a-8075-46ee-9bb5-97843d4ef301",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "08037a9a-088d-4452-bb10-f5f0fb020c0f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
},
"equipment_family_id": "076041d8-10a2-4c6b-b712-adabb58c4f46",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c452a8a8-f82e-4693-9c5e-06cb33bf07f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0395888b-535b-417b-923f-d0e1ca6d5c0c",
"_parent_code": "sample string 6",
"sales_organization_id": "427a0043-9df8-4e77-85bd-e6b4ab2810fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
},
"date_in_production_since": "2024-04-22T01:50:24.1466757+00:00",
"date_out_of_production_since": "2024-04-22T01:50:24.1466757+00:00",
"date_end_support": "2024-04-22T01:50:24.1466757+00:00",
"sales_organization_id": "63d60b2e-a099-48f5-bc31-4ef3627e4141",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+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-04-22T01:50:24.1466757+00:00"
},
"project_status_id": "29dd37af-b4fc-4a19-a74d-1aa6968fe20d",
"project_status_code": "sample string 10",
"project_status": {
"id": "063ab908-dfe6-461a-9ae5-8b8a4f0e3c9f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f0608552-2473-4a06-83de-5f295c6aa125",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
},
"company_id": "168058e1-a9d2-4f4d-993a-6d8d3ce6235c",
"company_code": "sample string 12",
"db_address_id": "fd3a7897-a319-4194-87ea-96cac5f718b0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2a5b8ee7-d7b8-48db-96b8-bdf83f160407",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "821a3d13-b6a5-417b-94a9-f71b41fab8aa",
"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-04-22T01:50:24.1466757+00:00",
"date_create": "2024-04-22T01:50:24.1466757+00:00",
"date_update": "2024-04-22T01:50:24.1466757+00:00",
"updated_by_user_id": "edb75c54-05ae-4d9e-b6a5-1dd8dd0dc654",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-22T01:50:24.1466757+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-04-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-22T01:50:24.1466757+00:00",
"date_last_job": "2024-04-22T01:50:24.1466757+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-22T01:50:24.1466757+00:00",
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00",
"is_mobile_installation": true
},
"job_type_id": "3fc3d89a-6bc7-4992-a67c-0fbe7e1b6833",
"job_type_code": "sample string 7",
"job_type": {
"id": "649eaccb-2692-4a02-8776-7bbc4b7c740d",
"name": "sample string 2",
"sales_organization_id": "7b596623-0056-46dc-9380-6c12889a252d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00",
"code": "sample string 7"
},
"job_priority_id": "a34ff92a-a0e7-4dba-839e-39eea874f0b4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1b903940-acfe-4d77-93ce-00fd7a0407ad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9551d2f9-0021-433e-8cc7-a8cd7da331e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
},
"job_status_id": "22fd51cc-8021-4781-8602-76d80ee3799a",
"job_status_code": "sample string 11",
"db_address_id": "518a6e10-34eb-4157-9f13-a7df0cff5143",
"contact_id": "1ccae2b4-be98-42e5-a8f1-bef1f8e90ff9",
"requested_by_company_id": "33efff1a-11fe-47a5-9f61-ae2e1a55e41f",
"requested_by_contact_id": "0a66e476-cacb-4a3f-97ff-eab6ed5fcec5",
"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-04-22T01:50:24.1466757+00:00",
"due_date": "2024-04-22T01:50:24.1466757+00:00",
"date_create": "2024-04-22T01:50:24.1466757+00:00",
"date_update": "2024-04-22T01:50:24.1466757+00:00",
"date_closed": "2024-04-22T01:50:24.1466757+00:00",
"suggested_user_id": "aa3f6ad6-0dee-4a1b-a895-9ea238590308",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "25af0c2a-3592-406b-abd5-1f773dc00c53",
"db_language_id": "72373888-bf06-4264-93d5-9ea984fff462",
"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-04-22T01:50:24.1466757+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3564242c-c1d9-43d5-add9-c0f5480cf0e9",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "856fb443-13b3-4bc7-b93b-ca4ad637c124",
"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": "ca82a7ba-7c98-44c1-83f5-05af3299872c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "857be61b-1fbd-4228-b18d-d767acd57805"
},
"suggested_date_start": "2024-04-22T01:50:24.1466757+00:00",
"skill_id": "73654dc2-84de-43e5-a730-a79a50d82e27",
"skill_code": "sample string 32",
"skill": {
"id": "fd4c9cec-6e2e-4486-9570-9d5f638fba26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6807bbdf-6563-4199-9e77-af014e56289c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5b7193d-13c5-4065-82c7-f9cd24fb447d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39d94adf-690f-431d-b3f9-0cf787811945",
"db_currency_id": "00c6867a-1953-42e3-a8a6-fb51a21104d1",
"db_language_id": "4bace2b4-b73b-4240-8d30-11609f469792",
"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-04-22T01:50:24.1466757+00:00"
},
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a86714d6-2f04-499e-95de-720a3c9bcdf1",
"date_reported_by_company": "2024-04-22T01:50:24.1466757+00:00",
"id2": 36,
"company_id": "0ae9383e-b915-49a5-9552-4a9766c77c69",
"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": "be8e8a84-2d8c-44c5-b19e-cf74e0f399f4",
"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-04-22T01:50:24.1466757+00:00"
},
"work_instruction_details_id": "2f4b3766-7ce6-484f-aa27-bd3350417b6b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fde0f377-7ea7-4753-b1f7-cacff757a1cb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e00ab06-a19c-4ff9-92eb-db68e00de84b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-22T01:50:24.1466757+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": "2257dfa4-c946-412c-9560-9ae577f8b3f0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-22T01:50:24.1466757+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.