Content Management Sections API
The Sections 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
Sections allow to visually group properties. Sections are used to display item fields in the grid and in the detail view.
The Sections API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Get Section by id
Request URL
Path parameters
| Parameter | Type | Description |
|---|---|---|
| sectionId | string | A section 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
bash
curl -X 'GET' \
'GET https://api.product-live.com/v1/sections/1996' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'1
2
3
4
5
2
3
4
5
Response Example
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"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
List Sections
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| tableId | integer | The table id where to list sections |
| 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
bash
curl -X 'GET' \
'https://api.product-live.com/v1/sections?tableId=226&page=0&size=1&sortOrder=DESC&sort=key' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'1
2
3
4
5
2
3
4
5
Response example
json
{
"object": "list",
"data": [
{
"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"
}
],
"totalElements": 1
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Find Sections
Request URL
Path parameters
None
Request parameters
| Parameter | Type | Description |
|---|---|---|
| tableId | integer | The table id where to search sections |
| 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.
json
{
"type": "search",
"caseSensitive": true,
"field": "key",
"value": "SPECIFIC"
}1
2
3
4
5
6
2
3
4
5
6
json
{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": true,
"field": "key",
"value": "SPECIFIC"
},
{
"type": "greaterOrEqual",
"caseSensitive": true,
"field": "createdAt",
"value": "2024-11-22T09:37:46.000Z"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/screen_sections/find?size=10&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
-d '{
"type": "and",
"queries": [
{
"type": "search",
"caseSensitive": true,
"field": "key",
"value": "SPECIFIC"
},
{
"type": "greaterOrEqual",
"caseSensitive": true,
"field": "createdAt",
"value": "2024-11-22T09:37:46.000Z"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Response example
json
{
"object": "list",
"data": [
{
"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"
}
],
"totalElements": 1
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22