Get Sample By Id

Get Sample By Id

Returns a single sample

Request
URI
GET
https://apigw.vmware.com/sampleExchange/v1/search/samples/{id}
COPY
Path Parameters
integer
id
Required

ID of sample to return

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns 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"
}
integer As int32 As int32
id
Optional

id

Author
author
Optional

author

string
name
Optional

name

string
type
Optional

type

Possible values are : REPOSITORY, GIST, DCR, LINK,
string As date-time As date-time
created
Optional

created

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
lastAutoUpdated
Optional

lastAutoUpdated

string
readmeHtml
Optional

readmeHtml

boolean
appendRepositoryReadme
Optional

appendRepositoryReadme

string
repositoryReadmeHtml
Optional

repositoryReadmeHtml

string
ossLicense
Optional

ossLicense

string
downloadUrl
Optional

downloadUrl

string
webUrl
Optional

webUrl

string
gitHubUrl
Optional

gitHubUrl

string
branch
Optional

branch

array of string
paths
Optional

paths

array of SampleFile
files
Optional

files

array of Group
groups
Optional

groups

array of Category
categories
Optional

categories

array of Tag
tags
Optional

tags

array of Comment
comments
Optional

comments

integer As int32 As int32
favoriteCount
Optional

favoriteCount

integer As int32 As int32
downloadCount
Optional

downloadCount

number As double As double
score
Optional

score

string
metadata
Optional

metadata


404

The Sample was not found.

Operation doesn't return any data structure

On This Page
Search Operations
GET
Get All Requests
GET
Get All Requests Tags
GET
Get All Samples
GET
Get All Solutions
GET
Get All Tags
GET
Get Events By Federation Id
GET
Get Request Favorites
GET
Get Requests By Category Type
GET
Get Requests By Category Type And Version
GET
Get Requests By Communities User
GET
Get Requests By Federation Id
GET
Get Requests By Id
GET
Get Requests By State
GET
Get Requests By Tag Category And Name
GET
Get Requests By Tag Name
GET
Get Sample By Id
GET
Get Sample Downloads
GET
Get Sample Favorites
GET
Get Samples By Category
GET
Get Samples By Category And Version
GET
Get Samples By Communities User
GET
Get Samples By Federation Id
GET
Get Samples By Name
GET
Get Samples By Tag Category And Name
GET
Get Samples By Tag Name
GET
Get Server Info Object
GET
Get Solutions By Id
GET
Search Requests
GET
Search Samples
GET
Search Samples Paginated