Cloud Platform Report Service API v1.1.0

This schema defines the REST API for reports, which are generated using Azure Resource Graph.

Contact: Cloud Operations

Operations

Tag: reports

list-reports

Operation Id: list-reports

Action: GET /reports

Summary: Lists available reports

Responses

Status	Meaning	Description	Schema
200	OK	OK	ReportNames
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/reports HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/reports \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/reports', headers = headers)

print(r.json())

get-report

Operation Id: get-report

Action: GET /reports/{reportName}

Summary: Receives a report

Parameters

Name	In	Type	Required	Description
reportName	path	ReportName	true	none
count	query	integer	false	none
nextPageToken	query	string	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ReportResponse
400	Bad Request	Bad Request	Problem
401	Unauthorized	Unauthorized	Problem
404	Not Found	The specified resource was not found	Problem
422	Unprocessable Entity	Unprocessable Entity	Problem
500	Internal Server Error	Internal Server Error	Problem

Note

This operation does not require authentication

Code samples

GET http://localhost:3000/reports/{reportName} HTTP/1.1
Host: localhost:3000
Accept: application/json

# You can also use wget
curl -X GET http://localhost:3000/reports/{reportName} \
  -H 'Accept: application/json'

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('http://localhost:3000/reports/{reportName}', headers = headers)

print(r.json())

Schemas

ReportName

"string"

Name of report

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Name of report

ReportNames

[
  "string"
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[ReportName]	false	none	[Name of report]

ReportResponse

{
  "totalRecords": 0,
  "count": 0,
  "nextPageToken": "string",
  "data": null
}

Properties

Name	Type	Required	Restrictions	Description
totalRecords	integer(int32)	false	none	none
count	integer(int32)	false	none	none
nextPageToken	string	false	none	none
data	any	false	none	none

InnerError

{
  "code": "string",
  "innererror": {
    "code": "string",
    "innererror": {
      "code": "string",
      "innererror": {
        "code": "string",
        "innererror": {
          "code": null,
          "innererror": null
        }
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
innererror	InnerError	false	none	none

Error

{
  "code": "string",
  "message": "string",
  "target": "string",
  "details": [
    {
      "code": "string",
      "message": "string",
      "target": "string",
      "details": [
        {
          "code": "string",
          "message": "string",
          "target": "string",
          "details": [
            {}
          ],
          "innererror": {
            "code": null,
            "innererror": null
          }
        }
      ],
      "innererror": {
        "code": "string",
        "innererror": {
          "code": "string",
          "innererror": {}
        }
      }
    }
  ],
  "innererror": {
    "code": "string",
    "innererror": {
      "code": "string",
      "innererror": {
        "code": "string",
        "innererror": {
          "code": null,
          "innererror": null
        }
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
code	string	false	none	none
message	string	false	none	none
target	string	false	none	none
details	[Error]	false	none	none
innererror	InnerError	false	none	none

Problem

{
  "type": "/some/uri-reference",
  "title": "some title for the error situation",
  "status": 100,
  "detail": "some description for the error situation",
  "instance": "/some/uri-reference#specific-occurrence-context",
  "cause": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string",
        "details": [
          {
            "code": null,
            "message": null,
            "target": null,
            "details": null,
            "innererror": null
          }
        ],
        "innererror": {
          "code": "string",
          "innererror": {}
        }
      }
    ],
    "innererror": {
      "code": "string",
      "innererror": {
        "code": "string",
        "innererror": {
          "code": null,
          "innererror": null
        }
      }
    }
  }
}

https://datatracker.ietf.org/doc/html/rfc7807

Properties

Name	Type	Required	Restrictions	Description
type	string(uri)	true	none	A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
title	string	false	none	A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
status	integer(int32)	false	none	The HTTP status code generated by the origin server for this occurrence of the problem.
detail	string	false	none	A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
instance	string(uri-reference)	false	none	A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
cause	Error	false	none	none