Create
Create report
Request
URI
POST
https://vcportal.velocloud.net//api/sase-licensing/v1/reports
COPY
Request Body
createReportBody
of type(s)
application/json
Required
{
"partnerLogicalId": "5cdff30e-8aa0-459e-908d-1366d76882fa",
"reportTemplateId": 100,
"vcoEdgeLogicalIds": [
"5cdff30e-8aa0-459e-908d-1366d76882fa"
]
}
string As uuid
As uuid
partnerLogicalId
Optional
Logical ID
integer
reportTemplateId
Required
reportTemplateId
array of
string
vcoEdgeLogicalIds
Optional
Logical ID
Responses
201
Created 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