Authentication

Supported Formats

Response

URL Parameters

Required

Optional

The TinyQ language filter that specifies a subset of all available records.

field

string

not present

The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values,

page

integer

1

The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize.

pagesize

integer

[unlimited]

The maximum number of object records to return as a result of the request.

Success Codes

200 OK

204 No Content

Fault Codes

400 Bad Request

403 Forbidden

500 Internal Server Error

503 Service Unavailable

Response Data

Object type: page

A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing.

A list of type information for each attribute that can appear in the object type described by this Object Schema instance. Definition

internal-name

The name used internally by Sentinel to refer to the object type. It is useful to know this name because generated bean classes available in the client API are named based on this name.

meta

The metadata for an object, including the object type name and the URL reference to the object. Definition

perms

Information about access control for the object type described by this Object Schema instance. This value is empty for non-standalone types. The map keys are "view", "update", "create", and "delete". Definition

standalone

If this value is true it indicates that the object type is a "first class" type that can be directly manipulated via the REST API. If this value is false it indicates that the object type only appears in values of other object types.

uri

The URI used with the REST API to access objects belonging to the type described by this ObjectSchema instance. This attribute will have no value for non-standalone types because such types only appear in values of other object types.

Object type: meta

The metadata for an object, including the object type name and the URL reference to the object.

If true, indicates that access is permitted for any authenticated user. If false, indicates that a specific permission is required.

perms

A list of permission names, any one of which is needed to perform the operation. Note that "_adminRole_" is a special permission name that indicates that a user must be a member of the Sentinel role "Administrators".

Object type: attr-schema

An "attr-schema" object contains information describing an attribute of an object type available via the Sentinel DataObject REST API.

Describes whether the attribute may be read, changed, or both. The value "write-only" is used for user passwords.

api-name

The name used in the serialized representation of the attribute value.

bean-key-type

Contains the name of the referenced object type if "key-type" is "bean".

bean-value-type

Contains the name of the referenced object type if "type" is "bean", or if "sub-type" is "bean", or if "link-type" is "bean", or if "link-type" is "beans".

enums

If set and non-empty then "enums" is the set of allowed values for the attribute.

internal-name

The name used internally by Sentinel to refer to the attribute. It is useful to know this name because generated bean classes contain access methods whose names are created based on this name.

key-type

Describes the key type for "map" attribute types.

link-type

Describes type of object referenced by the URL value for "link" attribute types.

required

If true, the attribute must have a value when an object is created, and the attribute value may not be set to empty in a modify operation.

sub-type

Describes the element type for "set" and "list" attribute types, and the value type for "map" attribute types.

type

Describes the attribute value type. If "type" is "bean" then "bean-value-type" is the "api name" of the object type. If "type"
is "list" or "set" then "sub-type" is the type of the collection element. If "type" is "map" then "key-type" is the type of the map keys, and "sub-type" is the type of the map values.
If "type" is "link" then "link-type" is the type of item pointed to by the URL value of the attribute.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/schema?page=2&pagesize=1

If true, indicates that access is permitted for any authenticated user. If false, indicates that a specific permission is required.

perms

A list of permission names, any one of which is needed to perform the operation. Note that "_adminRole_" is a special permission name that indicates that a user must be a member of the Sentinel role "Administrators".

Object type: attr-schema

An "attr-schema" object contains information describing an attribute of an object type available via the Sentinel DataObject REST API.

Describes whether the attribute may be read, changed, or both. The value "write-only" is used for user passwords.

api-name

The name used in the serialized representation of the attribute value.

bean-key-type

Contains the name of the referenced object type if "key-type" is "bean".

bean-value-type

Contains the name of the referenced object type if "type" is "bean", or if "sub-type" is "bean", or if "link-type" is "bean", or if "link-type" is "beans".

enums

If set and non-empty then "enums" is the set of allowed values for the attribute.

internal-name

The name used internally by Sentinel to refer to the attribute. It is useful to know this name because generated bean classes contain access methods whose names are created based on this name.

key-type

Describes the key type for "map" attribute types.

link-type

Describes type of object referenced by the URL value for "link" attribute types.

required

If true, the attribute must have a value when an object is created, and the attribute value may not be set to empty in a modify operation.

sub-type

Describes the element type for "set" and "list" attribute types, and the value type for "map" attribute types.

type

Describes the attribute value type. If "type" is "bean" then "bean-value-type" is the "api name" of the object type. If "type"
is "list" or "set" then "sub-type" is the type of the collection element. If "type" is "map" then "key-type" is the type of the map keys, and "sub-type" is the type of the map values.
If "type" is "link" then "link-type" is the type of item pointed to by the URL value of the attribute.