#Collections
#Available from v.3.2.0 Collections are dynamic groupings of either products or variants. Collections contain a range of products or variants that match a certain query specified on the collection.
GET /collections Get all collections
#Available from v.3.2.0
[
{
"Uid": "f8f72e2d-ffa8-4753-a52a-d838b90a3a17",
"Alias": "Red and blue products released in DK",
"FolderUid": "e2538a8e-65d1-4458-b230-9e99a1efb255",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
},
{
"Uid": "b6fab15e-49e5-4140-872b-574ec4a07a69",
"Alias": "Red products",
"FolderUid": "c76a7e53-50cc-48ee-a47a-797afa8d747d",
"QuerySetup": {
"EntityType": 0,
"Query": {
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
}
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of collection |
| Alias | string |
Unique human readable alias of collection |
| FolderUid | string |
Folder in which collection is places (null of collection is placed at root level) |
| QuerySetup | object : QueryContainer |
Query defining the products or variants that are part of this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityType | string |
The entity type to query for |
| Query | object : QueryModel |
Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
PUT /collections Update a collection
#Available from v.3.2.0
{
"Uid": "d6159a3f-a933-4f18-abee-f7f482afd8de",
"Alias": "Red and blue products released in DK",
"FolderUid": "c6857e94-2d4f-44e3-9766-356ab4d37b84",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| collection | body | object : Collection |
Collection to update |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of collection |
| Alias | string |
Unique human readable alias of collection |
| FolderUid | string |
Folder in which collection is places (null of collection is placed at root level) |
| QuerySetup | object : QueryContainer |
Query defining the products or variants that are part of this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityType | string |
The entity type to query for |
| Query | object : QueryModel |
Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
Response status OK (200)
POST /collections Create a new collection
#Available from v.3.2.0
{
"Uid": "3a5b4d4a-59a9-43a0-affe-8ff470026480",
"Alias": "Red and blue products released in DK",
"FolderUid": "19ab07b9-50aa-40ed-aaf1-a7a0be018635",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| collection | body | object : Collection |
Collection to create |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of collection |
| Alias | string |
Unique human readable alias of collection |
| FolderUid | string |
Folder in which collection is places (null of collection is placed at root level) |
| QuerySetup | object : QueryContainer |
Query defining the products or variants that are part of this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityType | string |
The entity type to query for |
| Query | object : QueryModel |
Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
Response status OK (200)
DELETE /collections Delete a collection
#Available from v.3.2.0
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | query | string |
Uid of collection to delete |
Response status OK (200)
GET /collections/{uid} Get a specific collection
#Available from v.3.2.0
{
"Uid": "e72f1b89-9da1-4454-96e0-4b648bead4ff",
"Alias": "Red and blue products released in DK",
"FolderUid": "bd4b1183-5d85-4612-bcbb-b9bf8d0c2571",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unqiue id of collection |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of collection |
| Alias | string |
Unique human readable alias of collection |
| FolderUid | string |
Folder in which collection is places (null of collection is placed at root level) |
| QuerySetup | object : QueryContainer |
Query defining the products or variants that are part of this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityType | string |
The entity type to query for |
| Query | object : QueryModel |
Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
GET /collections/{uid}/entities Get entities in a specific collection
#Available from v.3.2.0
{
"EntityType": 0,
"EntityIds": [
1001,
2011,
20234,
402324,
5405,
4044,
60547,
34504
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unqiue id of collection |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| EntityType | string | |
| EntityIds | array |
GET /collections/{uid}/references Get references to a collection
#Available from v.3.5.0
{
"CollectionUid": "17670700-a258-4a30-86ce-b722c715d1a8",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "6deee668-71f9-4b41-a064-f6074bf39098"
},
{
"EntityId": 101,
"AttributeUid": "6deee668-71f9-4b41-a064-f6074bf39098"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "7e0983e2-a990-4728-9c97-13e755c13a66"
},
{
"EntityId": 100011,
"AttributeUid": "7e0983e2-a990-4728-9c97-13e755c13a66"
},
{
"EntityId": 102354,
"AttributeUid": "52523b1c-015f-4447-8fb8-5ea8582e96f5"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "7e0983e2-a990-4728-9c97-13e755c13a66"
}
],
"ReferencingGlobalListValues": [
"ab9842d1-acba-488a-9f47-9738049703c8",
"11db8211-17b7-4818-b999-56080b02d8e6"
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Uid of collection |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| CollectionUid | string |
Uid of the referenced collection |
| ReferencingCategories | array : EntityReferenceDetail |
List of categories referencing this collection |
| ReferencingProducts | array : EntityReferenceDetail |
List of products referencing this collection |
| ReferencingVariants | array : EntityReferenceDetail |
List of variants referencing this collection |
| ReferencingGlobalListValues | array |
List of global list values referencing this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityId | integer |
The id of the referencing entity |
| AttributeUid | string |
The attribute on the referencing entity that holds the reference |
POST /collections/batch Get a batch of collections
#Available from v.3.2.0
[
{
"Uid": "6f301d48-c109-45cd-87b3-68b6f849914a",
"Alias": "Red and blue products released in DK",
"FolderUid": "44102705-652d-4585-b0ed-2e2e3b03d792",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
},
{
"Uid": "aa630844-a37e-4f84-ab1c-2154c021db99",
"Alias": "Red products",
"FolderUid": "c5ef6dae-34ec-4847-b9c4-f56a277a5ef5",
"QuerySetup": {
"EntityType": 0,
"Query": {
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
}
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uids | body | array : string |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of collection |
| Alias | string |
Unique human readable alias of collection |
| FolderUid | string |
Folder in which collection is places (null of collection is placed at root level) |
| QuerySetup | object : QueryContainer |
Query defining the products or variants that are part of this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityType | string |
The entity type to query for |
| Query | object : QueryModel |
Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
POST /collections/batch/references Get references to a batch of collections
#Available from v.3.5.0 No more than 5000 values can be requested at a time.
[
{
"CollectionUid": "d1044183-c1b5-41c9-acf1-a055b1ea5463",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "0033e564-1faa-4ab8-9473-ea2f2858d833"
},
{
"EntityId": 101,
"AttributeUid": "0033e564-1faa-4ab8-9473-ea2f2858d833"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "89ea9344-00ad-4f60-b80e-705e5b87e0fe"
},
{
"EntityId": 100011,
"AttributeUid": "89ea9344-00ad-4f60-b80e-705e5b87e0fe"
},
{
"EntityId": 102354,
"AttributeUid": "b42a2ae4-822f-416e-9055-1a6d4a2f9b49"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "89ea9344-00ad-4f60-b80e-705e5b87e0fe"
}
],
"ReferencingGlobalListValues": [
"15959e70-aac3-4cf6-a3a2-e4c8800f1fb7",
"67771113-041e-41ff-893e-4e1094fdde2d"
]
},
{
"CollectionUid": "cafa2a16-2228-4fbe-bf31-aed9072ee49c",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "0033e564-1faa-4ab8-9473-ea2f2858d833"
}
],
"ReferencingProducts": [
{
"EntityId": 23553,
"AttributeUid": "89ea9344-00ad-4f60-b80e-705e5b87e0fe"
},
{
"EntityId": 5656,
"AttributeUid": "89ea9344-00ad-4f60-b80e-705e5b87e0fe"
}
],
"ReferencingVariants": [
{
"EntityId": 568323,
"AttributeUid": "b42a2ae4-822f-416e-9055-1a6d4a2f9b49"
}
],
"ReferencingGlobalListValues": [
"f17b5da9-4a68-4163-9b35-c3b47842ecc0",
"22b46e07-b7ee-49bf-941e-88e16e3417ae"
]
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uids | body | array : string |
Uids of collections |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| CollectionUid | string |
Uid of the referenced collection |
| ReferencingCategories | array : EntityReferenceDetail |
List of categories referencing this collection |
| ReferencingProducts | array : EntityReferenceDetail |
List of products referencing this collection |
| ReferencingVariants | array : EntityReferenceDetail |
List of variants referencing this collection |
| ReferencingGlobalListValues | array |
List of global list values referencing this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityId | integer |
The id of the referencing entity |
| AttributeUid | string |
The attribute on the referencing entity that holds the reference |
GET /collections/folders Get all collection folders
#Available from v.3.2.0
[
{
"ParentUid": "37c2b965-5bf5-4a1f-aac0-cf3d9ebffc80",
"Uid": "daa1ed44-4b36-4975-80f6-2f2d5544f6c8",
"Name": "Collection folder 1"
},
{
"ParentUid": "91b24937-6d1f-4730-8cb6-7e0c4ea6aa1a",
"Uid": "715b743a-7f9c-4429-b050-eb2ff1d1bafe",
"Name": "Collection folder 2"
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
PUT /collections/folders Update a collection folder
#Available from v.3.2.0
{
"ParentUid": "689c1af8-ab0f-4134-8dd8-784d4b070256",
"Uid": "9e859771-169b-43e4-8793-294fb0f343e6",
"Name": "Collection folder 1"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| folder | body | object : CollectionFolder |
Collection folder to update |
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
Response status OK (200)
POST /collections/folders Create a new collection folder
#Available from v.3.2.0
{
"ParentUid": "a2b9d980-007e-4de0-8584-4243a56e9253",
"Uid": "cd0bf24d-4246-42ab-bf6a-1ec72691b211",
"Name": "Collection folder 1"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| folder | body | object : CollectionFolder |
Collection folder to create |
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
Response status OK (200)
DELETE /collections/folders Delete a collection folder
#Available from v.3.2.0
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | query | string |
Uid of collection folder to delete |
Response status OK (200)
GET /collections/folders/{uid} Get a specific collection folder
#Available from v.3.2.0
{
"ParentUid": "726a8092-c71b-4c28-b1f5-f0b9a461af3f",
"Uid": "7b0bf786-e38f-43ae-82a3-1e86690930f5",
"Name": "Collection folder 1"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unique id of folder |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
GET /collections/folders/{uid}/collections Get collections in folder
#Available from v.3.2.0 Use empty Guid (00000000-0000-0000-0000-000000000000) to get collections at root
[
{
"Uid": "7024d38d-4e47-404f-a8c9-c496b3fec6ab",
"Alias": "Red and blue products released in DK",
"FolderUid": "16301a3c-436e-4a4b-8d19-3649ef75b324",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
},
{
"Uid": "13edf97c-8ca3-4304-9388-79e9c60ac355",
"Alias": "Red products",
"FolderUid": "66c8e479-9662-4beb-be8f-f6cbdd9a0774",
"QuerySetup": {
"EntityType": 0,
"Query": {
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
}
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of collection |
| Alias | string |
Unique human readable alias of collection |
| FolderUid | string |
Folder in which collection is places (null of collection is placed at root level) |
| QuerySetup | object : QueryContainer |
Query defining the products or variants that are part of this collection |
| Property name | Data type | Description |
|---|---|---|
| EntityType | string |
The entity type to query for |
| Query | object : QueryModel |
Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| FilterValue | object |
Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for |
GET /collections/folders/{uid}/subfolders Get subfolders for collection folder
#Available from v.3.2.0 Use empty Guid (00000000-0000-0000-0000-000000000000) to get root folders
[
{
"ParentUid": "415b8996-8c24-479f-8191-e8ef9f59131e",
"Uid": "7dad8678-ef87-4973-9050-cab4a4bd06e1",
"Name": "Collection folder 1"
},
{
"ParentUid": "6267c6b5-fff1-44f2-b710-6fd43eef5d14",
"Uid": "1082daaf-cf70-4eec-9319-ed1540472b34",
"Name": "Collection folder 2"
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unqieu id of folder |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |