Create an API annex
post
/admin/apiAnnexes
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : Api-generic-resource
Type:
Show Source
object
-
cors-preflight-handling: string
Allowed Values:
[ "fabric", "routing-target" ]
-
http-methods: array
http-methods
-
interaction-context-enrichment-specification: string
-
name: string
-
path-parameters: array
path-parameters
-
resource-id: string
-
resource-path: string
-
routing-ambiguity-resolution-strategy: string
Allowed Values:
[ "HTTP400BadRequest", "HTTP300MultipleChoices", "QueryHighestPriority", "QueryAllFirstMatch", "QueryAllRankedMatch", "QueryAllConflictFail" ]
Nested Schema : Http-method
Type:
Show Source
object
-
method: string
Allowed Values:
[ "GET", "PUT", "POST", "PATCH", "DELETE", "HEAD", "OPTIONS" ]
Nested Schema : Api-path-parameter
Type:
Show Source
object
-
description: string
-
is-record-id: boolean
-
parameter-name: string
-
parameter-type: string
Allowed Values:
[ "string", "number", "none" ]
Response
Supported Media Types
- application/json
201 Response
Created
Nested Schema : Api-generic-resource
Type:
Show Source
object
-
cors-preflight-handling: string
Allowed Values:
[ "fabric", "routing-target" ]
-
http-methods: array
http-methods
-
interaction-context-enrichment-specification: string
-
name: string
-
path-parameters: array
path-parameters
-
resource-id: string
-
resource-path: string
-
routing-ambiguity-resolution-strategy: string
Allowed Values:
[ "HTTP400BadRequest", "HTTP300MultipleChoices", "QueryHighestPriority", "QueryAllFirstMatch", "QueryAllRankedMatch", "QueryAllConflictFail" ]
Nested Schema : Http-method
Type:
Show Source
object
-
method: string
Allowed Values:
[ "GET", "PUT", "POST", "PATCH", "DELETE", "HEAD", "OPTIONS" ]
Nested Schema : Api-path-parameter
Type:
Show Source
object
-
description: string
-
is-record-id: boolean
-
parameter-name: string
-
parameter-type: string
Allowed Values:
[ "string", "number", "none" ]
400 Response
Bad Request
Root Schema : Error
Type:
object
Used 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:
object
Used 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:
object
Used 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:
object
Used 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
409 Response
Conflict
Root Schema : Error
Type:
object
Used 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:
object
Used 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
Examples
The following example shows how to create an api annex by submitting a get request on the REST resource using cURL.
cURL Command
curl --<username:password> --request POST
'{FABRIC_HOST}//admin/apiAnnexes' --header 'Authorization: Bearer
<accessToken> --header 'Content-Type: application/json'
Example of Request Body
The following shows an example of the request body in JSON format.
{ "base-api": "industries-tax-calculation-v4", "api-resources": [ { "resource-id": "addressValidation2", "name": "addressValidation2", "resource-path": "addressValidation", "cors-preflight-handling": "fabric", "routing-ambiguity-resolution-strategy": "HTTP400BadRequest" } ] }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "base-api": "industries-tax-calculation-v4", "api-resources": [ { "resource-id": "addressValidation2", "name": "addressValidation2", "resource-path": "addressValidation", "cors-preflight-handling": "fabric", "routing-ambiguity-resolution-strategy": "HTTP400BadRequest" } ], "id": "industries-tax-calculation-v4-annex-apiahv676" }