Post Using POST 1

Post Using POST 1

Creates a catalog source and imports catalog items from it.

Request
URI
POST
https://{api_host}//sc2-10-185-6-200.eng.vmware.com/catalog/api/admin/sources
COPY
Query Parameters
boolean
validationOnly
Optional

If true, the source will not be created. It returns the number of items belonging to the source. The request will still return an error code if the source is invalid.

Request Body

The catalog source to be created

CatalogSource of type(s) application/json
Optional 
{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "global": false,
    "iconId": "string",
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectId": "string",
    "typeId": "string"
}
object
config
Required

Source custom configuration

string As date-time As date-time
createdAt
Optional

Creation time

string
createdBy
Optional

Created By

string
description
Optional

Catalog Source description

boolean
global
Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid
iconId
Optional

Default Icon Id

string As uuid As uuid
id
Required

Catalog Source id

integer As int32 As int32
itemsFound
Optional

Number of items found

integer As int32 As int32
itemsImported
Optional

Number of items imported.

string As date-time As date-time
lastImportCompletedAt
Optional

Last import completion time

array of string
lastImportErrors
Optional

Last import error(s)

string As date-time As date-time
lastImportStartedAt
Optional

Last import start time

string As date-time As date-time
lastUpdatedAt
Optional

Update time

string
lastUpdatedBy
Optional

Updated By

string
name
Required

Catalog Source name

string
projectId
Optional

Project id where the source belongs

string
typeId
Required

Type of source, e.g. blueprint, CFT... etc

Responses
200

Validation is ok

Returns CatalogSource of type(s) application/json 
{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "global": false,
    "iconId": "string",
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectId": "string",
    "typeId": "string"
}
object
config
Required

Source custom configuration

string As date-time As date-time
createdAt
Optional

Creation time

string
createdBy
Optional

Created By

string
description
Optional

Catalog Source description

boolean
global
Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid
iconId
Optional

Default Icon Id

string As uuid As uuid
id
Required

Catalog Source id

integer As int32 As int32
itemsFound
Optional

Number of items found

integer As int32 As int32
itemsImported
Optional

Number of items imported.

string As date-time As date-time
lastImportCompletedAt
Optional

Last import completion time

array of string
lastImportErrors
Optional

Last import error(s)

string As date-time As date-time
lastImportStartedAt
Optional

Last import start time

string As date-time As date-time
lastUpdatedAt
Optional

Update time

string
lastUpdatedBy
Optional

Updated By

string
name
Required

Catalog Source name

string
projectId
Optional

Project id where the source belongs

string
typeId
Required

Type of source, e.g. blueprint, CFT... etc


201

Created

Returns CatalogSource of type(s) application/json 
{
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "global": false,
    "iconId": "string",
    "id": "string",
    "itemsFound": 0,
    "itemsImported": 0,
    "lastImportCompletedAt": "string",
    "lastImportErrors": [
        "string"
    ],
    "lastImportStartedAt": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "projectId": "string",
    "typeId": "string"
}
object
config
Required

Source custom configuration

string As date-time As date-time
createdAt
Optional

Creation time

string
createdBy
Optional

Created By

string
description
Optional

Catalog Source description

boolean
global
Optional

Global flag indicating that all the items can be requested across all projects.

string As uuid As uuid
iconId
Optional

Default Icon Id

string As uuid As uuid
id
Required

Catalog Source id

integer As int32 As int32
itemsFound
Optional

Number of items found

integer As int32 As int32
itemsImported
Optional

Number of items imported.

string As date-time As date-time
lastImportCompletedAt
Optional

Last import completion time

array of string
lastImportErrors
Optional

Last import error(s)

string As date-time As date-time
lastImportStartedAt
Optional

Last import start time

string As date-time As date-time
lastUpdatedAt
Optional

Update time

string
lastUpdatedBy
Optional

Updated By

string
name
Required

Catalog Source name

string
projectId
Optional

Project id where the source belongs

string
typeId
Required

Type of source, e.g. blueprint, CFT... etc


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Catalog Sources Operations
DELETE
Delete Using DELETE 1
GET
Get Page Using GET 1
GET
Get Using GET 1
POST
Post Using POST 1