Get Async Sample Update Status

Must be logged in to {code} and provide Basic Auth credentials.

Request

URI

GET

https://apigw.vmware.com/sampleExchange/v1/samples/async/{jobId}

COPY

Path Parameters

integer

jobId

Required

jobId

Authentication

This operation uses the following authentication methods.

dc_auth

Responses

200

successful operation

Returns SampleJob of type(s) application/json

{
    "id": 0,
    "communitiesUser": "string",
    "state": "string",
    "created": "string",
    "start": "string",
    "finished": "string",
    "progress": 0,
    "error": "string",
    "stackTrace": "string",
    "sampleId": 0,
    "sample": {
        "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

Optional

string

communitiesUser

Optional

communitiesUser

string

state

Optional

state

Possible values are : NEW, RUNNING, FINISHED,

string As date-time As date-time