Developer Guide

Back Next

Common Request and Response Attributes

The following table describes the common HTTP request and response attributes of the REST calls:

Attributes	Description
id	Unique identifier of the object.
name	The name of the object
valid	The current status of the object.
self	URI reference of the object.
actions	Array of all the actions, for example, deploy, update, or delete, that you can perform on the object and the related URIs.
acl	A list of permissions attached to an object or project. The acl associated to an object consists of the user ID, the read, write, execute, or deny permissions, and the grant or deny access rights to that particular object or project.
description	Description of the object
owningProject	The link to the project that contains the object.
type	The object type.
lastModifiedDate	The timestamp when the object was last modified.
createDate	The timestamp when the object was created.
createdBy	The user who created the object.
deployState	Specifies whether the object can be deployed.
	The current state of the object, for example, deployed, needs_deployment, or draft state.
force	Force saves an invalid rule or template. If you set the value to true, if the rule or template compilation fails, that rule or template is force saved as an invalid rule or template.
marshaller	An object such as a source or responder that holds the marshaller class name and properties.
marshallerClassname	The fully qualified classname of the marshaller.
marshallerProperties	A comma-separated list of key-value pairs that are passed to the marshaller.
connection	A link to the connection that is referred by the source or responder.