Get SoftwareResourceRequest

Get SoftwareResourceRequest

Get software resource request for id.

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

The id of SoftwareResource.


Responses
200

Success - return Software Resource Request

Returns SoftwareResourceRequest of type(s) */*
{
    "requestedFor": "string",
    "taskRequests": [
        {
            "logDescription": "string",
            "log": "string",
            "taskDescriptorRef": {
                "lastUpdated": "string",
                "createdDate": "string",
                "name": "string",
                "description": "string",
                "id": "string",
                "version": 0
            },
            "version": 0,
            "script": {
                "scriptContent": "string",
                "isRebootAfter": false,
                "scriptTypeId": {
                    "name": "string",
                    "supportedOsDetails": [
                        {
                            "execCommand": "string",
                            "osFamily": "string",
                            "execScript": "string",
                            "supportsOutputProps": false,
                            "fileExtension": "string",
                            "execScriptExtension": "string"
                        }
                    ]
                }
            },
            "lastUpdated": "string",
            "createdDate": "string",
            "stateName": "string",
            "dateStarted": "string",
            "dateCompleted": "string",
            "nodeRef": {
                "agentId": "string",
                "proxyConfig": {
                    "entries": [
                        {
                            "key": "string"
                        }
                    ]
                },
                "osFamily": "string",
                "machineResourceId": "string",
                "version": 0,
                "lastUpdated": "string",
                "subTenantId": "string",
                "createdDate": "string",
                "name": "string",
                "tenantId": "string",
                "agentVersion": "string",
                "lastAgentPingDate": "string",
                "id": "string",
                "registrationState": "string",
                "subscriptionEndpoint": "string"
            },
            "id": "string",
            "state": "string"
        }
    ],
    "operationDescriptorRef": {
        "lastUpdated": "string",
        "createdDate": "string",
        "displayName": "string",
        "defaultTaskMappings": [
            {
                "taskDescriptorRef": {
                    "lastUpdated": "string",
                    "createdDate": "string",
                    "name": "string",
                    "description": "string",
                    "id": "string",
                    "version": 0
                },
                "order": 0
            }
        ],
        "appearsAfterRef": "OperationDescriptor Object",
        "description": "string",
        "lifecycleAction": "string",
        "id": "string",
        "version": 0
    },
    "resourceId": "string",
    "rootCafeRequestId": "string",
    "externalServiceId": "string",
    "version": 0,
    "statusMessage": "string",
    "lastUpdated": "string",
    "requestedBy": "string",
    "subTenantId": "string",
    "createdDate": "string",
    "softwareComponentTypeRef": {
        "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"
    },
    "stateName": "string",
    "dateCompleted": "string",
    "resourceData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "tenantId": "string",
    "id": "string",
    "state": "string",
    "requestData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "previousResourceData": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "dateSubmitted": "string"
}
string
requestedFor
Optional

requestedFor

taskRequests
Optional

taskRequests

operationDescriptorRef
Optional

operationDescriptorRef

string
resourceId
Optional

resourceId

string
rootCafeRequestId
Optional

rootCafeRequestId

string
externalServiceId
Optional

externalServiceId

integer As int64 As int64
version
Optional

version

string
statusMessage
Optional

statusMessage

string As date-time As date-time
lastUpdated
Optional

lastUpdated

string
requestedBy
Optional

requestedBy

string
subTenantId
Optional

subTenantId

string As date-time As date-time
createdDate
Optional

createdDate

softwareComponentTypeRef
Optional

softwareComponentTypeRef

string
stateName
Optional

stateName

string As date-time As date-time
dateCompleted
Optional

dateCompleted

resourceData
Optional

resourceData

string
tenantId
Optional

tenantId

string As uuid As uuid
id
Optional

id

string
state
Required

state

Possible values are : SUBMITTED, IN_PROGRESS, SUCCEEDED, FAILED,
requestData
Optional

requestData

previousResourceData
Optional

previousResourceData

string As date-time As date-time
dateSubmitted
Optional

dateSubmitted


403

Forbidden.

Operation doesn't return any data structure

404

Software Resource Request not found.

Operation doesn't return any data structure