Get By Id

Get By Id

Get report by logical ID

Request
URI
GET
https://vcportal.velocloud.net//api/sase-licensing/v1/reports/{logicalId}
COPY
Path Parameters
string
logicalId
Required

Report logical ID

Query Parameters
string
partnerLogicalId
Optional

Partner logical ID

Responses
200

Report

Returns createOrGetReportResponse of type(s) application/json 
{
    "reportTemplateId": 100,
    "status": "string",
    "url": "string",
    "enterpriseUserId": 100,
    "operatorUserId": 100,
    "created": "2020-07-18T15:48:18.000Z",
    "modified": "2020-07-18T15:48:18.000Z",
    "userFirstName": "string",
    "userLastName": "string",
    "reportTemplateName": "string",
    "reportTemplateDescription": "string"
}
integer
reportTemplateId
Required

reportTemplateId

string
status
Required

status

Possible values are : QUEUED, IN_PROGRESS, COMPLETED, ERROR,
string
url
Required

url

integer
enterpriseUserId
Required

enterpriseUserId

integer
operatorUserId
Required

operatorUserId

string As date-time As date-time
created
Required

created

string As date-time As date-time
modified
Required

modified

string
userFirstName
Required

userFirstName

string
userLastName
Required

userLastName

string
reportTemplateName
Required

reportTemplateName

string
reportTemplateDescription
Required

reportTemplateDescription


400

invalid input

Returns httpResponseError of type(s) application/json 
{
    "code": "string",
    "errors": [
        {
            "message": "error",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, DUPLICATE_ENTITY, VCO_API_ERROR, VCO_API_DUPLICATE_ENTERPRISE, VCO_API_NOT_FOUND, VCO_INVALID_CREDENTIALS, PONCHO_API_ERROR,
array of object
errors
Required

errors


500

server internal error

Returns httpResponseError of type(s) application/json 
{
    "code": "string",
    "errors": [
        {
            "message": "error",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, DUPLICATE_ENTITY, VCO_API_ERROR, VCO_API_DUPLICATE_ENTERPRISE, VCO_API_NOT_FOUND, VCO_INVALID_CREDENTIALS, PONCHO_API_ERROR,
array of object
errors
Required

errors


On This Page
Reports Operations
POST
Create
GET
Get All Reports
GET
Get By Id