# 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": "d10cac9a-c80a-4d15-be27-71c5546baa33",
"Alias": "Red and blue products released in DK",
"FolderUid": "c1ee3069-b0c4-49a4-b3db-f9becb22ed60",
"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": "794fc6f7-2680-441a-935a-ae8c10d646ea",
"Alias": "Red products",
"FolderUid": "e01c6f59-73b5-4452-ac73-bf167831914e",
"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": "55c9fbf2-0871-420b-bf3d-42e446342818",
"Alias": "Red and blue products released in DK",
"FolderUid": "d2cceeb7-3487-48fb-a813-9eee04855a2e",
"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": "2cbf6872-5339-4976-815f-77b01503ad1e",
"Alias": "Red and blue products released in DK",
"FolderUid": "4c4cd729-b600-472e-bf39-37bcfffeb807",
"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": "b385d8af-e376-46e1-802d-9a4bfc529852",
"Alias": "Red and blue products released in DK",
"FolderUid": "26194ff7-af36-4fba-be87-a2c8543ef939",
"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": "32981a66-a3b3-48e1-b526-263ea9cd80ab",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "f7341932-fe60-48f1-89ef-27371b66cbfa"
},
{
"EntityId": 101,
"AttributeUid": "f7341932-fe60-48f1-89ef-27371b66cbfa"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "a5a6b1b8-b355-485b-8c38-cd6c178318ea"
},
{
"EntityId": 100011,
"AttributeUid": "a5a6b1b8-b355-485b-8c38-cd6c178318ea"
},
{
"EntityId": 102354,
"AttributeUid": "8eeffa5d-9ac0-4620-9395-b39efa401791"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "a5a6b1b8-b355-485b-8c38-cd6c178318ea"
}
],
"ReferencingGlobalListValues": [
"60c177c6-6b67-4b2d-b8ab-f900ceac6b8a",
"af484256-8604-4e80-9dbb-d808d81fc9c6"
]
}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": "abab7936-2435-4ee6-8a0a-eed1f8215928",
"Alias": "Red and blue products released in DK",
"FolderUid": "f5d679c0-60df-4ccb-b982-19eac3f15431",
"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": "e895d898-7bde-49a9-8f61-e22f3d33fdc2",
"Alias": "Red products",
"FolderUid": "436fe704-95ac-4c86-aac8-6214d02a07fe",
"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/entities Get entities in a batch of collections
#Available from v.3.14.0
{
"f07ebee3-a8b0-4d0e-9c91-df054d1e0a5b": {
"EntityType": 0,
"EntityIds": [
1001,
2011,
20234,
402324,
5405,
4044,
60547,
34504
]
},
"292fa39f-c4c4-44f9-8bc8-c34f46100ef3": {
"EntityType": 1,
"EntityIds": [
22333,
22566,
56998
]
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uids | body | array : string |
Unqiue ids of collections |
Response status OK (200)
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": "98b87d7e-de87-4ac5-8923-ad8510f3fdfc",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "73386a5a-e0f8-4e85-8b5c-1c071835c590"
},
{
"EntityId": 101,
"AttributeUid": "73386a5a-e0f8-4e85-8b5c-1c071835c590"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "be987f65-df5b-4046-b42d-d9ce8229b015"
},
{
"EntityId": 100011,
"AttributeUid": "be987f65-df5b-4046-b42d-d9ce8229b015"
},
{
"EntityId": 102354,
"AttributeUid": "212721e9-7684-4944-bbe7-e760931e1f98"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "be987f65-df5b-4046-b42d-d9ce8229b015"
}
],
"ReferencingGlobalListValues": [
"70f41d6f-8d5b-404a-8f5d-04a7eb681123",
"1eca538e-2aae-4b47-934a-25bcf14b4950"
]
},
{
"CollectionUid": "4d51a3eb-69f9-403c-ae66-5833ac663c78",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "73386a5a-e0f8-4e85-8b5c-1c071835c590"
}
],
"ReferencingProducts": [
{
"EntityId": 23553,
"AttributeUid": "be987f65-df5b-4046-b42d-d9ce8229b015"
},
{
"EntityId": 5656,
"AttributeUid": "be987f65-df5b-4046-b42d-d9ce8229b015"
}
],
"ReferencingVariants": [
{
"EntityId": 568323,
"AttributeUid": "212721e9-7684-4944-bbe7-e760931e1f98"
}
],
"ReferencingGlobalListValues": [
"8acee34d-27e8-48d6-ac5d-7422d661ca82",
"9519f395-5b9b-4fa0-a7c5-73898a0eb437"
]
}
]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": "bbe38228-e838-4e64-b551-2667cb961fa6",
"Uid": "23255eb6-41ab-467d-8232-e0ca6c35d333",
"Name": "Collection folder 1"
},
{
"ParentUid": "0746f3fe-a8a8-42c4-afd5-86c7e7abe9bc",
"Uid": "250fd397-63ee-45a1-b379-df2377f91ab0",
"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": "41fa28b9-ed48-47a8-a000-d5e5ff94b1b5",
"Uid": "f4df1884-5578-4094-87af-95cfceb13534",
"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": "fd46afde-5d59-483a-ac8d-1b8017234967",
"Uid": "92c8b207-af27-4551-8530-ab826e44a1b2",
"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": "4bdb8122-a81e-4494-80b2-230a6f9833b8",
"Uid": "dd819e95-2f2c-4034-aa94-66d8ca7c8d4c",
"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": "ee78c45c-cdb5-4eed-84b2-96fd894e6928",
"Alias": "Red and blue products released in DK",
"FolderUid": "4b77d700-ae3d-42df-afb4-6e28a2469e36",
"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": "7e812021-5c66-4f12-a932-d44f2c01ef67",
"Alias": "Red products",
"FolderUid": "5c45d9ab-4a0d-40f0-84a1-4b9ed3ca8c6b",
"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": "9f586149-28e4-4278-81f9-61f41ba8136c",
"Uid": "4cb259c8-6a91-4781-a9f9-869a7f77e222",
"Name": "Collection folder 1"
},
{
"ParentUid": "3a040dd1-8092-4950-b14c-ede3763586e7",
"Uid": "1ed62607-1539-44cb-b0ca-eb8885e57d78",
"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 |