Attribute groups

Resource Representation ↑

Example:
{
    "id": 1,
    "code": "Attribute group 1",
    "name": "Attribute group 1"
}

Supported Formats

json
>>>

GET /api/v2/attribute_groups
List attribute groups

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
{
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
        {
            "id": 2,
            "code": "grp1",
            "name": "Grp1",
            "attribute_group_attribute_definitions": [
                {
                    "id": 25,
                    "attribute_group_id": 11,
                    "attribute_definition_id": 6,
                    "created_at": "2019-06-22T14:52:53.209+10:00",
                    "updated_at": "2019-06-22T14:52:53.209+10:00",
                    "sort_order": 11,
                    "completeness": false
                },
                {
                    "id": 27,
                    "attribute_group_id": 11,
                    "attribute_definition_id": 10,
                    "created_at": "2019-06-22T14:54:42.488+10:00",
                    "updated_at": "2019-06-22T14:54:42.488+10:00",
                    "sort_order": 33,
                    "completeness": false
                },
                {
                    "id": 28,
                    "attribute_group_id": 11,
                    "attribute_definition_id": 3,
                    "created_at": "2019-06-22T14:57:20.783+10:00",
                    "updated_at": "2019-06-22T14:57:20.783+10:00",
                    "sort_order": 22,
                    "completeness": true
                }
            ]
        }
    ]
}

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
created_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
created_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
updated_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String
id
optional

Attribute group ID

Validations:

  • Must be a String
>>>

POST /api/v2/attribute_groups
Create or update attribute group

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "attribute_group": {
      "code": "attr_grp_1",
      "name": "Attribute group 1",
      "attribute_definitions": [
        { "attribute_definition_code": "attr_1", "sort_order": 1, "completeness": false },
        { "attribute_definition_code": "attr_2", "sort_order": 2, "completeness": true }
      ]
    }
  }

response:
  {
      "id": 11,
      "code": "attr_grp_1",
      "created_at": "2019-06-22T14:52:53.083+10:00",
      "updated_at": "2019-06-22T14:52:53.083+10:00",
      "name": "Attribute group 1"
  }

Params

Param name Description
attribute_group
required

Validations:

  • Must be a Hash
attribute_group[code]
required

Code of the attribute group

Validations:

  • Must be a String
attribute_group[name]
required

Name of the attribute group

Validations:

  • Must be a String
attribute_group[attribute_definitions]
optional , nil allowed

Link to attribute definitions

Validations:

  • Must be an Array of nested elements
attribute_group[attribute_definitions][attribute_definition_code]
optional , nil allowed

Attribute definition code

Validations:

  • Must be a String
attribute_group[attribute_definitions][sort_order]
optional , nil allowed

Sort order

Validations:

  • Must be a Integer
attribute_group[attribute_definitions][completeness]
optional , nil allowed

Use it for completeness

Validations:

  • Must be one of: true, false, 1, 0.
attribute_group[attribute_definition_mode]
optional , nil allowed

Update mode for Attribute Definition. Default is add.

Validations:

  • Must be one of: add, reset.
>>>

DELETE /api/v2/attribute_groups/:id
Delete an attribute group

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 2
  }