Magento – Rest Api. How to control attribute in api2.xml with attribute rules when attribute contains the attributes array of object in other table

apimagento-1.9

My JSON string like this:

{
  "id": "74",
  "created_at": "2015-07-22 09:36:57",
  "created_by": "1",
  "updated_at": "2015-07-22 09:36:57",
  "updated_by": "1",
  "store": {
    "group_id": "1",
    "website_id": "1",
    "name": "Main Website Store",
    "root_category_id": "2",
    "default_store_id": "1",
    "group": [
      {
        "id": "4",
        "name": "group 4 - store web 2",
        "description": null,
        "level": "1",
        "product": [
          {
            "id": "1",
            "created_at": "2015-07-20 07:54:07",
            "created_by": "1",
            "updated_at": "2015-07-20 07:54:07",
            "updated_by": "1"
          },
      }
    ]
  }
}

it's mean in House have one "store", in "store" have many "group" and in "group" have many "product".
I tried adding the attributes as group, product to file api2.xml to manage in the Edit attribute rules but it does not work when I unchecked.
"group", "product" are on the table different database.

My api2.xml:

<config>
    <api2>
        <resource_groups>
            <house translate="title" module="Hihi_House">
                <title>House API Call</title>
                <sort_order>20</sort_order>
            </house>
        </resource_groups>
        <resources>
            <house translate="title" module="Hihi_House">
                <group>house</group>
                <model>hihi_house/api2_house</model>
                <title>House API</title>
                <sort_order>10</sort_order>
                <privileges>
                    <customer>
                        <retrieve>1</retrieve>
                    </customer>
                </privileges>
                <attributes>
                    <id>Id</id>
                    <name>Name</name>
                    <store>Store</store>
                    <group>Group</group>
                    <product>Product</product>
                    <created_at>Created At</created_at>
                    <created_by>Created By</created_by>
                    <updated_at>Updated At</updated_at>
                    <updated_by>Updated By</updated_by>
                </attributes>
                <routes>
                    <route_entity>
                        <route>/house</route>
                        <action_type>entity</action_type>
                    </route_entity>
                    <route_collection>
                        <route>/house/list</route>
                        <action_type>collection</action_type>
                    </route_collection>
                </routes>
                <versions>1</versions>
            </house>
        </resources>
    </api2>
</config>

Thanks!

Best Answer

In api2.xml the attributes you define are top-level attributes. You cannot use them to filter nested data arrays, at least not using unmodified core code.

The only attributes you have defined the will do anything are:

id
created_at
created_by
updated_at
updated_by
store

Related Solutions

Magento – How to set a method in route action_type in rest API (api2.xml)

As far as I understand you can only have a route_entity and a route_collection and with those you can have a GET, PUT, POST and DELETE (have a look at http://www.restapitutorial.com/lessons/httpmethods.html) and they will match functions called _retrieve, _update, _create and _delete. To implement your own REST API methods have a good look at e.g. api2.xml in the customer module. So for instance in your own api2.xml file you can have:

<privileges>
   <admin>
     <create>1<create>
     <update>1</update>
     <retrieve>1</retrieve>
   </admin>
   ....
   <routes>
     <route>/myextension/myproduct/:product_id</route>
        <action_type>collection</action_type>
     </route>

Note that I use admin here because a Guest can use only GET. My admin role can now POST (create) and PUT (update) and GET (retrieve).

My code would then look like this:

class Mymodule_Myextension_Model_Api2_Myproduct_Rest_Admin_v1 extends Mymodule_Myextension_Model_Api2_Myproduct
{
protected function _update($productData)
{ ... }
protected function _create($productData)
{ ... }
protected function _retrieve($productData)
{ ... }

There is a good tutorial on http://devdocs.magento.com/guides/m1x/other/ht_extend_magento_rest_api.html

Magento – Magento 2 – How to get attribute options array for inserting the data using rest api

First of all, we need take a look: Log in Magento Admin > Choose a product > ADVANCED SETTINGS > Custom Options:

We can see some fields, we need to fill in these input fields.

Second, we have the APIs for updating the custom options: http://devdocs.magento.com/swagger/#resource_catalogProductCustomOptionRepositoryV1

POST: /V1/products/options
PUT: /V1/products/options/{optionId}

For example:

{
  "option": {
    "product_sku": "string",
    "option_id": 0,
    "title": "string",
    "type": "string",
    "sort_order": 0,
    "is_require": true,
    "price": 0,
    "price_type": "string",
    "sku": "string",
    "file_extension": "string",
    "max_characters": 0,
    "image_size_x": 0,
    "image_size_y": 0,
    "values": [
      {
        "title": "string",
        "sort_order": 0,
        "price": 0,
        "price_type": "string",
        "sku": "string",
        "option_type_id": 0
      }
    ],
    "extension_attributes": {}
  }
}

product_sku: Product SKU
option_id: We can get by /V1/products/{sku}/options
title: Title of the custom option.
type: Input Type: Text, File, Dropdown, Radio, etc
sort_order: Set the order of custom attribute
is_require: Required or not
price: Price for the custom option
price_type: Fixed or Percent
sku: (updated later)
file_extension: can be empty, allowed file types: pdf, jpg, ...
max_characters: can be empty, used for Input type: Field, Area.
image_size_x and image_size_y: blank if it is not an image.
values: can be empty, used for Select Type: Dropdown, Radio Buttons, Checkbox, Multiple Select. We need to set the title, price type, Sortorder, etc.

Best Answer

Related Solutions

Magento – How to set a method in route action_type in rest API (api2.xml)

Magento – Magento 2 – How to get attribute options array for inserting the data using rest api

Related Topic