Methods

  • POST — Get a list of metadata descriptions of filtered groups
  • GET — Get a list of metadata descriptions of filtered groups

Resource

{
    "error": "string",
    "result": {
        "result": [
            {
                "__createdAt": "date-time",
                "__createdBy": "uuid",
                "__deletedAt": "date-time",
                "__id": "uuid",
                "__name": "string",
                "__updatedAt": "date-time",
                "__updatedBy": "uuid",
                "description": "string",
                "isDefault": "boolean",
                "isRole": "boolean"
            }
        ],
        "total": "int64"
    },
    "success": "boolean"
}

Properties

Name Type Description Additional
error string

Error message if success == false

Optional
result object Optional
result.result[] array

Found items

Optional
result.result[].__createdAt date-time

Date the item was created

Optional
result.result[].__createdBy uuid

Unique ID of the user who created the current item

Optional
result.result[].__deletedAt date-time

Date the item was deleted

Optional
result.result[].__id uuid

Unique ID

Optional
result.result[].__name string

Name

Optional
result.result[].__updatedAt date-time

Date the data was last changed

Optional
result.result[].__updatedBy uuid

Unique ID of the user who edited the current item

Optional
result.result[].description string

Description

Optional
result.result[].isDefault boolean

Default group

Optional
result.result[].isRole boolean

Role flag

Optional
result.total int64

Total number of items

Optional
success boolean

Successful request flag

Optional