Home Page > Integration > REST API > ObjectTypes

ObjectTypes

ObjectTypes - /REST/1/ObjectTypes/:id

This endpoint is used for manipulating the ObjectType resource. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The ObjectType object takes the following JSON object:

[
    {
        "alive": "<bool>",
        "allow_keywords": "<bool>",
        "built_in": "<bool>",
        "code": "<string>",
        "descriptor": "<string>",
        "id": "<int>",
        "name": "<string>",
        "plural_code": "<string>",
        "plural_name": "<string>",
        "protected": "<bool>",
        "updated": "<date>"
    }
]

 

GET

As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.

 

PUT

The following JSON parameters are available when updating a resource:

 

JSON Parameter Allowed values
name

string

plural_name string
descriptor string
allow_keywords

bool

 

The descriptor represents how an object will be described for the UI. It contains any fields from the object in contained in [] with the rest_code from the field given. Any text outside [] will be treated as plain. For example, a descriptor that combines first_name and last_name with a space would be: "[first_name] [last_name]"

DELETE

The resource can be deleted using this verb and including the id in the endpoint URL.

 

 

 

 

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.