CommBank requests are passed to the URL https://api.commbank.com.au/public/cds-au/v1/discovery
CBA – CommBiz requests are passed to the URL https://cdr.commbiz.api.commbank.com.au/cbzpublic/cds-au/v1/discovery
"}],"x-tagGroups":[{"name":"","tags":["Discovery API"]}],"paths":{"/status":{"get":{"summary":"Get Status","description":"Obtain a health check status for the implementation","operationId":"getStatus","tags":["Discovery API"],"consumes":["application/json"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/ParamXVHeader"},{"$ref":"#/parameters/ParamXMinVHeader"}],"responses":{"200":{"description":"Success","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-min-v":{"type":"integer","description":"Minimum version of the API end point you are requesting."}},"schema":{"$ref":"#/definitions/ResponseCommonDiscoveryStatus"}},"400":{"description":"Bad Request","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."}},"schema":{"$ref":"#/definitions/ErrorResponse400"}},"406":{"description":"Not Acceptable","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."}},"schema":{"$ref":"#/definitions/ErrorResponse406"}},"500":{"description":"Internal Server Error","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."}},"schema":{"$ref":"#/definitions/ErrorResponse500"}}}}},"/outages":{"get":{"summary":"Get Outages","description":"Obtain a list of scheduled outages for implementation","operationId":"getOutages","tags":["Discovery API"],"consumes":["application/json"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/ParamXVHeader"},{"$ref":"#/parameters/ParamXMinVHeader"}],"responses":{"200":{"description":"Success","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."},"x-min-v":{"type":"integer","description":"Minimum version of the API end point you are requesting."}},"schema":{"$ref":"#/definitions/ResponseDiscoveryOutagesList"}},"400":{"description":"Bad Request","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."}},"schema":{"$ref":"#/definitions/ErrorResponse400"}},"406":{"description":"Not Acceptable","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."}},"schema":{"$ref":"#/definitions/ErrorResponse406"}},"500":{"description":"Internal Server Error","headers":{"x-v":{"type":"integer","description":"Version of the API end point responded with."}},"schema":{"$ref":"#/definitions/ErrorResponse500"}}}}}},"parameters":{"ParamXVHeader":{"name":"x-v","in":"header","description":"Version of the API end point being requested.","type":"integer","example":"1","required":false},"ParamXMinVHeader":{"name":"x-min-v","in":"header","description":"Minimum version of the API end point you are requesting.","type":"integer","example":"1","required":false}},"definitions":{"ResponseCommonDiscoveryStatus":{"type":"object","required":["data","links"],"example":{"data":{"status":"OK","updateTime":"2020-03-02T03:53:33.6159975Z"},"links":{"self":"https://api.commbank.com.au/public/cds-au/v1/discovery/status"},"meta":{}},"properties":{"data":{"$ref":"#/definitions/ResponseCommonDiscoveryStatus_data"},"links":{"$ref":"#/definitions/Links"},"meta":{"$ref":"#/definitions/Meta"}}},"ResponseCommonDiscoveryStatus_data":{"required":["status","updateTime"],"properties":{"status":{"type":"string","description":"The current status of the API.","enum":["OK","PARTIAL_FAILURE","UNAVAILABLE","SCHEDULED_OUTAGE"]},"explanation":{"type":"string","description":"An explanation of the current outage."},"detectionTime":{"type":"string","description":"The date and time that the current outage was detected.","x-cds-type":"DateTimeString"},"expectedResolutionTime":{"type":"string","description":"The date and time that full service is expected to resume (if known).","x-cds-type":"DateTimeString"},"updateTime":{"type":"string","description":"The date and time that this status was last updated by the Data Holder.","x-cds-type":"DateTimeString"}}},"ResponseDiscoveryOutagesList":{"type":"object","required":["data","links"],"example":{"data":{"outages":[]},"links":{"self":"https://api.commbank.com.au/public/cds-au/v1/discovery/outages"},"meta":{}},"properties":{"data":{"$ref":"#/definitions/ResponseDiscoveryOutagesList_data"},"links":{"$ref":"#/definitions/Links"},"meta":{"$ref":"#/definitions/Meta"}}},"DiscoveryOutage":{"type":"object","required":["duration","explanation","outageTime"],"properties":{"outageTime":{"type":"string","description":"Date and time that the outage is scheduled to begin","x-cds-type":"DateTimeString"},"duration":{"type":"string","description":"Planned duration of the outage","x-cds-type":"ExternalRef"},"isPartial":{"type":"boolean","description":"Flag that indicates the outage is only partial"},"explanation":{"type":"string","description":"An explanation of the current outage"}}},"ResponseDiscoveryOutagesList_data":{"required":["outages"],"properties":{"outages":{"type":"array","description":"List of scheduled outages","items":{"$ref":"#/definitions/DiscoveryOutage"}}}},"Links":{"type":"object","required":["self"],"properties":{"self":{"type":"string","description":"Fully qualified link to this API call."}}},"LinksPaginated":{"type":"object","required":["self"],"x-conditional":["prev","next","first","last"],"properties":{"self":{"type":"string","description":"Fully qualified link to this API call."},"first":{"type":"string","description":"URI to the first page of this set."},"prev":{"type":"string","description":"URI to the previous page of this set."},"next":{"type":"string","description":"URI to the next page of this set."},"last":{"type":"string","description":"URI to the last page of this set."}}},"Meta":{},"MetaPaginated":{"type":"object","required":["totalPages","totalRecords"],"properties":{"totalRecords":{"type":"integer","description":"The total number of records in the full set.","x-cds-type":"NaturalNumber"},"totalPages":{"type":"integer","description":"The total number of pages in the full set.","x-cds-type":"NaturalNumber"}}},"ErrorResponse":{"type":"object","properties":{"errors":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/Error"}}}},"ErrorResponse400":{"type":"object","properties":{"errors":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/Error"}}},"example":{"errors":[{"code":"SA-RH-01","title":"x-v is invalid","detail":"x-v header must be a supported version number."}]}},"ErrorResponse406":{"type":"object","properties":{"errors":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/Error"}}},"example":{"errors":[{"code":"SA-RH-01","title":"x-v is invalid","detail":"x-v header must be a supported version number."},{"code":"SA-RH-02","title":"x-min-v is invalid","detail":"x-min-v header must be a supported version number."}]}},"ErrorResponse500":{"type":"object","properties":{"errors":{"uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/Error"}}},"example":{"errors":[{"code":"SA-IS-01","title":"Server Error","detail":"An error has occurred whilst processing your request. Please try again later."}]}},"ResponseNoBody":{"type":"object","properties":{},"example":{}},"Error":{"type":"object","properties":{"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}}}}}