Content Management Screen Columns API

The Screen Columns 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

Screen Columns define how a field is displayed within a screen: the line height, the column width, is it fixed, is it editable.

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

General information

• Rate limit: 50 requests per minute

Get Screen Column by id

Request URL

Path parameters

Parameter	Type	Description
screenColumnId	string	A screen column 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 list of sections shared with you

Request Body

None

Request Example

curl

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

Response Example

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

List Screen Columns

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
screenSectionId	integer	The screen section id where to list screen columns
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
sort	string	Optional The field property to use to sort results
sortOrder	string	Optional The sort direction: ASC or DESC

Request headers

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

Request Body

None

Request Example

curl -X 'GET' \
  'https://api.product-live.com/v1/screen_columns?screenSectionId=988857&page=0&size=1&sortOrder=DESC&sort=id' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'

Response example

{
    "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"
        }
    ],
    "totalElements": 17
}

Find Screen Columns

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
screenSectionId	integer	The screen section id where to search screen columns
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
sort	string	Optional The field property to use to sort results
sortOrder	string	Optional The sort direction: ASC or DESC

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 sections 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": "fieldId",
    "value": "90253"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "fieldId",
        "value": "90253"
    },
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "screenSectionId",
        "value": "988857"
    }
  ]
}

Request Example

curl

curl -X 'POST' \
  'https://api.product-live.com/v1/screen_columns/find?screenSectionId=988857&page=0&size=1&sortOrder=ASC&sort=id' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'
  -d '{
  "type": "and",
  "queries": [
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "fieldId",
        "value": "90253"
    },
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "screenSectionId",
        "value": "988857"
    }
  ]
}'

Response example

{
    "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"
        }
    ],
    "totalElements": 17
}