#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": "94b3e914-b116-4db1-923d-e6cfef262a16",
"Alias": "Red and blue products released in DK",
"FolderUid": "77b6c1bb-868c-485e-b2fd-3fb1c932d699",
"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": "896d648f-3095-44c3-ba3b-0153d24168ff",
"Alias": "Red products",
"FolderUid": "009fd51b-54b8-4038-bb64-ec81bcf6f343",
"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": "1f9bac31-868c-410b-bda8-20c4ded84a3d",
"Alias": "Red and blue products released in DK",
"FolderUid": "8115ebad-95f8-4ec0-a36e-d2933ae9b253",
"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": "321eac04-07e2-4279-9cc5-3c4d7e2235b6",
"Alias": "Red and blue products released in DK",
"FolderUid": "f239acea-931c-4814-842e-9c5cab1246d6",
"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": "46ba7497-79d4-453f-aa7a-646f412ad950",
"Alias": "Red and blue products released in DK",
"FolderUid": "98fdb03a-22b9-4a25-b469-8da787f75e30",
"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": "45680160-067b-4818-bf67-0bd975c1dfc5",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "fdc803a5-6d28-4dfe-be4e-c2bfbdce6cf8"
},
{
"EntityId": 101,
"AttributeUid": "fdc803a5-6d28-4dfe-be4e-c2bfbdce6cf8"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "15767c5c-6b5c-4920-8113-de13f2c0c72f"
},
{
"EntityId": 100011,
"AttributeUid": "15767c5c-6b5c-4920-8113-de13f2c0c72f"
},
{
"EntityId": 102354,
"AttributeUid": "d7766740-d12d-437b-b07c-2d2d5e84349e"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "15767c5c-6b5c-4920-8113-de13f2c0c72f"
}
],
"ReferencingGlobalListValues": [
"3bb96998-c971-4468-be7c-e9c7216e382c",
"fd8cde1a-efa8-4ed5-b9b9-be3b6b7dd14e"
]
}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": "f404f087-02df-4c16-8e03-9d709eedc8c9",
"Alias": "Red and blue products released in DK",
"FolderUid": "b74dcf0c-f78a-4ced-8942-2485c45e1bc0",
"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": "980467e1-133b-416a-9f44-1b76625b5a57",
"Alias": "Red products",
"FolderUid": "25b5ced9-0e2b-450b-a3c3-cc9590c66a3d",
"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": "4fa0692c-90d0-4206-81f8-d9ffbc6bfdf6",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "09bc5fe0-2f3d-47c2-882f-8e654aaa4c74"
},
{
"EntityId": 101,
"AttributeUid": "09bc5fe0-2f3d-47c2-882f-8e654aaa4c74"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "6e2cb087-a96f-4d05-8d2f-f2361474e5e7"
},
{
"EntityId": 100011,
"AttributeUid": "6e2cb087-a96f-4d05-8d2f-f2361474e5e7"
},
{
"EntityId": 102354,
"AttributeUid": "90122534-a23a-4aa2-8c77-53be741d95e2"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "6e2cb087-a96f-4d05-8d2f-f2361474e5e7"
}
],
"ReferencingGlobalListValues": [
"02804ac7-60ae-4b0e-9ad9-faed3c25cece",
"cfa9cc5f-a932-4389-b851-7bbbdb8ee3d8"
]
},
{
"CollectionUid": "aa628732-7121-4815-b3df-289130c403b2",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "09bc5fe0-2f3d-47c2-882f-8e654aaa4c74"
}
],
"ReferencingProducts": [
{
"EntityId": 23553,
"AttributeUid": "6e2cb087-a96f-4d05-8d2f-f2361474e5e7"
},
{
"EntityId": 5656,
"AttributeUid": "6e2cb087-a96f-4d05-8d2f-f2361474e5e7"
}
],
"ReferencingVariants": [
{
"EntityId": 568323,
"AttributeUid": "90122534-a23a-4aa2-8c77-53be741d95e2"
}
],
"ReferencingGlobalListValues": [
"a4237b57-7b13-46de-a226-d5a8d474fc02",
"c533d65b-38eb-4aff-8dfc-5da39e494c99"
]
}
]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": "427f76e3-3541-4148-9d7b-350f312de80c",
"Uid": "d47d5c6f-e6bb-4e49-9907-45e805b91565",
"Name": "Collection folder 1"
},
{
"ParentUid": "51f8213e-cbb0-4adf-903e-6ac6f091a109",
"Uid": "67099bcd-8382-4058-8258-f66100faa6fb",
"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": "b65d62fd-0bb7-43ef-a464-b5b0a71c1f7d",
"Uid": "a151d580-ec8f-4d25-9326-c6267da7ae50",
"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": "2af3f44a-657b-44c8-ae04-e932e5cbdec5",
"Uid": "c865c78c-4e29-4420-a8f5-90a6c7661049",
"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": "b7aa55c5-d604-4f37-bb98-0228175c0b43",
"Uid": "b2c8541f-0f9d-4b30-88d2-f47163d432da",
"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": "760cd570-e265-4a77-a209-21ae966d8a0b",
"Alias": "Red and blue products released in DK",
"FolderUid": "57fa6932-ec56-4226-8486-56b16932fd9a",
"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": "01f8cf55-ddff-4930-bd54-d5eae8b676c0",
"Alias": "Red products",
"FolderUid": "4b203af1-69f7-445f-8f64-1d1d83d3dede",
"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": "463b9619-c8d5-43b6-9c9b-5d6331da389a",
"Uid": "ed076fca-0bb5-4082-be5c-f3b148a262d0",
"Name": "Collection folder 1"
},
{
"ParentUid": "3846a408-c51e-4a27-82d8-d4680ac60011",
"Uid": "1d56fc98-f12e-43c1-9178-17f6f9bf5757",
"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 |