{ "opencollection": "1.0.0", "info": { "name": "Budgets Budget API", "version": "20190111" }, "items": [ { "info": { "name": "budget", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of Budgets", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190111/budgets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is timeCreated.\nThe default sort order for timeCreated is DESC.\nThe default sort order for displayName is ASC in alphanumeric order.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the resource to filter by." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. This does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n" }, { "name": "targetType", "value": "", "type": "query", "description": "The type of target to filter by:\n * ALL - List all budgets\n * COMPARTMENT - List all budgets with targetType == \"COMPARTMENT\"\n * TAG - List all budgets with targetType == \"TAG\"\n" } ] }, "docs": "Gets a list of budgets in a compartment.\n\nBy default, ListBudgets returns budgets of the 'COMPARTMENT' target type, and the budget records with only one target compartment OCID.\n\nTo list all budgets, set the targetType query parameter to ALL (for example: 'targetType=ALL').\n\nClients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.\n" }, { "info": { "name": "Creates a new Budget", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190111/budgets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new budget.\n" }, { "info": { "name": "Returns a Budget", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190111/budgets/:budgetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." } ] }, "docs": "Gets a budget by the identifier." }, { "info": { "name": "Updates a Budget", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190111/budgets/:budgetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a budget identified by the OCID." }, { "info": { "name": "Delete a Budget", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190111/budgets/:budgetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." } ] }, "docs": "Deletes a specified budget resource." }, { "info": { "name": "Gets a list of all Alert Rules for a Budget", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190111/budgets/:budgetId/alertRules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. If not specified, the default is timeCreated.\nThe default sort order for timeCreated is DESC.\nThe default sort order for displayName is ASC in alphanumeric order.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The current state of the resource to filter by." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. This does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n" } ] }, "docs": "Returns a list of Alert Rules for a specified budget.\n" }, { "info": { "name": "Creates a new Alert Rule", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190111/budgets/:budgetId/alertRules", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Alert Rule.\n" }, { "info": { "name": "Get an Alert Rule for a specified budget", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190111/budgets/:budgetId/alertRules/:alertRuleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." }, { "name": "alertRuleId", "value": "", "type": "path", "description": "The unique Alert Rule OCID." } ] }, "docs": "Gets an Alert Rule for a specified budget." }, { "info": { "name": "Updates an Alert Rule", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190111/budgets/:budgetId/alertRules/:alertRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." }, { "name": "alertRuleId", "value": "", "type": "path", "description": "The unique Alert Rule OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Alert Rule for the budget identified by the OCID." }, { "info": { "name": "Delete an Alert Rule", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190111/budgets/:budgetId/alertRules/:alertRuleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "budgetId", "value": "", "type": "path", "description": "The unique budget OCID." }, { "name": "alertRuleId", "value": "", "type": "path", "description": "The unique Alert Rule OCID." } ] }, "docs": "Deletes a specified Alert Rule resource." } ] } ], "bundled": true }