REST properties

Properties are named variables that can be assigned property values (polymorphic) for themselves (default values), Installed Components, Application Components, Requests, Servers, Server Aspects, and Server Levels.

GET /v1/properties

Returns all properties.

Filters

• name — String for property name
• app_name — String for the application name
• component_name — String for the component name
• server_name — String for the server name
• server_level_name — String for the server level name
• work_task — String for the work task name
• current_value — String for the value among current property values (that is, deleted_at = null)
• deleted_value — String for the value among deleted property values (that is, deleted_at != null)
• active — Boolean value for active properties only (default is true, showing active only by default)
• inactive — Boolean value for inactive properties (when used with active = false, can be used to show just inactive properties)

Common attributes

• format — Ensure to include an accept header or add .xml or .json to the last path element
• token — Your API Token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not Found — Occurs when no records are found

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

An example of filters:

GET /v1/properties/[id]

Returns a property by ID.

Common attributes

• id — Numerical unique ID for record
• format — Ensure to include an accept header or add .xml or .json to the last path element
• token — Your API Token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when record to show is not found

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

POST /v1/properties

Creates a new property from posted data.

Required attributes

• name — String name (required)

Optional attributes

• default_value — String default value for a property
• is_private — Boolean value for whether the display of property values should be obscured with **** (defaults to nil or false)
• app_ids — Array of integer IDs for applications
• component_ids — Array of integer IDs for components (required for installed components to show values)
• server_ids — Array of integer IDs for servers
• server_level_ids — Array of integer IDs for server levels
• work_task_ids — Array of integer IDs for work tasks

Special finders

• property_values_with_holders — Array of hashes for setting property values with the following required keys:
  • value — String value of the property (required)
  • value_holder_type — String class name of allowed holders (required, can be Property, Server, ServerAspect, ServerLevel, ApplicationComponent, InstalledComponent)
  • value_holder_id — Integer ID of the value holder (required)

Common Attributes

• format — Ensure to include an accept header or add .xml or .json to the last path element
• token — Your API Token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 422 Unprocessable entity — Occurs when validation fails, objects and errors are returned

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

An example of creating a property value, associating it with a component, and setting values of a known matching set of installed components:

PUT /v1/properties/[id]

Updates an existing property with values from a posted document

Editable attributes

• name — String name (required)
• default_value — String default value for a property
• is_private — Boolean value for whether the display of property values should be obscured with **** (defaults to nil or false)
• app_ids — Array of integer IDs for applications
• component_ids — Array of integer IDs for components (required for installed components to show values)
• server_ids — Array of integer IDs for servers
• server_level_ids — Array of integer IDs for server levels
• work_task_ids — Array of integer IDs for work tasks

Special Finders

• property_values_with_holders— Array of hashes for setting property values with the following required keys:
  • value — String value of the property (required)
  • value_holder_type — String class name of allowed holders (required, can be Property, Server, ServerAspect, ServerLevel, ApplicationComponent, InstalledComponent)
  • value_holder_id — Integer ID of the value holder (required)

Common Attributes

• format — Ensure to include an accept header or add .xml or .json to the last path element
• token — Your API Token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when record to update is not found
• ERROR 422 Unprocessable entity — Occurs when validation fails and objects and errors are returned

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

An example of setting a property value with holder:

DELETE /v1/properties/[id]

Makes a property inactive. Sets the active parameter for the property to false.

Common attributes

• id — Numerical unique ID for record
• format — Ensure to include an accept header or add .xml or .json to the last path element
• token — Your API Token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when no records are found

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

Sample output

The following JSON is a sample output from GET /v1/properties/26:

The following XML is a sample output from GET /v1/properties/1:

Related topic

REST-API-commands