Create SoftwareComponentType

Create SoftwareComponentType

Create software component type.

Request
URI
POST
https://{api_host}/software-service/api/softwarecomponenttypes
COPY
Request Body

The softwareComponentType.

SoftwareComponentType of type(s) application/json
Required
{
    "schema": {
        "fields": [
            {
                "permissibleValues": {
                    "customAllowed": false
                },
                "displayAdvice": "string",
                "columns": [
                    "Field Object"
                ],
                "dataType": {
                    "typeId": "string"
                },
                "isMultiValued": false,
                "description": "string",
                "orderIndex": 0,
                "id": "string",
                "label": "string",
                "state": {
                    "dependencies": [
                        "string"
                    ],
                    "facets": [
                        {}
                    ]
                }
            }
        ]
    },
    "lifecycleTasks": [
        {
            "lastUpdated": "string",
            "createdDate": "string",
            "taskDescriptorRef": {
                "lastUpdated": "string",
                "createdDate": "string",
                "name": "string",
                "description": "string",
                "id": "string",
                "version": 0
            },
            "id": "string",
            "version": 0,
            "script": {
                "scriptContent": "string",
                "isRebootAfter": false,
                "scriptTypeId": {
                    "name": "string",
                    "supportedOsDetails": [
                        {
                            "execCommand": "string",
                            "osFamily": "string",
                            "execScript": "string",
                            "supportsOutputProps": false,
                            "fileExtension": "string",
                            "execScriptExtension": "string"
                        }
                    ]
                }
            }
        }
    ],
    "description": "string",
    "version": 0,
    "lastUpdated": "string",
    "createdDate": "string",
    "derivesFromRef": "SoftwareComponentType Object",
    "name": "string",
    "tenantId": "string",
    "publishStatusName": "string",
    "id": "string",
    "catalogResourceTypeId": "string",
    "containerResourceTypeId": "string",
    "publishStatus": "string",
    "containerFieldId": "string"
}
schema
Optional

schema

lifecycleTasks
Optional

lifecycleTasks

string
description
Optional

description

integer As int64 As int64
version
Optional

version

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
createdDate
Optional

createdDate

derivesFromRef
Optional

derivesFromRef

string
name
Optional

name

string
tenantId
Optional

tenantId

string
publishStatusName
Optional

publishStatusName

string
id
Optional

id

string
catalogResourceTypeId
Optional

catalogResourceTypeId

string
containerResourceTypeId
Optional

containerResourceTypeId

string
publishStatus
Required

publishStatus

Possible values are : DRAFT, PUBLISHED, RETIRED,
string
containerFieldId
Optional

containerFieldId

Responses
200

successful operation

Returns SoftwareComponentType of type(s) */*
{
    "schema": {
        "fields": [
            {
                "permissibleValues": {
                    "customAllowed": false
                },
                "displayAdvice": "string",
                "columns": [
                    "Field Object"
                ],
                "dataType": {
                    "typeId": "string"
                },
                "isMultiValued": false,
                "description": "string",
                "orderIndex": 0,
                "id": "string",
                "label": "string",
                "state": {
                    "dependencies": [
                        "string"
                    ],
                    "facets": [
                        {}
                    ]
                }
            }
        ]
    },
    "lifecycleTasks": [
        {
            "lastUpdated": "string",
            "createdDate": "string",
            "taskDescriptorRef": {
                "lastUpdated": "string",
                "createdDate": "string",
                "name": "string",
                "description": "string",
                "id": "string",
                "version": 0
            },
            "id": "string",
            "version": 0,
            "script": {
                "scriptContent": "string",
                "isRebootAfter": false,
                "scriptTypeId": {
                    "name": "string",
                    "supportedOsDetails": [
                        {
                            "execCommand": "string",
                            "osFamily": "string",
                            "execScript": "string",
                            "supportsOutputProps": false,
                            "fileExtension": "string",
                            "execScriptExtension": "string"
                        }
                    ]
                }
            }
        }
    ],
    "description": "string",
    "version": 0,
    "lastUpdated": "string",
    "createdDate": "string",
    "derivesFromRef": "SoftwareComponentType Object",
    "name": "string",
    "tenantId": "string",
    "publishStatusName": "string",
    "id": "string",
    "catalogResourceTypeId": "string",
    "containerResourceTypeId": "string",
    "publishStatus": "string",
    "containerFieldId": "string"
}
schema
Optional

schema

lifecycleTasks
Optional

lifecycleTasks

string
description
Optional

description

integer As int64 As int64
version
Optional

version

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string As date-time As date-time
createdDate
Optional

createdDate

derivesFromRef
Optional

derivesFromRef

string
name
Optional

name

string
tenantId
Optional

tenantId

string
publishStatusName
Optional

publishStatusName

string
id
Optional

id

string
catalogResourceTypeId
Optional

catalogResourceTypeId

string
containerResourceTypeId
Optional

containerResourceTypeId

string
publishStatus
Required

publishStatus

Possible values are : DRAFT, PUBLISHED, RETIRED,
string
containerFieldId
Optional

containerFieldId


201

Success - return created software component type.

Operation doesn't return any data structure

400

Invalid software component type for creation.

Operation doesn't return any data structure

403

Forbidden.

Operation doesn't return any data structure