Get all stock responses
get
/admin/stockResponses
Request
Query Parameters
-
type: string
Allowed Values:
[ "internal", "external" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Nested Schema : StockResponseWithID
Type:
Show Source
object-
description: string
meant to capture information about stock response
-
id: string
-
stock-api-selection: array
stock-api-selection
stock-api-selection is the main stock routing configuration of CXIF. Routing configuration in this section is made available at runtime so that Routing can take stock response vs target spoke system decisions.
-
stock-response: object
StockResponseData
Match One Schema
Show Source
Nested Schema : stock-api-selection
Type:
arraystock-api-selection is the main stock routing configuration of CXIF. Routing configuration in this section
is made available at runtime so that Routing can take stock response vs target spoke system decisions.
Show Source
Nested Schema : StockResponseData
Type:
Show Source
object-
content-encoding: string
Default Value:
gzip -
content-type: string
Default Value:
application/json -
description: string
meant to capture information about stock response
-
response: string
-
response-code: integer
Default Value:
200 -
response-headers: object
response-headers
Additional Properties Allowed: additionalProperties
Match One Schema
Show Source
Nested Schema : items
Type:
Show Source
object-
api-id: string
Pattern:
^[a-z0-9]{1,8}-[0-9]{1,4}$the api-id as it also appears on the API document. Together with api-version this forms the composite key to refer to a specific API -
api-version: string
the api-version as it also appears on the API document. Together with api-id this forms the composite key to refer to a specific API
-
description: string
meant to capture record level documentation
-
resources: array
resources
Minimum Number of Items:
1contains the list of resources on the API that are supported by this type of target -
stock-response: object
StockResponseData
Match One Schema
Show Source
Nested Schema : resources
Type:
arrayMinimum Number of Items:
1contains the list of resources on the API that are supported by this type of target
Show Source
Nested Schema : items
Type:
Show Source
object-
criterion-link: string
-
method-stock-responses: array
method-stock-responses
Minimum Number of Items:
1 -
rank: integer
-
resource-ids: array
resource-ids
Minimum Number of Items:
1the list of unique resources within the target API supported -
stock-response: object
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
-
supported-http-methods: array
supported-http-methods
Minimum Number of Items:
1
Match One Schema
Show Source
Nested Schema : resource-ids
Type:
arrayMinimum Number of Items:
1the list of unique resources within the target API supported
Show Source
Nested Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Nested Schema : supported-http-methods
Type:
arrayMinimum Number of Items:
Show Source
1-
Array of:
string
Allowed Values:
[ "GET", "POST", "PATCH", "PUT", "DELETE" ]
Nested Schema : items
Type:
Show Source
object-
http-method: string
Allowed Values:
[ "GET", "POST", "PATCH", "PUT", "DELETE" ] -
stock-response: object
StockResponseData
Match One Schema
Show Source
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
404 Response
Not Found
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension