Get Tasks

Get Tasks

Get the Tasks

Request
URI
GET
https://sfo-vcf01.rainpole.io//v1/tasks
COPY
Query Parameters
integer
limit
Optional

The number of elements to be returned in the result

string
taskStatus
Optional

taskStatus

string
taskType
Optional

taskType

string
resourceId
Optional

resourceId

string
resourceType
Optional

resourceType

integer
completedAfter
Optional

A time based filter to get tasks which are completed after the given timestamp. A task is completed if its status is 'Successsful' or 'Failed'. Time is in milliseconds.


Responses
200

Returns the list of tasks.

Returns PageOfTask of type(s) application/json
{
    "elements": [
        {
            "completionTimestamp": "string",
            "creationTimestamp": "string",
            "errors": [
                {
                    "arguments": [
                        "string"
                    ],
                    "causes": [
                        {
                            "message": "string",
                            "type": "string"
                        }
                    ],
                    "errorCode": "string",
                    "errorType": "string",
                    "message": "string",
                    "nestedErrors": [
                        "Error Object"
                    ],
                    "referenceToken": "string",
                    "remediationMessage": "string"
                }
            ],
            "id": "string",
            "isCancellable": false,
            "localizableDescriptionPack": {
                "arguments": [
                    "string"
                ],
                "component": "string",
                "message": "string",
                "messageKey": "string"
            },
            "name": "string",
            "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
            "resources": [
                {
                    "fqdn": "string",
                    "name": "string",
                    "resourceId": "string",
                    "sans": [
                        "string"
                    ],
                    "type": "string"
                }
            ],
            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
            "subTasks": [
                {
                    "completionTimestamp": "string",
                    "creationTimestamp": "string",
                    "description": "string",
                    "errors": [
                        {
                            "arguments": [
                                "string"
                            ],
                            "causes": [
                                {
                                    "message": "string",
                                    "type": "string"
                                }
                            ],
                            "errorCode": "string",
                            "errorType": "string",
                            "message": "string",
                            "nestedErrors": [
                                "Error Object"
                            ],
                            "referenceToken": "string",
                            "remediationMessage": "string"
                        }
                    ],
                    "name": "string",
                    "resources": [
                        {
                            "fqdn": "string",
                            "name": "string",
                            "resourceId": "string",
                            "sans": [
                                "string"
                            ],
                            "type": "string"
                        }
                    ],
                    "stages": [
                        {
                            "completionTimestamp": "string",
                            "creationTimestamp": "string",
                            "description": "string",
                            "errors": [
                                {
                                    "arguments": [
                                        "string"
                                    ],
                                    "causes": [
                                        {
                                            "message": "string",
                                            "type": "string"
                                        }
                                    ],
                                    "errorCode": "string",
                                    "errorType": "string",
                                    "message": "string",
                                    "nestedErrors": [
                                        "Error Object"
                                    ],
                                    "referenceToken": "string",
                                    "remediationMessage": "string"
                                }
                            ],
                            "name": "string",
                            "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
                            "type": "string"
                        }
                    ],
                    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, NOT_APPLICABLE",
                    "subTasks": [
                        "SubTask Object"
                    ],
                    "type": "string"
                }
            ],
            "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
        }
    ],
    "pageMetadata": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}
array of Task
elements
Optional

The list of elements included in this page

pageMetadata
Optional

pageMetadata


500

Unexpected error

Returns Error of type(s) application/json
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

The error context (e.g. the component where it occurred).

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

string
remediationMessage
Optional

The localized remediation error message