Reports

Description

Instant and Schedule Reports

DEFAULT

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/report/_delete``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Body

Name

Required

Type

Format

Properties

Description

ceph_id

No

string

id

No

string

path

No

string

provider

No

string

{
    "ceph_id": "somestring",
    "id": "somestring",
    "path": "somestring",
    "provider": "somestring"
}

Responses

200

Type: DeleteInstantReportResponse

Example:

{
    "message": "somestring",
    "success": "somestring"
}

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/report/_download``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Body

Name

Required

Type

Format

Properties

Description

providerid

No

string

tenantid

No

string

{
    "providerid": "somestring",
    "tenantid": "somestring"
}

Responses

200

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/report/_generate``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Body

Name

Required

Type

Format

Properties

Description

actions

No

array of Actions

instanceType

No

string

path

No

string

provider

No

string

range

No

string

tenant

No

string

tenantDisplayName

No

string

tenantUUID

No

string

trigger

No

string

type

No

string

{
    "actions": [
        {
            "name": "somestring"
        },
        {
            "name": "somestring"
        }
    ],
    "instanceType": "somestring",
    "path": "somestring",
    "provider": "somestring",
    "range": "somestring",
    "tenant": "somestring",
    "tenantDisplayName": "somestring",
    "tenantUUID": "somestring",
    "trigger": "somestring",
    "type": "somestring"
}

Responses

200

Type: GenerateInstantReportResponse

Example:

{
    "message": "somestring",
    "success": "somestring"
}

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/report/_retrieve``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Body

Name

Required

Type

Format

Properties

Description

providerid

No

string

tenantid

No

string

{
    "providerid": "somestring",
    "tenantid": "somestring"
}

Responses

200

Type: ScheduledReportsResponse

Example:

{
    "message": "somestring",
    "reports": {
        "resultSet": [
            {
                "actions": {},
                "ceph_id": "somestring",
                "created_at": "somestring",
                "id": "somestring",
                "last_modified_at": "somestring",
                "last_modified_by": "somestring",
                "name": {},
                "occurance": "somestring",
                "path": "somestring",
                "providerid": "somestring",
                "reportid": "somestring",
                "tenantid": "somestring",
                "type": "somestring"
            },
            {
                "actions": {},
                "ceph_id": "somestring",
                "created_at": "somestring",
                "id": "somestring",
                "last_modified_at": "somestring",
                "last_modified_by": "somestring",
                "name": {},
                "occurance": "somestring",
                "path": "somestring",
                "providerid": "somestring",
                "reportid": "somestring",
                "tenantid": "somestring",
                "type": "somestring"
            }
        ],
        "resultSetCount": 1,
        "totalRecordsCount": 1
    },
    "success": "somestring"
}

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/reports``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Body

Name

Required

Type

Format

Properties

Description

reportPayload

No

ReportPayload

schedulerPayload

No

SchedulerPayload

{
    "reportPayload": {
        "actions": [
            {
                "name": "somestring"
            },
            {
                "name": "somestring"
            }
        ],
        "created_at": "somestring",
        "created_by": "somestring",
        "description": "somestring",
        "id": "somestring",
        "last_modified_by": "somestring",
        "name": "somestring",
        "occurance": "somestring",
        "providerId": "somestring",
        "tenantId": "somestring",
        "type": "somestring",
        "workFlowId": "somestring"
    },
    "schedulerPayload": {
        "duration": "somestring",
        "tenantDisplayName": "somestring",
        "tenantName": "somestring",
        "tenantUUID": "somestring"
    }
}

Responses

200

Type: CreateScheduleReportResponse

Example:

{
    "message": "somestring",
    "success": "somestring"
}

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/reports/_delete``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Body

Name

Required

Type

Format

Properties

Description

id

No

string

name

No

string

provider

No

string

workflowid

No

string

{
    "id": "somestring",
    "name": "somestring",
    "provider": "somestring",
    "workflowid": "somestring"
}

Responses

200

Type: DeleteScheduleReportResponse

Example:

{
    "message": "somestring",
    "success": "somestring"
}

POST ``/api/v2/hcuisapi/provider/{provider-name}/tenant/{tenant-name}/reports/_retrieve``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

tenant-name

path

Yes

string

Generated path parameter. Example value =’tenant1’

Request

Headers

x-account: Generated header parameter. Example value ='67a7e8ee-bbc1-11ea-ac32-0ae9d2075681'
authorization: Generated header parameter. Example value ='Session 6e972857-b122-4d68-a1f9-c22c8a453af3'

Responses

200

Type: InstantReportsResponse

Example:

{
    "message": "somestring",
    "reports": {
        "resultSet": [
            {
                "actions": {},
                "created_at": "somestring",
                "created_by": "somestring",
                "description": {},
                "id": "somestring",
                "last_modified_at": {},
                "last_modified_by": "somestring",
                "name": "somestring",
                "occurance": "somestring",
                "providerid": "somestring",
                "tenantid": "somestring",
                "type": "somestring",
                "workflowid": "somestring"
            },
            {
                "actions": {},
                "created_at": "somestring",
                "created_by": "somestring",
                "description": {},
                "id": "somestring",
                "last_modified_at": {},
                "last_modified_by": "somestring",
                "name": "somestring",
                "occurance": "somestring",
                "providerid": "somestring",
                "tenantid": "somestring",
                "type": "somestring",
                "workflowid": "somestring"
            }
        ],
        "resultSetCount": 1,
        "totalRecordsCount": 1
    },
    "success": "somestring"
}

Data Structures

Actions Model Structure

Name

Required

Type

Format

Properties

Description

name

No

string

Create Schedule Report Request Model Structure

Name

Required

Type

Format

Properties

Description

reportPayload

No

ReportPayload

schedulerPayload

No

SchedulerPayload

Create Schedule Report Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

success

No

string

Delete Instant Report Request Model Structure

Name

Required

Type

Format

Properties

Description

ceph_id

No

string

id

No

string

path

No

string

provider

No

string

Delete Instant Report Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

success

No

string

Delete Schedule Report Request Model Structure

Name

Required

Type

Format

Properties

Description

id

No

string

name

No

string

provider

No

string

workflowid

No

string

Delete Schedule Report Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

success

No

string

Download Report Request Model Structure

Name

Required

Type

Format

Properties

Description

providerid

No

string

tenantid

No

string

Generate Instant Report Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

success

No

string

Generate Report Request Model Structure

Name

Required

Type

Format

Properties

Description

actions

No

array of Actions

instanceType

No

string

path

No

string

provider

No

string

range

No

string

tenant

No

string

tenantDisplayName

No

string

tenantUUID

No

string

trigger

No

string

type

No

string

Instant Report Record Model Structure**

Name

Required

Type

Format

Properties

Description

actions

No

description

created_at

No

string

created_by

No

string

description

No

description

id

No

string

last_modified_at

No

description

last_modified_by

No

string

name

No

string

occurance

No

string

providerid

No

string

tenantid

No

string

type

No

string

workflowid

No

string

Description schema:

Instant Reports Request Model Structure

Name

Required

Type

Format

Properties

Description

providerid

No

string

tenantid

No

string

Instant Reports Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

reports

No

InstantReportsResults

success

No

string

Instant Reports Results Model Structure

Name

Required

Type

Format

Properties

Description

resultSet

No

array of InstantReportRecord

resultSetCount

No

integer

int32

totalRecordsCount

No

integer

int32

Report Payload Model Structure

Name

Required

Type

Format

Properties

Description

actions

No

array of Actions

created_at

No

string

created_by

No

string

description

No

string

id

No

string

last_modified_by

No

string

name

No

string

occurance

No

string

providerId

No

string

tenantId

No

string

type

No

string

workFlowId

No

string

Scheduled Report Record Model Structure

Name

Required

Type

Format

Properties

Description

actions

No

description

ceph_id

No

string

created_at

No

string

id

No

string

last_modified_at

No

string

last_modified_by

No

string

name

No

description

occurance

No

string

path

No

string

providerid

No

string

reportid

No

string

tenantid

No

string

type

No

string

Description schema:

Scheduled Reports Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

reports

No

ScheduledReportsResults

success

No

string

Scheduled Reports Results Model Structure

Name

Required

Type

Format

Properties

Description

resultSet

No

array of ScheduledReportRecord

resultSetCount

No

integer

int32

totalRecordsCount

No

integer

int32

Scheduler Payload Model Structure

Name

Required

Type

Format

Properties

Description

duration

No

string

tenantDisplayName

No

string

tenantName

No

string

tenantUUID

No

string