Search Samples | VMware {code} Sample Exchange API

Search Samples

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.

Request

URI

GET

https://apigw.vmware.com/sampleExchange/v1/search/samples

COPY

Query Parameters

string of array

platform

Optional

Optional platform to search for

string of array

tag

Optional

Optional tag to search for

string of array

keyword

Optional

Optional keyword to search for

string of array

req_platform

Optional

Required platform, must appear in each result.

string of array

req_tag

Optional

Required tag, must appear in each result.

string of array

req_keyword

Optional

Required keyword, must appear in each result.

boolean

modified

Optional

if true returned samples modified in the time window only, default is false,meaning samples created in the time window.

integer

days

Optional

If provided an integer value for the number of preceeding days to search in. Default is 0 meaning all time.

boolean

summary

Optional

if true returned samples are only a summary and do not include all fields. Much faster...

integer

offset

Optional

If provided an integer value for offset in the results to start returning. Default is 0.

integer

limit

Optional

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.

Authentication

This operation uses the following authentication methods.

dc_auth

dc_token

Responses

200

OK, a list of samples is returned.

Returns Array of Sample of type(s) application/json

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

400

Bad Request, one or more query arguments are invalid.

Operation doesn't return any data structure

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Search Operations