This endpoint enables you to retrieve all the user defined objects for a given account. The “search” part of this endpoint lets you carry out an FQL search.
http://<publish-url>/public/api/<pluralName>
Parameters
Table 1.
| Parameter | Parameter Type | Data Type | Mandatory | Description |
| pluralName | Path | String | Yes | The pluralName of the user defined object type. |
| token | Query | String | Yes | The shared token used for authentication purposes. |
| fql | Query | String | Yes | The query in Flex Query Language (for more details about FQL look at Flex Query Language Library) |
| limit | Query | Integer | No | The number of results to return. The default value is 100, the maximum per page is 100. |
| page | Query | Integer | No | The page for the results. |
An example of a response for this call is shown below:
{
"limit": 0,
"message": "string",
"page": 0,
"pageElements": 0,
"resources": [
{
"accountId": 0,
"children": [
{
"id": 0,
"metadata": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"title": "string",
"type": "string",
"url": {
"authority": "string",
"content": {},
"defaultPort": 0,
"file": "string",
"host": "string",
"path": "string",
"port": 0,
"protocol": "string",
"query": "string",
"ref": "string",
"userInfo": "string"
}
}
],
"createdDate": "2018-06-19T12:15:07.143Z",
"description": "string",
"flexSiteUuid": "string",
"id": 0,
"lastModified": "2018-06-19T12:15:07.143Z",
"metadata": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"pluralName": "string",
"publishedDate": "2018-06-19T12:15:07.143Z",
"subAccountId": 0,
"title": "string",
"uuid": "string",
"variant": "string"
}
],
"totalCount": 0
}
Comments
0 comments
Please sign in to leave a comment.