object.describe

Description

This call returns a JSON schema description of each object specified.

Parameters

Object Types

An array of object type strings to describe

Locale

Any human oriented text returned will correspond to this locale.  This parameter is optional and defaults to "en_US."

Response

An object is returned where each field corresponds to an object type that was passed.  The value is a JSON schema description of that object.

Any unrecognized object type requested will be ignored in the response.

Examples

A Sample JSON-RPC Object Describe Request

{
    "method": "object.describe",
    "params": [["role"], "en_US"],
    "id": 1
}

The JSON-RPC Response

{
    "result": [
        {
            "object_type": "role",
            "schema": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer",
                        "readonly": true,
                        "hidden": true,
                        "unique": true,
                        "title": "Role ID"
                    },
                    "created": {
                        "type": "string",
                        "format": "date-time",
                        "maxLength": 20,
                        "readonly": true,
                        "title": "Created"
                    },
                    "updated": {
                        "type": "string",
                        "format": "date-time",
                        "maxLength": 20,
                        "readonly": true,
                        "title": "Updated"
                    },
                    "name": {
                        "type": "string",
                        "maxLength": 32,
                        "optional": false,
                        "unique": true,
                        "title": "Name",
                        "sortable": true
                    },
                    "description": {
                        "type": "string",
                        "title": "Description"
                    },
                    "is_assignable": {
                        "type": "boolean",
                        "readonly": true,
                        "hidden": true,
                        "title": "Assignable",
                        "queryable": false
                    },
                    "is_predefined": {
                        "type": "boolean",
                        "readonly": true,
                        "hidden": true,
                        "title": "Predefined",
                        "queryable": false
                    },
                    "object_type": {
                        "type": "string",
                        "maxLength": 32,
                        "readonly": true,
                        "default": "role",
                        "hidden": true,
                        "title": "Object Type",
                        "queryable": false
                    }
                }
            }
        }
    ],
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the object.describe call must be a member of one of the following roles

• Administrator
• Program Manager
• Community Manager
• Content Manager
• Portal Manager
• Api Manager

See authentication.

Errors

This method returns only standard json-rpc errors and authentication errors.