Get custom attributes metadata for the given data interface

GET /V1/attributeMetadata/customer/custom

Get custom attributes metadata for the given data interface.

Query parameters

  • dataInterfaceName string

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 rule interface.

      Validation rule interface.

      Hide validation_rules attributes Show validation_rules attributes object
      • 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

      Option interface.

      Option interface.

      Hide options attributes Show options attributes object
      • label string Required

        Option label

      • value string

        Option value

      • options array[object]

        Option interface.

        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]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • 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 item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

  • 500

    Internal Server error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • 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 item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • 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]

      Error details

      Error details

      Hide errors attributes Show errors attributes object
      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Error parameters item

        Hide parameters attributes Show parameters attributes object
        • 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 item

      Error parameters item

      Hide parameters attributes Show parameters attributes object
      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

GET /V1/attributeMetadata/customer/custom
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/attributeMetadata/customer/custom'
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 (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 (500)
{
  "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)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}