Methods

  • GET — Get list of workspace metadata descriptions

Resource

{
    "error": "string",
    "result": {
        "result": [
            {
                "__createdAt": "date-time",
                "__createdBy": "uuid",
                "__deletedAt": "date-time",
                "__updatedAt": "date-time",
                "__updatedBy": "uuid",
                "code": "string",
                "hidden": "boolean",
                "icon": "string",
                "language": "string",
                "name": "string",
                "namespace": "string",
                "sort": "int64"
            }
        ],
        "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

Created on

Optional
result.result[].__createdBy uuid

Created by

Optional
result.result[].__deletedAt date-time

Removed on

Optional
result.result[].__updatedAt date-time

Edited on

Optional
result.result[].__updatedBy uuid

Edited by

Optional
result.result[].code string

Code

Optional
result.result[].hidden boolean

Visibility flag

Optional
result.result[].icon string

Icon

Optional
result.result[].language string

Original language of the workspace

Optional
result.result[].name string

Name

Optional
result.result[].namespace string Namespace. Optional
result.result[].sort int64

Sorting

Optional
result.total int64

Total items

Optional
success boolean

Successful request flag

Optional