Jump to

• Request
• Response

Retrieves the list of covered assets of a subscription product

get

/ccstore/v1/selfservice/subscriptionProducts/{pSubscriptionProductPuId}/coveredAssets

Retrieves all active subscriptions associated with the organization of logged in profile in the currently authenticated session. If the profile is not logged in or is anonymous then the endpoint will fail. The endpoint will responds with same data what is received from corresponding subscription endpoint

Request

Supported Media Types

• application/json

Path Parameters

• pSubscriptionProductPuId(required): string
  ID of subscription product.

Query Parameters

• limit: string
  The batch size of the subscription products covered assets to be fetched together. Default limit is 25, max limit is also 25
• offset: string
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by. Default is EndDate
• totalResults: boolean
  it provides the number of total results. Default is false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response containing the list of subscription products covered assets

Body ()

Root Schema : getSubscriptionProductCoveredAssets_Response

Type: object

Show Source

• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset value used in the current page.",
            "type":"integer"
        },
        "count":{
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "type":"boolean"
        },
        "limit":{
            "description":"The actual paging size used by the server.",
            "type":"integer"
        },
        "items":{
            "description":"The items in the collection.",
            "title":"Items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "StartDate":{
                        "format":"date",
                        "description":"The date when the covered level starts.",
                        "title":"Covered Level Start Date",
                        "type":"string"
                    },
                    "CurrencyCode":{
                        "description":"The currency code associated with the covered level.",
                        "type":"string",
                        "maxLength":15
                    },
                    "CoveredLevlName":{
                        "description":"The name of the covered level.",
                        "title":"Covered Level Name",
                        "type":"string"
                    },
                    "Description":{
                        "description":"A brief description of the covered level.",
                        "title":"Covered Level Description",
                        "type":"string"
                    },
                    "ProductName":{
                        "description":"The name of the product associated with the covered level.",
                        "title":"Product Name",
                        "type":"string"
                    },
                    "TotalContractValue":{
                        "description":"The total contract value associated with the covered level.",
                        "title":"Covered Level Contract Value",
                        "type":"number"
                    },
                    "SerialNumber":{
                        "description":"The serial number of the covered level.",
                        "readOnly":true,
                        "title":"Covered Asset Serial Number",
                        "type":"string",
                        "maxLength":80
                    },
                    "CoveredLevelPuid":{
                        "description":"The public unique identifier of the covered level.",
                        "type":"string",
                        "maxLength":120
                    },
                    "Quantity":{
                        "description":"The quantity of the covered level.",
                        "title":"Quantity",
                        "type":"number"
                    },
                    "EndDate":{
                        "format":"date",
                        "description":"The date when the covered level ends.",
                        "title":"Covered Level End Date",
                        "type":"string"
                    },
                    "CoveredLevlNumber":{
                        "description":"The alternate identifier of the covered level.",
                        "title":"Covered Level Number",
                        "type":"string"
                    },
                    "AssetSerialNumber":{
                        "description":"The serial number of the asset.",
                        "title":"Covered Asset Serial Number",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "offset":0,
        "count":0,
        "hasMore":false,
        "limit":25,
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/CDRM_5001-PRDT-4001/coveredAssets"
            }
        ],
        "items":[
        ]
    }
}

Example:

{
    "offset":0,
    "count":0,
    "hasMore":false,
    "limit":25,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/subscriptionProducts/CDRM_5001-PRDT-4001/coveredAssets"
        }
    ],
    "items":[
    ]
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object items

{
    "description":"The items in the collection.",
    "title":"Items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "StartDate":{
                "format":"date",
                "description":"The date when the covered level starts.",
                "title":"Covered Level Start Date",
                "type":"string"
            },
            "CurrencyCode":{
                "description":"The currency code associated with the covered level.",
                "type":"string",
                "maxLength":15
            },
            "CoveredLevlName":{
                "description":"The name of the covered level.",
                "title":"Covered Level Name",
                "type":"string"
            },
            "Description":{
                "description":"A brief description of the covered level.",
                "title":"Covered Level Description",
                "type":"string"
            },
            "ProductName":{
                "description":"The name of the product associated with the covered level.",
                "title":"Product Name",
                "type":"string"
            },
            "TotalContractValue":{
                "description":"The total contract value associated with the covered level.",
                "title":"Covered Level Contract Value",
                "type":"number"
            },
            "SerialNumber":{
                "description":"The serial number of the covered level.",
                "readOnly":true,
                "title":"Covered Asset Serial Number",
                "type":"string",
                "maxLength":80
            },
            "CoveredLevelPuid":{
                "description":"The public unique identifier of the covered level.",
                "type":"string",
                "maxLength":120
            },
            "Quantity":{
                "description":"The quantity of the covered level.",
                "title":"Quantity",
                "type":"number"
            },
            "EndDate":{
                "format":"date",
                "description":"The date when the covered level ends.",
                "title":"Covered Level End Date",
                "type":"string"
            },
            "CoveredLevlNumber":{
                "description":"The alternate identifier of the covered level.",
                "title":"Covered Level Number",
                "type":"string"
            },
            "AssetSerialNumber":{
                "description":"The serial number of the asset.",
                "title":"Covered Asset Serial Number",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• AssetSerialNumber: string
  Title: Covered Asset Serial Number

  The serial number of the asset.
• CoveredLevelPuid: string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CoveredLevlName: string
  Title: Covered Level Name

  The name of the covered level.
• CoveredLevlNumber: string
  Title: Covered Level Number

  The alternate identifier of the covered level.
• CurrencyCode: string
  Maximum Length: 15

  The currency code associated with the covered level.
• Description: string
  Title: Covered Level Description

  A brief description of the covered level.
• EndDate: string(date)
  Title: Covered Level End Date

  The date when the covered level ends.
• ProductName: string
  Title: Product Name

  The name of the product associated with the covered level.
• Quantity: number
  Title: Quantity

  The quantity of the covered level.
• SerialNumber: string
  Title: Covered Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the covered level.
• StartDate: string(date)
  Title: Covered Level Start Date

  The date when the covered level starts.
• TotalContractValue: number
  Title: Covered Level Contract Value

  The total contract value associated with the covered level.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "format":"date",
            "description":"The date when the covered level starts.",
            "title":"Covered Level Start Date",
            "type":"string"
        },
        "CurrencyCode":{
            "description":"The currency code associated with the covered level.",
            "type":"string",
            "maxLength":15
        },
        "CoveredLevlName":{
            "description":"The name of the covered level.",
            "title":"Covered Level Name",
            "type":"string"
        },
        "Description":{
            "description":"A brief description of the covered level.",
            "title":"Covered Level Description",
            "type":"string"
        },
        "ProductName":{
            "description":"The name of the product associated with the covered level.",
            "title":"Product Name",
            "type":"string"
        },
        "TotalContractValue":{
            "description":"The total contract value associated with the covered level.",
            "title":"Covered Level Contract Value",
            "type":"number"
        },
        "SerialNumber":{
            "description":"The serial number of the covered level.",
            "readOnly":true,
            "title":"Covered Asset Serial Number",
            "type":"string",
            "maxLength":80
        },
        "CoveredLevelPuid":{
            "description":"The public unique identifier of the covered level.",
            "type":"string",
            "maxLength":120
        },
        "Quantity":{
            "description":"The quantity of the covered level.",
            "title":"Quantity",
            "type":"number"
        },
        "EndDate":{
            "format":"date",
            "description":"The date when the covered level ends.",
            "title":"Covered Level End Date",
            "type":"string"
        },
        "CoveredLevlNumber":{
            "description":"The alternate identifier of the covered level.",
            "title":"Covered Level Number",
            "type":"string"
        },
        "AssetSerialNumber":{
            "description":"The serial number of the asset.",
            "title":"Covered Asset Serial Number",
            "type":"string"
        }
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |59000|If there is a missing required property.| |59002|If request can't be processed currently.| |59003|If there is any invalid path parameter| |59004|If resource is not found| |59005|If error occurred while processing input.| |59008|If any issue occured while triggering the fusion.|

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top