Search Samples Paginated
Full text search. Any platform, tag, or keyword values specified are required to appear in a search result. In the case of multiple query terms, only one is required to appear. For the req_* query values, each one must appear in each result.
Optional platform to search for
Optional tag to search for
Optional keyword to search for
Required platform, must appear in each result.
Required tag, must appear in each result.
Required keyword, must appear in each result.
if true returned samples modified in the time window only, default is false,meaning samples created in the time window.
If provided an integer value for the number of preceeding days to search in. Default is 0 meaning all time.
if true returned samples are only a summary and do not include all fields. Much faster...
If provided an integer value for offset in the results to start returning. Default is 0.
If provided an integer limit for the number of results to return. Note that the total results available is returned in the X-Total-Count header. -1 means no limit.
OK, a Samples paginated list container is returned.
{
"total": 0,
"count": 0,
"start": 0,
"data": [
{
"id": 0,
"author": {
"id": 0,
"federationId": "string",
"communitiesUser": "string",
"fullName": "string",
"gitHubLogin": "string",
"gitHubToken": "string",
"linked": false,
"score": "number"
},
"name": "string",
"type": "string",
"created": "string",
"lastUpdated": "string",
"lastAutoUpdated": "string",
"readmeHtml": "string",
"appendRepositoryReadme": false,
"repositoryReadmeHtml": "string",
"ossLicense": "string",
"downloadUrl": "string",
"webUrl": "string",
"gitHubUrl": "string",
"branch": "string",
"paths": [
"string"
],
"files": [
{
"id": 0,
"sampleId": 0,
"path": "string",
"url": "string",
"basicMimeType": "string"
}
],
"groups": [
{
"id": 0,
"sampleId": 0,
"name": "string"
}
],
"categories": [
{
"id": 0,
"parentId": 0,
"type": "string",
"name": "string",
"version": "string"
}
],
"tags": [
{
"id": 0,
"parentId": 0,
"category": "string",
"name": "string"
}
],
"comments": [
{
"id": 0,
"parentId": 0,
"type": "string",
"federationId": "string",
"communitiesUser": "string",
"comment": "string",
"created": "string",
"lastUpdated": "string"
}
],
"favoriteCount": 0,
"downloadCount": 0,
"score": "number",
"metadata": "string"
}
]
}total
count
start
Bad Request, one or more query arguments are invalid.