Replace an API
put
/admin/apis/{id}
Request
Path Parameters
-
id(required): string
The id of the API to be updated
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
200 Response
OK
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:
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
409 Response
Conflict
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
Examples
The following example shows how to replace an api by submitting a PUT request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>'
-X PUT https://{FABRIC_HOST}/admin/apis/{id} -H "Content-Type:
application/json" -D @replace_adminapi.json| json_ppExample of Request Body
The following shows an example of the request body in JSON format.
{
"api-name": "fa-api-contacts",
"api-id": "fa-101",
"api-version": "v7",
"api-resources": [
{
"resource-id": "contacts",
"name": "contacts",
"resource-path": "{party-number}",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": true
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_SourceSystemRef",
"name": "contacts_SourceSystemRef",
"resource-path": "{party-number}/child/SourceSystemReference",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_ContactPoint",
"name": "contacts_ContactPoint",
"resource-path": "{party-number}/child/ContactPoint",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_SourceSystemRef_Id",
"name": "contacts_SourceSystemRef_Id",
"resource-path": "{party-number}/child/SourceSystemReference/{sourcesystem-refid}",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
},
{
"parameter-name": "sourcesystem-refid",
"parameter-type": "string",
"is-record-id": false
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_ContactPoint_Id",
"name": "contacts_ContactPoint_Id",
"resource-path": "{party-number}/child/ContactPoint/{contactpoint-id}",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
},
{
"parameter-name": "contactpoint-id",
"parameter-type": "string",
"is-record-id": true
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
}
],
"alternative-root-path": "contacts-updated",
"api-events": [],
"openapi-document-url": "https://do-nothing",
"type": "custom"
}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"api-name": "fa-api-contacts",
"api-id": "fa-101",
"api-version": "v7",
"api-resources": [
{
"resource-id": "contacts",
"name": "contacts",
"resource-path": "{party-number}",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": true
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_SourceSystemRef",
"name": "contacts_SourceSystemRef",
"resource-path": "{party-number}/child/SourceSystemReference",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_ContactPoint",
"name": "contacts_ContactPoint",
"resource-path": "{party-number}/child/ContactPoint",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_SourceSystemRef_Id",
"name": "contacts_SourceSystemRef_Id",
"resource-path": "{party-number}/child/SourceSystemReference/{sourcesystem-refid}",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
},
{
"parameter-name": "sourcesystem-refid",
"parameter-type": "string",
"is-record-id": false
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
},
{
"resource-id": "contacts_ContactPoint_Id",
"name": "contacts_ContactPoint_Id",
"resource-path": "{party-number}/child/ContactPoint/{contactpoint-id}",
"path-parameters": [
{
"parameter-name": "party-number",
"parameter-type": "string",
"is-record-id": false
},
{
"parameter-name": "contactpoint-id",
"parameter-type": "string",
"is-record-id": true
}
],
"cors-preflight-handling": "fabric",
"routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
}
],
"alternative-root-path": "contacts-updated",
"api-events": [],
"openapi-document-url": "https://do-nothing",
"id": "fa-api-contactst4dd9",
"type": "custom"
}