Update Sample Async

Update Sample Async

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

Request
URI
PUT
https://apigw.vmware.com/sampleExchange/v1/samples/async
COPY
Request Body
Contribution of type(s) application/json
Optional 
{
    "id": 0,
    "active": false,
    "name": "string",
    "type": "string",
    "readmeHtml": "string",
    "appendRepositoryReadme": false,
    "repositoryReadmeHtml": "string",
    "url": "string",
    "githubApiUrl": "string",
    "branch": "string",
    "paths": [
        "string"
    ],
    "files": [
        {
            "id": 0,
            "name": "string",
            "mode": "string",
            "type": "string",
            "sha": "string",
            "path": "string",
            "size": 0,
            "url": "string",
            "content": "string"
        }
    ],
    "categories": [
        {
            "id": 0,
            "parentId": 0,
            "type": "string",
            "name": "string",
            "version": "string"
        }
    ],
    "tags": [
        {
            "id": 0,
            "parentId": 0,
            "category": "string",
            "name": "string"
        }
    ],
    "ossLicense": "string",
    "metadata": "string"
}
integer As int32 As int32
id
Optional

id

boolean
active
Optional

active

string
name
Optional

name

string
type
Optional

type

Possible values are : REPOSITORY, GIST, PROJECT, SNIPPET, DCR, LINK,
string
readmeHtml
Optional

readmeHtml

boolean
appendRepositoryReadme
Optional

appendRepositoryReadme

string
repositoryReadmeHtml
Optional

repositoryReadmeHtml

string
url
Optional

url

string
githubApiUrl
Optional

githubApiUrl

string
branch
Optional

branch

array of string
paths
Optional

paths

array of FileInfo
files
Optional

files

array of Category
categories
Optional

categories

array of Tag
tags
Optional

tags

string
ossLicense
Optional

ossLicense

string
metadata
Optional

metadata

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted, the sample is asynchronously processing.

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
id
Optional

id

string
communitiesUser
Optional

communitiesUser

string
state
Optional

state

Possible values are : NEW, RUNNING, FINISHED,
string As date-time As date-time
created
Optional

created

string As date-time As date-time
start
Optional

start

string As date-time As date-time
finished
Optional

finished

integer As int32 As int32
progress
Optional

progress

string
error
Optional

error

string
stackTrace
Optional

stackTrace

integer As int32 As int32
sampleId
Optional

sampleId

Sample
sample
Optional

sample


400

Bad Request, invalid sample data was supplied.

Operation doesn't return any data structure

401

Unauthorized, credentials not supplied or incorrect.

Operation doesn't return any data structure

403

Forbidden, Unable to update another users Sample.

Operation doesn't return any data structure

404

The sample was not found.

Operation doesn't return any data structure

On This Page
Samples Operations
PUT
Add Category
PUT
Add Category No Version
PUT
Add Tag
GET
Get Async Sample Update Status
GET
Get Metadata
GET
Get Sample Content Types
DELETE
Remove Category
DELETE
Remove Category No Version
DELETE
Remove Sample
DELETE
Remove Tag
POST
Resync Sample
PUT
Update Metadata
PUT
Update Sample
PUT
Update Sample Async
PUT
Update Sample Contributor