Replace a listener registration
put
/admin/listenerRegistrations/{id}
Request
Path Parameters
-
id(required): string
The id of the Listener Registration to be updated
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
200 Response
OK
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 a listener registration by submitting a PUT request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X PUT
https://{FABRIC_HOST}/admin/listenerRegistrations/{id} -H
"Content-Type: application/json" -D @replace_listenerregistration.json| json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
{
"affiliated-apis": [
{
"api-name": "party",
"api-id": "tmf-632",
"api-version": "v4",
"query": "(/eventType eq \"IndividualCreateEvent\" or /eventType eq \"IndividualDeleteEvent\" or /eventType eq \"IndividualAttributeValueChangeEvent\" or /eventType eq \"OrganizationDeleteEvent\" or /eventType eq \"OrganizationCreateEvent\" or /eventType eq \"OrganizationAttributeValueChangeEvent\")"
}
],
"listener-locality": {
"external-listener": {
"listener-url": "http://phoenix61862.ad2.fusionappsdphx1.oraclevcn.com:8080/castlemock/mock/rest/project/cTaQV3/application/WAKhnS/",
"listener-auth": {
"oidc-client-credentials": {
"client-id": "48eb39a9a7cb4bc0b7761ebb821ada97",
"client-secret": "ade2cdde-6c94-4be2-b525-29f575a9c3fc",
"identity-uri": "https://idcs-322c58839d80453186f91eb606042ad2.identity.oraclecloud.com/oauth2/v1/token",
"scope": "https://n6jfxzxt6schvqjkpge6uqfrum.apigateway.us-ashburn-1.oci.customer-oci.comurn:opc:resource:consumer::"
}
}
}
}
}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"affiliated-apis": [
{
"api-name": "party",
"api-id": "tmf-632",
"api-version": "v4",
"query": "(/eventType eq \"IndividualCreateEvent\" or /eventType eq \"IndividualDeleteEvent\" or /eventType eq \"IndividualAttributeValueChangeEvent\" or /eventType eq \"OrganizationDeleteEvent\" or /eventType eq \"OrganizationCreateEvent\" or /eventType eq \"OrganizationAttributeValueChangeEvent\")"
}
],
"listener-locality": {
"external-listener": {
"listener-url": "http://phoenix61862.ad2.fusionappsdphx1.oraclevcn.com:8080/castlemock/mock/rest/project/cTaQV3/application/WAKhnS/",
"listener-auth": {
"oidc-client-credentials": {
"identity-uri": "https://idcs-322c58839d80453186f91eb606042ad2.identity.oraclecloud.com/oauth2/v1/token",
"scope": "https://n6jfxzxt6schvqjkpge6uqfrum.apigateway.us-ashburn-1.oci.customer-oci.comurn:opc:resource:consumer::"
}
}
}
},
"id": "listener-registrationdrz88",
"type": "external"
}