Content Management Screens API

The Screens 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

A screen designates what fields will be displayed for your items in the Product-Live interface. With this API, you can get overall information on screens on your and your partner shared tables.

The Screens API Swagger definition is available on our Product-Live API portal here.

General information

• Rate limit: 50 requests per minute

Get Screen by id

Request URL

Path parameters

Parameter	Type	Description
screenId	string	A screen id

Request parameters

None

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key
X-Context	number	The account id of your partner in order to get the screen he shared with you

Request Body

None

Request Example

curl -X 'GET' \
  'https://api-next.product-live.com/v1/screens/4627' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'

Response Example

{
    "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"
}

List Screens

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
tableId	string	A table Id
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key
X-Context	number	The account id of your partner in order to get the list of screens he shared with you

Request Body

None

Request Example

curl -X 'GET' \
  'https://api-next.product-live.com/v1/screens?tableId=978&page=0&size=1' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'

Response example

{
    "object": "list",
    "data": [
        {
            "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"
        }
    ],
    "totalElements": 1
}

Find Screens

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
tableId	string	A table Id
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key
X-Context	number	The account id of your partner in order to get the screen he shared with you

Request Body

See more details on the find request body in the dedicated page Find request.

Single parameter research

{
    "type": "eq",
    "caseSensitive": true,
    "field": "title",
    "value": "View all business columns"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "title",
        "value": "View all business columns"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2021-12-30T10:17:29.000Z"
    }
  ]
}

Request Example

curl

curl -X 'POST' \
  'https://api.product-live.com/v1/screens/find?tableId=978&page=0&size=1' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'
  -d '{
  "type": "and",
  "queries": [
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "key",
        "value": "ACTIVE"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2021-12-30T10:17:29.000Z"
    }
  ]
}'

Response example

{
    "object": "list",
    "data": [
        {
            "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"
        }
    ],
    "totalElements": 1
}