Get SoftwareComponentType

Get SoftwareComponentType

Get software component type by id.

Request
URI
GET
https://{api_host}/software-service/api/softwarecomponenttypes/{id}
COPY
Path Parameters
string
Required

The id of SoftwareComponentType.

Responses
200

Success - return software component type.

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": [
                        {
                            "value": {}
                        }
                    ]
                }
            }
        ]
    },
    "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"
}
object
schema
Optional

schema

array of object
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

SoftwareComponentType
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


403

Forbidden.

Operation doesn't return any data structure

404

Software component type not found.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/software-service/api/softwarecomponenttypes/{id}
On This Page
Api Operations
GET
Get SoftwareRequestState
POST
Get A set Of data for the specified object
GET
Get the schema for the specified object
GET
Get ScriptTypes
POST
Get the state Of A field In the specified schema
POST
Get the permissible values Of A field In the specified schema
PUT
Update SoftwareComponentType PublishStatus
GET
Get ScriptType for file extension
POST
Retrieves the list Of possible values for A given type Of object
GET
Get SoftwareResourceRequest
GET
Get ScriptType
POST
Get the state Of A field In the specified schema
GET
Get the schema for the specified object type
POST
Get the permissible values Of A field In the specified schema
POST
Get the state Of A field In the specified schema
POST
Get the permissible values Of A field In the specified schema
GET
Get the schema for the specified object class
POST
Create SoftwareComponentType
GET
Get SoftwareComponentTypeInfos
POST
Retrieves the list Of possible values for A given type Of object
GET
Get SoftwareComponentType
DELETE
Delete SoftwareComponentType
PUT
Update SoftwareComponentType