Skip to content

default_object_cluster_resource

Manage default cluster resources values for objects

Create

Path
POST /v7.0/default_object_cluster_resources
Description
Create a default cluster resource value for object
Authentication required
yes
Scope
default_object_cluster_resource#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
default_object_cluster_resource
ParameterTypeRequiredDetails
environment
Environment
 Resource yes
cluster_resource
ClusterResource
 Resource yes
class_name
Class_name
 String yes

Search by concerned class name

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
value
Value
 Integer yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
default_object_cluster_resource
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
class_name
Class_name
 String Search by concerned class name
value
Value
 Integer

Delete

Path
DELETE /v7.0/default_object_cluster_resources/{default_object_cluster_resource_id}
Description
Delete default cluster resource value for object
Authentication required
yes
Scope
default_object_cluster_resource#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/default_object_cluster_resources
Description
List default cluster resource values for objects
Authentication required
yes
Scope
default_object_cluster_resource#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
default_object_cluster_resource
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
environment
Environment
 Resource no
cluster_resource
ClusterResource
 Resource no
class_name
Class_name
 String no

Search by concerned class name

Default: null

Output parameters

Layout
object_list
Namespace
default_object_cluster_resources
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
class_name
Class_name
 String Search by concerned class name
value
Value
 Integer

Show

Path
GET /v7.0/default_object_cluster_resources/{default_object_cluster_resource_id}
Description
Show default cluster resource values for object
Authentication required
yes
Scope
default_object_cluster_resource#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
default_object_cluster_resource
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
class_name
Class_name
 String Search by concerned class name
value
Value
 Integer

Update

Path
PUT /v7.0/default_object_cluster_resources/{default_object_cluster_resource_id}
Description
Update default cluster resource value for object
Authentication required
yes
Scope
default_object_cluster_resource#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
default_object_cluster_resource
ParameterTypeRequiredDetails
value
Value
 Integer yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
default_object_cluster_resource
ParameterTypeDescription
id
ID
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
class_name
Class_name
 String Search by concerned class name
value
Value
 Integer