{ "opencollection": "1.0.0", "info": { "name": "Usage Proxy Rewards API", "version": "20190111" }, "items": [ { "info": { "name": "rewards", "type": "folder" }, "items": [ { "info": { "name": "Returns the list of products and their corresponding product usage information for a usage period ID.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/subscriptions/:subscriptionId/products", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "query", "description": "The OCID of the tenancy." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID for which rewards information is requested for." }, { "name": "usagePeriodKey", "value": "", "type": "query", "description": "The SPM Identifier for the usage period." }, { "name": "page", "value": "", "type": "query", "description": "The value of the 'opc-next-page' response header from the previous call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in the paginated response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, which can be ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Supports one sort order." }, { "name": "producttype", "value": "", "type": "query", "description": "The field to specify the type of product." } ] }, "docs": "Provides product information that is specific to a reward usage period and its usage details.\n" }, { "info": { "name": "ListRedeemableUsers", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/subscriptions/:subscriptionId/redeemableUsers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "query", "description": "The OCID of the tenancy." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID for which rewards information is requested for." }, { "name": "page", "value": "", "type": "query", "description": "The value of the 'opc-next-page' response header from the previous call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in the paginated response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, which can be ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Supports one sort order." } ] }, "docs": "Provides the summarized list of users that can redeem rewards for the given subscription ID.\n" }, { "info": { "name": "Add list of redeemable user summary for a subscription Id", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190111/subscriptions/:subscriptionId/redeemableUsers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "query", "description": "The OCID of the tenancy." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID for which rewards information is requested for." }, { "name": "userId", "value": "", "type": "query", "description": "The user ID of the person to send a copy of an email." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the summarized list of users that can redeem rewards for a given subscription ID.\n" }, { "info": { "name": "delete a list of email id from redeemable email ids list", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190111/subscriptions/:subscriptionId/redeemableUsers", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "emailId", "value": "", "type": "query", "description": "The email ID that needs to be deleted." }, { "name": "tenancyId", "value": "", "type": "query", "description": "The OCID of the tenancy." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID for which rewards information is requested for." } ] }, "docs": "Deletes the list of users by email ID that can redeem rewards, for a particular subscription ID.\n" }, { "info": { "name": "Returns list of redemption for the subscription Id.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/subscriptions/:subscriptionId/redemptions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "query", "description": "The OCID of the tenancy." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID for which rewards information is requested for." }, { "name": "timeRedeemedGreaterThanOrEqualTo", "value": "", "type": "query", "description": "The starting redeemed date filter for the redemption history." }, { "name": "timeRedeemedLessThan", "value": "", "type": "query", "description": "The ending redeemed date filter for the redemption history." }, { "name": "page", "value": "", "type": "query", "description": "The value of the 'opc-next-page' response header from the previous call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in the paginated response." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, which can be ascending (ASC) or descending (DESC)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to be used only for the list redemptions API. Supports one sort order." } ] }, "docs": "Returns the list of redemptions for the subscription ID.\n" }, { "info": { "name": "Returns list of rewards for a given subscription Id", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190111/subscriptions/:subscriptionId/rewards", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tenancyId", "value": "", "type": "query", "description": "The OCID of the tenancy." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID for which rewards information is requested for." } ] }, "docs": "Returns the list of rewards for a subscription ID.\n" } ] } ], "bundled": true }