Magento2
GET /V1/returnsAttributeMetadata

Get all attribute metadata.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • frontend_input string Required

      HTML for input element.

    • input_filter string Required

      Template used for input (e.g. "date")

    • store_label string Required

      Label of the store.

    • validation_rules array[object] Required

      Validation rules.

      Hide validation_rules attributes Show validation_rules attributes object

      Validation rule interface.

      • name string Required

        Validation rule name

      • value string Required

        Validation rule value

    • multiline_count integer Required

      Of lines of the attribute value.

    • visible boolean Required

      Attribute is visible on frontend.

    • required boolean Required

      Attribute is required.

    • data_model string Required

      Data model for attribute.

    • options array[object] Required

      Options of the attribute (key => value pairs for select)

      Hide options attributes Show options attributes object

      Option interface.

      • label string Required

        Option label

      • value string

        Option value

      • options array[object]

        Nested options

        Option interface.

        Option interface.

    • frontend_class string Required

      Class which is used to display the attribute on frontend.

    • user_defined boolean Required

      Current attribute has been defined by a user.

    • sort_order integer Required

      Attributes sort order.

    • frontend_label string Required

      Label which supposed to be displayed on frontend.

    • note string Required

      The note attribute for the element.

    • system boolean Required

      This is a system attribute.

    • backend_type string Required

      Backend type.

    • is_used_in_grid boolean

      It is used in customer grid

    • is_visible_in_grid boolean

      It is visible in customer grid

    • is_filterable_in_grid boolean

      It is filterable in customer grid

    • is_searchable_in_grid boolean

      It is searchable in customer grid

    • attribute_code string Required

      Code of the attribute.

    Hide response attributes Show response attributes object
    • frontend_input string Required

      HTML for input element.

    • input_filter string Required

      Template used for input (e.g. "date")

    • store_label string Required

      Label of the store.

    • validation_rules array[object] Required

      Validation rules.

      Hide validation_rules attributes Show validation_rules attributes object

      Validation rule interface.

      • name string Required

        Validation rule name

      • value string Required

        Validation rule value

    • multiline_count integer Required

      Of lines of the attribute value.

    • visible boolean Required

      Attribute is visible on frontend.

    • required boolean Required

      Attribute is required.

    • data_model string Required

      Data model for attribute.

    • options array[object] Required

      Options of the attribute (key => value pairs for select)

      Hide options attributes Show options attributes object

      Option interface.

      • label string Required

        Option label

      • value string

        Option value

      • options array[object]

        Nested options

        Option interface.

        Option interface.

    • frontend_class string Required

      Class which is used to display the attribute on frontend.

    • user_defined boolean Required

      Current attribute has been defined by a user.

    • sort_order integer Required

      Attributes sort order.

    • frontend_label string Required

      Label which supposed to be displayed on frontend.

    • note string Required

      The note attribute for the element.

    • system boolean Required

      This is a system attribute.

    • backend_type string Required

      Backend type.

    • is_used_in_grid boolean

      It is used in customer grid

    • is_visible_in_grid boolean

      It is visible in customer grid

    • is_filterable_in_grid boolean

      It is filterable in customer grid

    • is_searchable_in_grid boolean

      It is searchable in customer grid

    • attribute_code string Required

      Code of the attribute.
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
GET /V1/returnsAttributeMetadata 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/returnsAttributeMetadata'
Response examples (200) 
[
  {
    "frontend_input": "string",
    "input_filter": "string",
    "store_label": "string",
    "validation_rules": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "multiline_count": 42,
    "visible": true,
    "required": true,
    "data_model": "string",
    "options": [
      {
        "label": "string",
        "value": "string",
        "options": [
          {}
        ]
      }
    ],
    "frontend_class": "string",
    "user_defined": true,
    "sort_order": 42,
    "frontend_label": "string",
    "note": "string",
    "system": true,
    "backend_type": "string",
    "is_used_in_grid": true,
    "is_visible_in_grid": true,
    "is_filterable_in_grid": true,
    "is_searchable_in_grid": true,
    "attribute_code": "string"
  }
]
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root type="array">
  <root>
    <frontend-input>string</frontend-input>
    <input-filter>string</input-filter>
    <store-label>string</store-label>
    <validation-rules type="array">
      <validation-rule>
        <name>string</name>
        <value>string</value>
      </validation-rule>
    </validation-rules>
    <multiline-count type="integer">42</multiline-count>
    <visible type="boolean">true</visible>
    <required type="boolean">true</required>
    <data-model>string</data-model>
    <options type="array">
      <option>
        <label>string</label>
        <value>string</value>
        <options type="array">
          <option>
          </option>
        </options>
      </option>
    </options>
    <frontend-class>string</frontend-class>
    <user-defined type="boolean">true</user-defined>
    <sort-order type="integer">42</sort-order>
    <frontend-label>string</frontend-label>
    <note>string</note>
    <system type="boolean">true</system>
    <backend-type>string</backend-type>
    <is-used-in-grid type="boolean">true</is-used-in-grid>
    <is-visible-in-grid type="boolean">true</is-visible-in-grid>
    <is-filterable-in-grid type="boolean">true</is-filterable-in-grid>
    <is-searchable-in-grid type="boolean">true</is-searchable-in-grid>
    <attribute-code>string</attribute-code>
  </root>
</root>
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (401) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>