Jump to

• Request
• Response

GetMeteringData

get

https://{host}:{port}/{basePath}/MeteringData/getMeteringData

Request

Query Parameters

• startindex(required): integer

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object MeteringData
  oracle.doceng.json.BetterJsonNull@220f6a3c

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MeteringData"
    }
}

Nested Schema : MeteringData

Type: object

oracle.doceng.json.BetterJsonNull@220f6a3c

Show Source

• compartmentId: string
  Maximum Length: 64
• meter: string
  Maximum Length: 64
• mId: string
  Maximum Length: 64
• reported: string
  Maximum Length: 64
• resourceId: string
  Maximum Length: 64
• service: string
  Maximum Length: 64
• tags: string
  Maximum Length: 64
• tenancyId: string
  Maximum Length: 64
• updateTime: string
  Maximum Length: 64
• value: integer

{
    "properties":{
        "mId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "service":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "meter":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "resourceId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "compartmentId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "tenancyId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "tags":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "value":{
            "description":"",
            "type":"integer"
        },
        "updateTime":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "reported":{
            "description":"",
            "maxLength":64,
            "type":"string"
        }
    },
    "type":"object",
    "description":null
}

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top