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_results 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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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:
|