Param name | Description |
---|---|
organization_id required |
Filter products by organization Validations:
|
subscription_id optional |
Filter products by subscription Validations:
|
name optional |
Filter products by name Validations:
|
enabled optional |
Filter products by enabled or disabled Validations:
|
custom optional |
Filter products by custom Validations:
|
include_available_content optional |
Whether to include available content attribute in results Validations:
|
sync_plan_id optional |
Filter products by sync plan id Validations:
|
available_for optional |
Interpret specified object to return only Products that can be associated with specified object. Only 'sync_plan' is supported. Validations:
|
search optional |
Search string Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return Validations:
|
order optional |
Sort field and order, eg. 'name DESC' Validations:
|
full_result optional |
Whether or not to show all results Validations:
|
sort optional |
Hash version of 'order' param Validations:
|
sort[by] optional |
Field to sort the results on Validations:
|
sort[order] optional |
How to order the sorted results (e.g. ASC for ascending) Validations:
|
Param name | Description |
---|---|
organization_id required |
ID of the organization Validations:
|
description optional |
Product description Validations:
|
gpg_key_id optional |
Identifier of the GPG key Validations:
|
sync_plan_id optional , nil allowed |
Plan numeric identifier Validations:
|
name required |
Product name Validations:
|
label optional |
Validations:
|
Param name | Description |
---|---|
id required |
product numeric identifier Validations:
|
Param name | Description |
---|---|
id required |
product numeric identifier Validations:
|
description optional |
Product description Validations:
|
gpg_key_id optional |
Identifier of the GPG key Validations:
|
sync_plan_id optional , nil allowed |
Plan numeric identifier Validations:
|
name optional |
Product name Validations:
|
Param name | Description |
---|---|
id optional |
product numeric identifier Validations:
|
Param name | Description |
---|---|
id required |
product ID Validations:
|