Find request

The Find API is in phase and is not yet available to users. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

Introduction

To facilite the search of entities with the Product-Live APIs, the Find APIs enable you to get a list of entities matching one or multiple criteria. You can apply the same filtering logic on multiple endpoints:

Find query body

Depending on the number of filters you want to apply, you need to write the query body as below. When you want to apply multiple criterias, you can define if you want all of the criteria to be matched (AND), or one or the other set of criterias (OR).

Single criteriaMultiple criterias (and)Multiple criterias (or)

json

{
    "type": "search",
    "caseSensitive": true,
    "field": "name",
    "value": "RETAIL"
}

json

{
  "type": "and",
  "queries": [
    {
        "type": "search",
        "caseSensitive": true,
        "field": "name",
        "value": "RETAIL"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2021-12-30T10:17:29.000Z"
    }
  ]
}

json

{
  "type": "or",
  "queries": [
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "name",
        "value": "RETAILX"
    },
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "name",
        "value": "BRANDX"
    }
  ]
}

Property	Type	Description
type	enumeration	Mandatory if multiples criteria are defined Either `and` or `or`
queries.type	enumeration	Mandatory The search operator See the list of operators here
queries.caseSensitive	boolean	Is the search is casesenstive or not By default : `false`
queries.field	string	Mandatory The field key of the entity to search for See more detail for each entity here
queries.value	object/string/number	Mandatory Depending on the operator See more details here

Operators

Operator	Expected field value	Description
eq	string/number/boolean	Check if the entity field value is exactly the `value`
search	string	Check if the entity field value contains the `value` Use `%` to prefix and/or suffix the searched value
in	object	Check if the entity field value is exactly one of the `value` If the list of value is empty, an error is returned
true	none	Returns all results no matter what
false	non	Returns no results no mater what
greater	string/number	Check if the entity field value is exactly greater than the `value`
greaterOrEqual	string/number	Check if the entity field value is greater or equal to the `value`
lower	string/number	Check if the entity field value is exactly lower than the `value`
lowerOrEqual	string/number	Check if the entity field value is exactly lower or equal to the `value`

json

{
  "type": "eq",
  "field": "EAN",
  "value": "0193015344471"
}

json

{
  "type": "eq",
  "field": "PRICE",
  "value": "89,99"
}

json

/**
 * search for all entities containing the word "WHOOL" in the COMPOSITION field.
 * By default the search is case sensitive
 */
{
  "type": "search",
  "field": "COMPOSITION",
  "value": "WHOOL"
}

// search for all entities starting with "WHOOL" in the COMPOSITION field. the search is not case sensitive.
{
  "type": "search",
  "caseSensitive": false
  "field": "COMPOSITION",
  "value": "WHOOL%"
}

// search for all entities ending with "WHOOL" in the COMPOSITION field. the search is sensitive.
{
  "type": "search",
  "caseSensitive": true
  "field": "COMPOSITION",
  "value": "%WHOOL"
}

json

{
  "type": "in",
  "field": "COLOR",
  "value": ["YELLOW","GOLD"]
}

json

{
  "type": "greater",
  "field": "HEIGHT",
  "value": 100
}

TIP

When searching for an entity on an exact createdAt or updatedAt date, you must use the "caseSensitive": true parameter.

Accounts

More details on the Content Management Accounts API here.

json

{
    "object": "account",
    "id": "2490",
    "createdAt": "2021-12-30T10:17:29.000Z",
    "updatedAt": "2021-12-30T10:17:29.000Z",
    "key": "2e729b23-f04b-447d-ba7b-4ecb72d804f9",
    "name": "RETAILX"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2021-12-30T10:17:29.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "2490"}` `{"type": "search","field": "id","value": "2490"}` `{"type": "in","field": "id","value": ["2490"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "2e729b23-f04b-447d-ba7b-4ecb72d804f9"}` `{"type": "in","field": "key","value": ["2e729b23-f04b-447d-ba7b-4ecb72d804f9"]}`
name	eq/search/in	`{"type": "eq","field": "name","value": "RETAILX"}` `{"type": "in","field": "name","value": ["RETAILX"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2021-12-30T10:17:29.000Z"}`

Audit Logs

More details on the Content Management Audit Logs API here.

json

{
  "object": "audit_log",
  "timeGenerated": "2025-02-21T14:58:15.584Z",
  "entityType": "item",
  "version": "2",
  "details": {
    "accountId": "4201",
    "userId": "3",
    "itemId": "6588231",
    "status": "SUCCESS",
    "actionOrigin": "DF_TABLE_IMPORT_ITEMS",
    "updatedFieldList": {
      "LIBCOLMODFR": "ROSE VIF",
      "COLLECTION_THEME": "2036",
      "COLOR_CODE": "1079"
    },
    "triggeredBy": "USER",
    "issuedAt": "2025-02-21T14:41:21.7820000Z",
    "tableId": "1467",
    "contextId": "4201",
    "jobId": "674f4c6b796b6a7e699ad916",
    "cid": "FSVVJs7sxm6zHif1RbDRKuxJhWzaPaL8TM4EwfcFJkU2tDwiiylYuLMiB8kQMTqx:4201:mXpV3BMC-1740148688131278068815233845416783033101:1"
  },
  "type": "item.update"
}

Searchable field	Supported operator	Example
details.`...`	eq	`{"type": "eq","field": "details.accountId","value": "4201"}`
entityType	eq/search/in	`{"type": "eq","field": "entityType","value": "item"}` `{"type": "search","field": "entityType","value": "%account%"}` `{"type": "in","field": "entityType","value": ["suggestion"]}`
timeGenerated	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "timeGenerated","value": "2021-12-30T10:17:29.000Z"}`
type	eq/search/in	`{"type": "eq","field": "type","value": "item.update"}` `{"type": "search","field": "entityType","value": "%account.create%"}` `{"type": "in","field": "type","value": ["suggestion"]}`

Comment Threads

More details on the Content Management Comment Threads API here.

json

{
    "comments": [
        {
            "creationDate": "2023-11-27T13:12:29.947Z",
            "type": "TEXT",
            "id": "656495bdea57cd0db4b0682d",
            "accountName": "RETAILX",
            "userId": "5443",
            "message": "Good morning,\nWould it be possible to clarify the product description?\nTHANKS"
        }
    ],
    "type": "DEFAULT",
    "object": "comment_thread",
    "id": "170",
    "createdAt": "2023-11-27T13:12:29.000Z",
    "updatedAt": "2023-11-27T13:12:29.000Z",
    "accountAssigneesId": [
        "2490"
    ],
    "subscribersId": [
        "39"
    ],
    "isClosed": false,
    "accountId": "2482",
    "userId": "5443",
    "targetId": "13675",
    "targetType": "suggestion"
}

Searchable field	Supported operator	Example
accountId	eq/search/in	`{"type": "eq","field": "accountId","value": "2482"}` `{"type": "search","field": "accountId","value": "2482"}` `{"type": "in","field": "accountId","value": ["2482"]}`
assigneeId	eq/search/in	`{"type": "eq","field": "assigneeId","value": "2490"}` `{"type": "search","field": "assigneeId","value": "2490"}` `{"type": "in","field": "assigneeId","value": ["2490"]}`
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2021-12-30T10:17:29.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "170"}` `{"type": "search","field": "id","value": "170"}` `{"type": "in","field": "id","value": ["170"]}`
isclosed	eq/in	`{"type": "eq","field": "isclosed","value": "false"}` `{"type": "in","field": "isclosed","value": ["false"]}`
subscribersId	eq/search/in	`{"type": "eq","field": "subscribersId","value": "39"}` `{"type": "search","field": "subscribersId","value": "39"}` `{"type": "in","field": "subscribersId","value": ["39"]}`
targetId (suggestionId)	eq/search/in	`{"type": "eq","field": "id","value": "13675"}` `{"type": "search","field": "id","value": "13675"}` `{"type": "in","field": "id","value": ["13675"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2021-12-30T10:17:29.000Z"}`
userId	eq/search/in	`{"type": "eq","field": "userId","value": "5443"}` `{"type": "search","field": "userId","value": "5443"}` `{"type": "in","field": "userId","value": ["5443"]}`

Comment Thread Subscribers

More details on the Content Management Comment Thread Subscribers API here.

json

{
    "object": "comment_thread_subscriber",
    "id": "39",
    "updatedAt": "2023-11-27T13:12:29.000Z",
    "createdAt": "2023-11-27T13:12:29.000Z",
    "accountId": "2482",
    "userId": "5443",
    "commentThreadId": "170"
}

Searchable field	Supported operator	Example
accountId	eq/search/in	`{"type": "eq","field": "accountId","value": "2482"}` `{"type": "search","field": "accountId","value": "2482"}` `{"type": "in","field": "accountId","value": ["2482"]}`
commentThreadId	eq/search/in	`{"type": "eq","field": "commentThreadId","value": "170"}` `{"type": "search","field": "commentThreadId","value": "170"}` `{"type": "in","field": "commentThreadId","value": ["170"]}`
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2021-12-30T10:17:29.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "39"}` `{"type": "search","field": "id","value": "39"}` `{"type": "in","field": "id","value": ["39"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2021-12-30T10:17:29.000Z"}`
userId	eq/search/in	`{"type": "eq","field": "userId","value": "5443"}` `{"type": "search","field": "userId","value": "5443"}` `{"type": "in","field": "userId","value": ["5443"]}`

Fields

More details on the Content Management Items API here.

Default fieldComposite child field

json

{
    "object": "field",
    "id": "2330458",
    "updatedAt": "2025-01-06T14:39:15.000Z",
    "createdAt": "2025-01-06T14:39:15.000Z",
    "metadata": {},
    "tableId": "1470",
    "levelId": "1685",
    "key": "EAN",
    "type": "IDENTIFIER",
    "title": "EAN 13",
    "multiValued": false
}

json

{
    "object": "field",
    "id": "2330458",
    "updatedAt": "2025-01-06T14:39:15.000Z",
    "createdAt": "2025-01-06T14:39:15.000Z",
    "metadata": {},
    "tableId": "1470",
    "levelId": "1685",
    "key": "BATTERY_TECHNOLOGY_CODE",
    "type": "SINGLE-LINE-TEXT",
    "title": "Battery technology",
    "multiValued": false,
    "parentId": "210181"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2025-01-06T14:39:15.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "2330458"}` `{"type": "search","field": "id","value": "2330458"}` `{"type": "in","field": "id","value": ["2330458"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "EAN"}` `{"type": "in","field": "key","value": ["EAN"]}`
levelId	eq/in	`{"type": "eq","field": "levelId","value": "1685"}` `{"type": "in","field": "levelId","value": ["1685"]}`
parentId	eq/in	`{"type": "eq","field": "parentId","value": "210181"}` `{"type": "in","field": "parentId","value": ["210181"]}`
tableId	eq/in	`{"type": "eq","field": "tableId","value": "1470"}` `{"type": "in","field": "tableId","value": ["1470"]}`
type	eq/search/in	`{"type": "eq","field": "type","value": "IDENTIFIER"}` `{"type": "in","field": "type","value": ["IDENTIFIER"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2025-01-06T14:39:15.000Z"}`

WARNING

The levelId property is not searchable on COMPOSITE children fields, as they do have the levelId property.

The parentId property is searchable on COMPOSITE children fields only, as other fields do not have parent.

Field Values

More details on the Content Management Item Links API here.

json

{
    "object": "field_value",
    "id": "24653136",
    "metadata": {},
    "title": "Headset",
    "status": "ACTIVE",
    "color": "NONE",
    "key": "HEADSET",
    "createdAt": "2025-01-06T14:39:15.000Z",
    "updatedAt": "2025-01-06T14:39:15.000Z",
    "tableId": "1470",
    "fieldId": "2330462"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2025-01-06T14:39:15.000Z"}`
fieldId	eq/search/in	`{"type": "eq","field": "fieldId","value": "2330462"}` `{"type": "search","field": "fieldId","value": "2330462"}` `{"type": "in","field": "fieldId","value": ["2330462"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "HEADSET"}` `{"type": "search","field": "key","value": "HEADSET"}` `{"type": "in","field": "key","value": ["HEADSET"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "24653136"}` `{"type": "search","field": "id","value": "24653136"}` `{"type": "in","field": "id","value": ["24653136"]}`
tableId	eq/search/in	`{"type": "eq","field": "tableId","value": "1470"}` `{"type": "search","field": "tableId","value": "1470"}` `{"type": "in","field": "tableId","value": ["1470"]}`
title	eq/search/in	`{"type": "eq","field": "title","value": "Headset"}` `{"type": "search","field": "title","value": "Headset"}` `{"type": "in","field": "title","value": ["Headset"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2025-01-06T14:39:15.000Z"}`

Items

More details on the Content Management Items API here.

json

{
  "fields": [
    {
      "key": "EAN",
      "type": "IDENTIFIER",
      "value": {
        "data": "3610011803438"
      }
    },
    {
      "key": "TYPOLOGY",
      "type": "CLASSIFICATION",
      "value": {
        "data": "FRIDGE"
      }
    }
  ],
  "parent": null,
  "children": null,
  "object": "item",
  "id": "391432",
  "createdAt": "2021-01-25T08:57:13.000Z",
  "updatedAt": "2021-01-26T15:35:33.000Z",
  "itemMetadata": {
    "createdAt": "2021-01-25T08:57:13.000Z",
    "updatedAt": "2021-01-26T15:35:33.000Z",
    "tableId": "154",
    "tableKey": "A06_PRODUCTS",
    "tableOwnerAccountId": "69",
    "levelId": "170",
    "levelKey": "PRODUCT",
    "partitionId": "280"
  }
}

Searchable field	Supported operator	Example
id	eq/search/in	`{"type": "eq","field": "id","value": "391432"}` `{"type": "search","field": "id","value": "391432"}` `{"type": "in","field": "id","value": ["391432"]}`
item.fields	see below	`{"type": "eq","field": {"target": "item.fields","key": "EAN"},"value": "8710103533825"}` `{"type": "search","field": {"target": "item.fields","key": "EAN"},"value": "8710103533825"}` `{"type": "in","field": {"target": "item.fields","key": "EAN"},"value": ["8710103533825"]}`

Field type	Operator
`IDENTIFIER`	eq/search/in
`CONDITIONAL-FORMATTING`	eq/search/in
`CONDITIONAL-FORMATTING` `"use": "isDefault"`	eq/in
`CLASSIFICATION`	eq/search/in
`SINGLE-LINE-TEXT`	eq/search/in
`LONG-TEXT`	eq/search/in
`HTML-TEXT`	eq/search/in
`SINGLE-SELECT`	eq/search/in
`NUMBER`	eq/in/greater/greaterOrEqual/lower/lowerOrEqual
`NUMBER` `"use": "suffix"`	eq/search/in
`DATE`	eq/greater/greaterOrEqual/lower/lowerOrEqual
`DATE-TIME`	eq/greater/greaterOrEqual/lower/lowerOrEqual

WARNING

Take care when filtering items on HTML-TEXT fields, the html tags are taken into account. The displayed value may not be exactly the real value, it may contain invisible html tags.
Use the search operator with % around the shortest value you are looking for.
You can search for items using fields key and value on all fields except MULTIPLE-SELECT, MULTIPLE-SELECT-QUANTIFIED, MULTIPLE-SELECT-QUANTIFIED-WITH-COMMENT and COMPOSITE fields yet.

Item Links

More details on the Content Management Item Links API here.

json

{
    "object": "item_link",
    "id": "88",
    "updatedAt": "2024-07-17T15:42:11.000Z",
    "createdAt": "2024-07-17T15:42:11.000Z",
    "fromItemId": "90684",
    "toItemId": "90688",
    "tableId": "1470"
}

Searchable field	Supported operator	Example
id	eq/search/in	`{"type": "eq","field": "id","value": "88"}` `{"type": "search","field": "id","value": "88"}` `{"type": "in","field": "id","value": ["88"]}`
fromItemId	eq/search/in	`{"type": "eq","field": "fromItemId","value": "90684"}` `{"type": "search","field": "fromItemId","value": "90684"}` `{"type": "in","field": "fromItemId","value": ["90684"]}`
tableId	eq/search/in	`{"type": "eq","field": "tableId","value": "1470"}` `{"type": "search","field": "tableId","value": "1470"}` `{"type": "in","field": "tableId","value": ["1470"]}`
toItemId	eq/search/in	`{"type": "eq","field": "toItemId","value": "90688"}` `{"type": "search","field": "toItemId","value": "90688"}` `{"type": "in","field": "toItemId","value": ["90688"]}`

Jobs

More details on the Content Management Items API here.

json

{
    "object": "job",
    "id": "65819ba43ad5b963658ab35d",
    "jobAccountId": "2492",
    "createdAt": "2023-12-19T13:33:24.809Z",
    "projectId": "633ec1f0829f993dedc288eb",
    "tasks": [
        {
            "name": "table-import-schema",
            "taskReferenceName": "Import table",
            "description": "Import table",
            "type": "SUB_WORKFLOW",
            "optional": false,
            "input": {
                "request": {
                    "url": "http://api.product-live.com/v1/data_factory/files/70923562084497906fe165aa6ff2629f2d1e61d39d3e017709f7ac7722ddd2be/content",
                    "filename": "table-import-schema.xml"
                },
                "mode": "EXHAUSTIVE",
                "eventCorrelationId": "IC6TmGUY:Import table:0",
                "context": "${workflow.input.input.context}"
            }
        }
    ],
    "pipelineId": "633bfeb86bddbde9262ad1bf",
    "key": "table_import",
    "periodicity": [],
    "status": "DRAFT",
    "title": "Import table",
    "description": "Import table",
    "visibility": {
        "mode": "NO_TABLES",
        "ids": []
    }
}

Searchable field	Supported operator	Example
id	eq/search/in	`{"type": "eq","field": "id","value": "65819ba43ad5b963658ab35d"}` `{"type": "search","field": "id","value": "65819ba43ad5b963658ab35d"}` `{"type": "in","field": "id","value": ["65819ba43ad5b963658ab35d"]}`
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "greater","field": "createdAt","value": "2023-12-19T13:33:24.809Z"}`
description	eq/in/search	`{"type": "eq","field": "description","value": "Import table"}` `{"type": "search","field": "description","value": "Import table"}` `{"type": "in","field": "description","value": ["Import table"]}`
key	eq/in	`{"type": "eq","field": "key","value": "table_import"}` `{"type": "search","field": "key","value": "table_import"}`
pipelineId	eq/in	`{"type": "eq","field": "pipelineId","value": "633bfeb86bddbde9262ad1bf"}` `{"type": "search","field": "pipelineId","value": "633bfeb86bddbde9262ad1bf"}`
projectId	eq/in	`{"type": "eq","field": "projectId","value": "633ec1f0829f993dedc288eb"}` `{"type": "search","field": "projectId","value": "633ec1f0829f993dedc288eb"}`
status	eq/in	`{"type": "eq","field": "status","value": "DRAFT"}` `{"type": "search","field": "kstatusey","value": "DRAFT"}`
title	eq/in/search	`{"type": "eq","field": "title","value": "Import table"}` `{"type": "search","field": "title","value": "Import table"}` `{"type": "in","field": "title","value": ["Import table"]}`

Job Executions

More details on the Content Management Job Executions API here.

json

{
    "object": "list",
    "data": [
        {
            "object": "job_execution",
            "jobId": "65819ba43ad5b963658ab35d",
            "id": "658445e23ad5b929948ab731",
            "pipelineId": "6582b5fb7bcba4a7a1147473",
            "createdAt": "2023-12-21T14:04:18.511Z",
            "endedAt": "2023-12-21T14:04:34.359Z",
            "input": {
                "context": {
                    "jobAccountId": "2629",
                    "jobId": "65819ba43ad5b963658ab35d",
                    "userShardId": "2629",
                    "userAccountId": "2629",
                    "userId": "5443"
                }
            },
            "startedAt": "2023-12-21T14:04:18.469Z",
            "status": "COMPLETED",
            "output": {
                "subWorkflowId": "0cc9caaa-01f7-44cc-be89-2e34181d248e",
                "report": {
                    "url": "https://app.product-live.com/data-factory/2629/download/98d345609f420b36b4296849498f5692fe655518110e7b174456d921ab32b4e2/report.xml",
                    "filename": "report.xml"
                }
            },
            "info": {
                "title": "Import Schema"
            }
        }
    ],
    "totalElements": 12
}

Searchable field	Supported operator	Example
jobId	eq/search/in	`{"type": "eq","field": "id","value": "1"}` `{"type": "in","field": "id","value": ["1", "2"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "658445e23ad5b929948ab731"}` `{"type": "search","field": "id","value": "1"}` `{"type": "in","field": "id","value": ["1", "2"]}`
pipelineId	eq/search/in	`{"type": "eq","field": "pipelineId","value": "6582b5fb7bcba4a7a1147473"}` `{"type": "search","field": "pipelineId","value": "1"}` `{"type": "in","field": "pipelineId","value": ["1", "2"]}`
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "greater","field": "createdAt","value": "2024-04-17T00:00:00.000Z"}`
status	eq/search/in	`{"type": "eq","field": "status","value": "COMPLETED"}` `{"type": "in","field": "status","value": ["COMPLETED"]}`

Levels

More details on the Content Management Levels API here.

json

{
    "id": "2",
    "updatedAt": "2023-03-01T09:24:27.000Z",
    "createdAt": "2023-03-01T09:24:27.000Z",
    "key": "PRODUCT",
    "tableId": "978"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2023-03-01T09:24:27.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "4627"}` `{"type": "search","field": "id","value": "4627"}` `{"type": "in","field": "id","value": ["4627"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "PRODUCT"}` `{"type": "in","field": "key","value": ["PRODUCT"]}`
tableId	eq/search/in	`{"type": "eq","field": "tableId","value": "978"}` `{"type": "search","field": "tableId","value": "978"}` `{"type": "in","field": "tableId","value": ["978"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2023-03-01T09:24:27.000Z"}`

Matrix Fields

More details on the Content Management Items API here.

json

{
    "object": "matrix_field",
    "id": "11152959",
    "updatedAt": "2025-01-06T14:39:15.000Z",
    "createdAt": "2025-01-06T14:39:15.000Z",
    "tableId": "1470",
    "fieldId": "2330458",
    "status": "ACTIVE"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2025-01-06T14:39:15.000Z"}`
fieldId	eq/in	`{"type": "eq","field": "fieldId","value": "2330458"}` `{"type": "in","field": "fieldId","value": ["2330458"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "11152959"}` `{"type": "search","field": "id","value": "11152959"}` `{"type": "in","field": "id","value": ["11152959"]}`
tableId	eq/in	`{"type": "eq","field": "tableId","value": "1470"}` `{"type": "in","field": "tableId","value": ["1470"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2025-01-06T14:39:15.000Z"}`

Partitions

More details on the Content Management Partitions API here.

json

{
    "id": "4627",
    "updatedAt": "2024-06-26T14:05:11.000Z",
    "createdAt": "2024-06-26T14:05:11.000Z",
    "title": "Suppliers",
    "position": 2,
    "lineHeight": "MEDIUM",
    "status": "ACTIVE",
    "description": "Supplier screen",
    "titleLocal": {
        "eng": "Suppliers"
    },
    "descriptionLocal": {
        "eng": "Suppliers"
    },
    "key": "suppliers",
    "tableId": "978",
    "levelId": "1023"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2024-06-26T14:05:11.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "4627"}` `{"type": "search","field": "id","value": "4627"}` `{"type": "in","field": "id","value": ["4627"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "suppliers"}` `{"type": "in","field": "key","value": ["suppliers"]}`
levelId	eq/search/in	`{"type": "eq","field": "levelId","value": "1023"}` `{"type": "search","field": "levelId","value": "1023"}` `{"type": "in","field": "levelId","value": ["1023"]}`
tableId	eq/search/in	`{"type": "eq","field": "tableId","value": "978"}` `{"type": "search","field": "tableId","value": "978"}` `{"type": "in","field": "tableId","value": ["978"]}`
title	eq/search/in	`{"type": "eq","field": "title","value": "Suppliers"}` `{"type": "search","field": "title","value": "Suppliers"}` `{"type": "in","field": "title","value": ["Suppliers"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2024-06-26T14:05:11.000Z"}`

Projects

More details on the Data Factory Projects API here.

json

{
    "object": "project",
    "id": "68123ada0f6c1ec60b63dea4",
    "createdAt": "2025-04-30T14:59:38.920Z",
    "displayName": "Sub Folder",
    "depth": 1,
    "parentId": "68123ad00f6c1ec60b63dea3",
    "accountId": "28"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2025-04-30T14:59:38.920Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "68123ada0f6c1ec60b63dea4"}` `{"type": "search","field": "id","value": "68123ada0f6c1ec60b63dea4"}` `{"type": "in","field": "id","value": ["68123ada0f6c1ec60b63dea4"]}`
displayName	eq/search/in	`{"type": "eq","field": "key","value": "Sub Folder"}` `{"type": "in","field": "key","value": ["Sub Folder"]}`
depth	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "depth","value": "1"}`
parentId	eq/search/in	`{"type": "eq","field": "parentId","value": "68123ad00f6c1ec60b63dea3"}` `{"type": "search","field": "parentId","value": "68123ad00f6c1ec60b63dea3"}` `{"type": "in","field": "parentId","value": ["68123ad00f6c1ec60b63dea3"]}`
accountId	eq/search/in	`{"type": "eq","field": "accountId","value": "28"}` `{"type": "search","field": "accountId","value": "28"}` `{"type": "in","field": "accountId","value": ["28"]}`

Publications

More details on the Content Management Publications API here.

json

{
    "object": "publication",
    "id": "38643",
    "updatedAt": "2024-05-17T07:39:23.000Z",
    "createdAt": "2024-05-17T07:38:54.000Z",
    "sentAt": "2024-05-17T07:38:54.000Z",
    "fromItemId": "80303",
    "toAccountId": "6326",
    "tableId": "1353",
    "partitionId": "2342",
    "screenId": "7421",
    "status": "RECEIVED",
    "fields": [
    {
      "key": "EAN",
      "type": "IDENTIFIER",
      "value": {
        "data": "3610011803438"
      }
    },
    {
      "key": "TYPOLOGY",
      "type": "CLASSIFICATION",
      "value": {
        "data": "FRIDGE"
      }
    }
  ]
}

Searchable field	Supported operator	Example
createdAt	greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "greaterOrEqual","field": "createdAt","value": "2024-05-17T07:39:23.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "38643"}` `{"type": "search","field": "id","value": "38643"}` `{"type": "in","field": "id","value": ["38643"]}`
fromItemId	eq/in	`{"type": "eq","field": "fromItemId","value": "80303"}` `{"type": "in","field": "fromItemId","value": ["80303"]}`
partitionId	eq/in	`{"type": "eq","field": "partitionId","value": "2342"}` `{"type": "in","field": "partitionId","value": ["2342"]}`
screenId	eq/in	`{"type": "eq","field": "screenId","value": "7421"}` `{"type": "in","field": "screenId","value": ["7421"]}`
sentAt	greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "greaterOrEqual","field": "sentAt","value": "2024-05-17T07:39:23.000Z"}`
status	eq/search/in	`{"type": "eq","field": "status","value": "RECEIVED"}` `{"type": "search","field": "status","value": "RECEIVED"}` `{"type": "in","field": "status","value": ["SENT","RECEIVED","REJECTED"]}`
tableId	eq/in	`{"type": "eq","field": "tableId","value": "1353"}` `{"type": "in","field": "tableId","value": ["1353"]}`
toAccountId	eq/search/in	`{"type": "eq","field": "toAccountId","value": "6326"}` `{"type": "search","field": "toAccountId","value": "6326"}` `{"type": "in","field": "toAccountId","value": ["6326"]}`
updatedAt	greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "greaterOrEqual","field": "updatedAt","value": "2024-05-17T07:38:54.000Z"}`

TIP

Depending on whether you are the emitter or receiver of publications, you will be able to see publications of specific status.

If you are the sender of publications, you can see "SENT", "RECEIVED" and "REJECTED" publications you have sent. If you are the receiver of publications, you can only see "SENT" publications you have received.

Screens

More details on the Content Management Screens API here.

json

{
    "id": "4627",
    "updatedAt": "2024-06-26T14:05:11.000Z",
    "createdAt": "2024-06-26T14:05:11.000Z",
    "title": "Suppliers",
    "position": 2,
    "lineHeight": "MEDIUM",
    "status": "ACTIVE",
    "description": "Supplier screen",
    "titleLocal": {
        "eng": "Suppliers",
        "deu": "Anbieter",
        "fra": "Fournisseurs",
        "spa": "Proveedor"
    },
    "descriptionLocal": {
        "eng": "Suppliers",
        "deu": "Anbieter",
        "fra": "Fournisseurs",
        "spa": "Proveedor"
    },
    "key": "suppliers",
    "tableId": "978",
    "levelId": "1023"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2024-06-26T14:05:11.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "4627"}` `{"type": "search","field": "id","value": "4627"}` `{"type": "in","field": "id","value": ["4627"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "suppliers"}` `{"type": "in","field": "key","value": ["suppliers"]}`
tableId	eq/search/in	`{"type": "eq","field": "tableId","value": "978"}` `{"type": "search","field": "tableId","value": "978"}` `{"type": "in","field": "tableId","value": ["978"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2024-06-26T14:05:11.000Z"}`

Screen Columns

More details on the Content Management Screen Columns API here.

json

{
    "object": "list",
    "data": [
        {
            "object": "screen_column",
            "id": "6236313",
            "updatedAt": "2025-02-27T15:36:55.000Z",
            "createdAt": "2025-02-27T15:36:55.000Z",
            "width": "MEDIUM",
            "position": 5,
            "isFixed": false,
            "isReadOnly": false,
            "screenSectionId": "988857",
            "fieldId": "90253",
            "parentId": "6791679"
        }
    ],
    "totalElements": 17
}

Searchable field	Supported operator	Example
fieldId	eq/search/in	`{"type": "eq","field": "fieldId","value": "90253"}` `{"type": "in","field": "fieldId","value": ["90253"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "6236313"}` `{"type": "search","field": "id","value": "6236313"}` `{"type": "in","field": "id","value": ["6236313"]}`
parentId	eq/search/in	`{"type": "eq","field": "parentId","value": "6791679"}` `{"type": "search","field": "parentId","value": "6791679"}` `{"type": "in","field": "parentId","value": ["6791679"]}`
screenSectionId	eq/search/in	`{"type": "eq","field": "screenSectionId","value": "988857"}` `{"type": "search","field": "screenSectionId","value": "988857"}` `{"type": "in","field": "screenSectionId","value": ["988857"]}`

TIP

The parentId property is only searchable on COMPOSITE children fields as other fields do not have parent screen column. It references the parent COMPOSITE screen column id.

Screen Sections

More details on the Content Management Screen Sections API here.

json

{
    "object": "list",
    "data": [
        {
            "object": "screen_section",
            "id": "988857",
            "updatedAt": "2025-02-27T15:36:55.000Z",
            "createdAt": "2025-02-27T15:36:55.000Z",
            "position": 1,
            "sectionId": "1995",
            "screenId": "789"
        }
    ],
    "totalElements": 1
}

Searchable field	Supported operator	Example
sectionId	eq/search/in	`{"type": "eq","field": "sectionId","value": "1995"}` `{"type": "search","field": "sectionId","value": "1995"}` `{"type": "in","field": "sectionId","value": ["1995"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "988857"}` `{"type": "search","field": "id","value": "988857"}` `{"type": "in","field": "id","value": ["988857"]}`
screenId	eq/search/in	`{"type": "eq","field": "screenId","value": "789"}` `{"type": "in","field": "screenId","value": ["789"]}`

Sections

More details on the Content Management Sections API here.

json

{
    "id": "1996",
    "updatedAt": "2024-11-22T09:37:46.000Z",
    "createdAt": "2024-11-22T09:37:46.000Z",
    "metadata": {},
    "title": "Specific information",
    "description": "Specific information section",
    "titleLocal": {
        "eng": "Specific information"
    },
    "descriptionLocal": {
        "eng": "Specific information section"
    },
    "key": "SPECIFIC",
    "tableId": "226"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2024-11-22T09:37:46.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "1996"}` `{"type": "search","field": "id","value": "1996"}` `{"type": "in","field": "id","value": ["1996"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "SPECIFIC"}` `{"type": "in","field": "key","value": ["SPECIFIC"]}`
tableId	eq/search/in	`{"type": "eq","field": "tableId","value": "226"}` `{"type": "search","field": "tableId","value": "226"}` `{"type": "in","field": "tableId","value": ["226"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2024-11-22T09:37:46.000Z"}`

Suggestions

More details on the Content Management Suggestions API here.

json

{
    "object": "suggestion",
    "id": "2185",
    "updatedAt": "2022-05-13T07:54:59.000Z",
    "createdAt": "2022-05-13T07:54:55.000Z",
    "toItemId": "1958624",
    "hasCreatedItem": true,
    "isAcknowledged": false,
    "fromAccountId": "3568",
    "screenId": "531059",
    "fields": [
    {
      "key": "EAN",
      "type": "IDENTIFIER",
      "value": {
        "data": "8710103533825"
      }
    },
    {
      "key": "LENGTH",
      "type": "NUMBER",
      "value": {
        "data": 42,
        "suffix": "cm"
      }
    }
  ],
  "deletedFields": [
    {
      "key": "DESIGNATION",
      "type": "SINGLE_LINE_TEXT"
    }
  ]
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2021-12-30T10:17:29.000Z"}`
fromAccountId	eq/search/in	`{"type": "eq","field": "fromAccountId","value": "3568"}` `{"type": "search","field": "fromAccountId","value": "3568"}` `{"type": "in","field": "fromAccountId","value": ["3568"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "2185"}` `{"type": "search","field": "id","value": "2185"}` `{"type": "in","field": "id","value": ["2185"]}`
hasCreatedItem	eq	`{"type": "eq","field": "hasCreatedItem","value": true}`
isAcknowledged	eq	`{"type": "eq","field": "isAcknowledged","value": false}`
screenId	eq/search/in	`{"type": "eq","field": "id","value": "531059"}` `{"type": "search","field": "id","value": "531059"}` `{"type": "in","field": "id","value": ["531059"]}`
toItemId	eq/search/in	`{"type": "eq","field": "toItemId","value": "1958624"}` `{"type": "search","field": "toItemId","value": "1958624"}` `{"type": "in","field": "toItemId","value": ["1958624"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2021-12-30T10:17:29.000Z"}`

Tables

More details on the Content Management Tables API here.

json

{
    "id": "1554",
    "updatedAt": "2025-01-24T14:24:33.000Z",
    "createdAt": "2025-01-14T13:40:42.000Z",
    "title": "Produits",
    "titleLocal": {
        "eng": "Products"
    },
    "key": "PRODUCTS_RETAILX",
    "accountId": "4013",
    "status": "ACTIVE"
}

Searchable field	Supported operator	Example
accountId	eq/in	`{"type": "eq","field": "accountId","value": "4013"}` `{"type": "in","field": "accountId","value": ["4013"]}`
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2025-01-14T13:40:42.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "1554"}` `{"type": "search","field": "id","value": "1554"}` `{"type": "in","field": "id","value": ["1554"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "PRODUCTS_RETAILX"}` `{"type": "in","field": "key","value": ["PRODUCTS_RETAILX"]}`
title	eq/search/in	`{"type": "eq","field": "title","value": "Produits"}` `{"type": "in","field": "title","value": ["Produits"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2025-01-24T14:24:33.000Z"}`

Users

More details on the Content Management Users API here.

json

{
    "object": "user",
    "id": "5443",
    "createdAt": "2021-09-15T13:14:41.000Z",
    "updatedAt": "2024-02-07T10:54:15.000Z",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@retailx.com",
    "status": "ACTIVE",
    "role": "EDITOR"
}

Searchable field	Supported operator	Example
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2021-09-15T13:14:41.000Z"}`
id	eq/search/in	`{"type": "eq","field": "id","value": "5443"}` `{"type": "search","field": "id","value": "5443"}` `{"type": "in","field": "id","value": ["5443"]}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2024-02-07T10:54:15.000Z"}`
status	eq/in	`{"type": "eq","field": "status","value": "ACTIVE"}` `{"type": "in","field": "status","value": ["ACTIVE"]}`
firstName	eq/search/in	`{"type": "eq","field": "firstName","value": "John"}` `{"type": "search","field": "firstName","value": "John"}` `{"type": "in","field": "firstName","value": ["John"]}`
lastName	eq/search/in	`{"type": "eq","field": "lastName","value": "Doe"}` `{"type": "search","field": "lastName","value": "Doe"}` `{"type": "in","field": "lastName","value": ["Doe"]}`
email	eq/search/in	`{"type": "eq","field": "email","value": "john.doe@retailx.com"}` `{"type": "search","field": "email","value": "john.doe@retailx.com"}` `{"type": "in","field": "email","value": ["john.doe@retailx.com"]}`

User Groups

json

{
    "object": "user_group",
    "id": "156",
    "updatedAt": "2025-06-03T15:15:10.000Z",
    "createdAt": "2025-06-03T15:15:10.000Z",
    "accountId": "4203",
    "title": "Team",
    "description": "My Team",
    "membersId": [
        "9224"
    ]
}

Searchable field	Supported operator	Example
createdAt	greater ✔ /greaterOrEqual ✔ /lower ✔ /lowerOrEqual ✔	`{"type": "greaterOrEqual","field": "createdAt","value": "2021-09-15T13:14:41.000Z"}`
description	eq/search/in	`{"type": "eq","field": "description","value": "My Team"}` `{"type": "search","field": "description","value": "My Team"}` `{"type": "in","field": "description","value": ["My Team"]}`
id	eq/in	`{"type": "eq","field": "id","value": "5443"}` `{"type": "in","field": "id","value": ["5443"]}`
updatedAt	greater ✔ /greaterOrEqual ✔ /lower ✔ /lowerOrEqual ✔	`{"type": "greaterOrEqual","field": "updatedAt","value": "2024-02-07T10:54:15.000Z"}`
title	eq/search/in	`{"type": "eq","field": "title","value": "Team"}` `{"type": "search","field": "title","value": "Team"}` `{"type": "in","field": "title","value": ["Team"]}`

Variables

More details on the Data Factory Variables API here.

json

{
  "status": "ACTIVE",
  "object": "variable",
  "id": "<REDACTED>",
  "createdAt": "2020-01-01T12:00:00.000Z",
  "updatedAt": "2020-01-02T12:00:00.000Z",
  "name": "string",
  "key": "string",
  "value": "<REDACTED>",
  "secret": true
}

Searchable field	Supported operator	Example
status	eq/in	`{"type": "eq","field": "status","value": "ACTIVE"}` `{"type": "in","field": "status","value": ["ACTIVE"]}`
id	eq/search/in	`{"type": "eq","field": "id","value": "126"}` `{"type": "search","field": "id","value": "126"}` `{"type": "in","field": "id","value": ["126"]}`
createdAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "createdAt","value": "2020-01-01T12:00:00.000Z"}`
updatedAt	eq/greater/greaterOrEqual/lower/lowerOrEqual	`{"type": "eq","field": "updatedAt","value": "2020-01-01T12:00:00.000Z"}`
name	eq/search/in	`{"type": "eq","field": "name","value": "FTP Host"}` `{"type": "in","field": "name","value": ["FTP Host"]}`
key	eq/search/in	`{"type": "eq","field": "key","value": "ftp_host"}` `{"type": "in","field": "key","value": ["ftp_host"]}`
value	eq/search/in	`{"type": "eq","field": "value","value": "my_host.com"}` `{"type": "in","field": "value","value": ["my_host.com"]}`
secret	eq/in	`{"type": "eq","field": "secret","secret": "true"}` `{"type": "in","field": "secret","value": ["true"]}`

Content Management API

Data Factory API

Find request

Introduction

Find query body

Operators

Accounts

Audit Logs

Comment Threads

Comment Thread Subscribers

Fields

Field Values

Items

Item Links

Jobs

Job Executions

Levels

Matrix Fields

Partitions

Projects

Publications

Screens

Screen Columns

Screen Sections

Sections

Suggestions

Tables

Users

User Groups

Variables

Find request ​

Introduction ​

Find query body ​

Operators ​

Accounts ​

Audit Logs ​

Comment Threads ​

Comment Thread Subscribers ​

Fields ​

Field Values ​

Items ​

Item Links ​

Jobs ​

Job Executions ​

Levels ​

Matrix Fields ​

Partitions ​

Projects ​

Publications ​

Screens ​

Screen Columns ​

Screen Sections ​

Sections ​

Suggestions ​

Tables ​

Users ​

User Groups ​

Variables ​

Find request

Introduction

Find query body

Operators

Accounts

Audit Logs

Comment Threads

Comment Thread Subscribers

Fields

Field Values

Items

Item Links

Jobs

Job Executions

Levels

Matrix Fields

Partitions

Projects

Publications

Screens

Screen Columns

Screen Sections

Sections

Suggestions

Tables

Users

User Groups

Variables