CLcloudblue
Usage Reporting

GET /usage/files

Changed on

UsageFile collection contains APIs which can used used to create Usage report, upload normalized file and other actions available for vendors and providers.

Request

  • Base URL
    https://api.connect.cloudblue.com/public/v1
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

contract.idstring

Filter for: contract.id

lookups: eq, ne, like, ilike, null, in, out

search: true

contract.namestring

Filter for: contract.name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

created.atstring

Filter for: created.at

lookups: ge, gt, le, lt

ordering: true

distribution_contract_idstring

Filter for: distribution_contract_id

lookups: eq, ne, like, ilike, null, in, out

search: true

environment'test' | 'preview' | 'production'

Filter for: environment

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

external_idstring

Filter for: external_id

lookups: eq, ne, like, ilike, null, in, out

search: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

marketplace.idstring

Filter for: marketplace.id

lookups: eq, ne, like, ilike, null, in, out

search: true

marketplace.namestring

Filter for: marketplace.name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

marketplace_idstring

Filter for: marketplace_id

lookups: eq, ne, like, ilike, null, in, out

search: true

namestring

Filter for: name

lookups: eq, ne, like, ilike, null, in, out

search: true

product.idstring

Filter for: product.id

lookups: eq, ne, like, ilike, null, in, out

search: true

product.namestring

Filter for: product.name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

product_idstring

Filter for: product_id

lookups: eq, ne, like, ilike, null, in, out

search: true

provider.idstring

Filter for: provider.id

lookups: eq, ne, like, ilike, null, in, out

search: true

provider.namestring

Filter for: provider.name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

provider_idstring

Filter for: provider_id

lookups: eq, ne, like, ilike, null, in, out

search: true

schema'tr' | 'pr' | 'qt' | 'cr'

Filter for: schema

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

status'draft' | 'uploading' | 'uploaded' | 'invalid' | 'processing' | 'ready' | 'rejected' | 'pending' | 'accepted' | 'closed' | 'deleted'

Filter for: status

lookups: eq, ne, like, ilike, in, out

ordering: true

vendor.idstring

Filter for: vendor.id

lookups: eq, ne, like, ilike, null, in, out

search: true

vendor.namestring

Filter for: vendor.name

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

vendor_idstring

Filter for: vendor_id

lookups: eq, ne, like, ilike, null, in, out

search: true

Headers

Content-RangeContentRange (unresolved $ref)

RQL RFC2616 limit offset pagination.

Response

idstring
namestring nullable
external_idstring required
status'draft' | 'uploading' | 'uploaded' | 'invalid' | 'processing' | 'ready' | 'rejected' | 'pending' | 'accepted' | 'closed' | 'deleted'
environment'test' | 'preview' | 'production'
error_detailstring nullable
descriptionstring nullable
acceptance_notestring nullable
rejection_notestring nullable
schema'tr' | 'pr' | 'qt' | 'cr'
currencystring nullable

Changes

  • 2de715cbd1f3Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 22a697bcb678Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      deleted the query request parameter limit

    • warning

      deleted the query request parameter offset

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status