Public Web API: Model of the metadata description instance of a workspace (Get workspace metadata description by code)

Methods

GET — Get workspace metadata description by code

Resource

{
    "error": "string",
    "namespace": {
        "__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",
        "params": {
            "fields": [
                {
                    "array": "boolean",
                    "calcByFormula": "boolean",
                    "code": "string",
                    "defaultValue": {},
                    "deleted": "boolean",
                    "formula": "string",
                    "indexed": "boolean",
                    "required": "boolean",
                    "searchable": "boolean",
                    "single": "boolean",
                    "type": "string",
                    "view": {
                        "data": {},
                        "name": "string"
                    }
                }
            ],
            "values": {
                "<key>": {}
            }
        },
        "permissions": {
            "inheritParent": "boolean",
            "values": [
                {
                    "group": {
                        "id": "uuid",
                        "type": "string"
                    },
                    "inherited": "boolean",
                    "types": [
                        "string"
                    ]
                }
            ]
        },
        "sort": "int64"
    },
    "success": "boolean"
}

Properties

Name	Type	Description	Additional
error	string	Error message if `success == false`	Optional
namespace	object	Full metadata description of the workspace	Optional
namespace.__createdAt	date-time	Created on	Optional
namespace.__createdBy	uuid	Created by	Optional
namespace.__deletedAt	date-time	Date of removal	Optional
namespace.__updatedAt	date-time	Edited on	Optional
namespace.__updatedBy	uuid	Edited by	Optional
namespace.code	string	Code	Optional
namespace.hidden	boolean	Visibility flag	Optional
namespace.icon	string	Icon	Optional
namespace.language	string	Original language of the workspace	Optional
namespace.name	string	Name	Optional
namespace.namespace	string	Namespace.	Optional
namespace.params	object	Workspace parameters	Optional
namespace.params.fields[]	array		Optional
namespace.params.fields[].array	boolean	Array	Optional
namespace.params.fields[].calcByFormula	boolean	Set a formula for the field	Optional
namespace.params.fields[].code	string	Code	Optional
namespace.params.fields[].defaultValue	object	Default value	Optional
namespace.params.fields[].deleted	boolean	Deletion flag	Optional
namespace.params.fields[].formula	string	Formula	Optional
namespace.params.fields[].indexed	boolean	Search and Sort	Optional
namespace.params.fields[].required	boolean	Required	Optional
namespace.params.fields[].searchable	boolean	Full-text search	Optional
namespace.params.fields[].single	boolean	Attribute that shows if the field stores a single value (if the attriute is`true` then it is a single value, if the attibute is `false` then it is a multiple value)	Optional
namespace.params.fields[].type	string	Type	Optional
namespace.params.fields[].view	object	Short description of data to be displayed in the workspace field	Optional
namespace.params.fields[].view.data	object	Display parameters specific for a particular type of field	Optional
namespace.params.fields[].view.name	string		Optional
namespace.params.values	object		Optional
namespace.params.values.<key>	map of object		Optional
namespace.permissions	object	List of access permissions	Optional
namespace.permissions.inheritParent	boolean		Optional
namespace.permissions.values[]	array		Optional
namespace.permissions.values[].group	object	User, group, or org chart item	Optional
namespace.permissions.values[].group.id	uuid		Optional
namespace.permissions.values[].group.type	string	Possible values are: `user` `group` `orgstruct` `role`	Optional
namespace.permissions.values[].inherited	boolean		Optional
namespace.permissions.values[].types[]	array of string		Optional
namespace.sort	int64	Sorting	Optional
success	boolean	Successful request flag	Optional