Jump to

• Request
• Response
• Examples

Update a listener registration

patch

/admin/listenerRegistrations/{id}

Request

Path Parameters

• id(required): string
  The id of the Listener Registration to be updated

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object PatchDocument
  A JSONPatch document as defined by RFC 6902

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PatchDocument"
    }
}

Nested Schema : PatchDocument

Type: object

A JSONPatch document as defined by RFC 6902

Show Source

• from: string
  A string containing a JSON Pointer value.
• op(required): string
  Allowed Values: [ "add", "remove", "replace", "move", "copy", "test" ]

  The operation to be performed
• path(required): string
  A JSON-Pointer
• value: object value
  The value to be used within the operations.

{
    "description":"A JSONPatch document as defined by RFC 6902",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "description":"The operation to be performed",
            "enum":[
                "add",
                "remove",
                "replace",
                "move",
                "copy",
                "test"
            ]
        },
        "path":{
            "type":"string",
            "description":"A JSON-Pointer"
        },
        "value":{
            "type":"object",
            "description":"The value to be used within the operations."
        },
        "from":{
            "type":"string",
            "description":"A string containing a JSON Pointer value."
        }
    }
}

Nested Schema : value

Type: object

The value to be used within the operations.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: object

Show Source

• affiliated-apis: array affiliated-apis
• listener-locality: object Listener-locality
• type: string

{
    "type":"object",
    "properties":{
        "affiliated-apis":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Affiliated-api"
            }
        },
        "listener-locality":{
            "$ref":"#/components/schemas/Listener-locality"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : affiliated-apis

Type: array

Show Source

• Array of: object Affiliated-api

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Affiliated-api"
    }
}

Nested Schema : Listener-locality

Type: object

Show Source

• external-listener: object External-listener

{
    "type":"object",
    "properties":{
        "external-listener":{
            "$ref":"#/components/schemas/External-listener"
        }
    }
}

Nested Schema : Affiliated-api

Type: object

Show Source

• api-id: string
• api-name: string
• api-version: string
• query: string

{
    "type":"object",
    "properties":{
        "api-name":{
            "type":"string"
        },
        "api-id":{
            "type":"string"
        },
        "api-version":{
            "type":"string"
        },
        "query":{
            "type":"string"
        }
    }
}

Nested Schema : External-listener

Type: object

Show Source

• event-url-prefix: string
• listener-auth: object Listener-auth
• listener-url: string
• system-name: string
• ttd-name: string

{
    "type":"object",
    "properties":{
        "listener-url":{
            "type":"string"
        },
        "ttd-name":{
            "type":"string"
        },
        "system-name":{
            "type":"string"
        },
        "event-url-prefix":{
            "type":"string"
        },
        "listener-auth":{
            "$ref":"#/components/schemas/Listener-auth"
        }
    }
}

Nested Schema : Listener-auth

Type: object

Show Source

• basic: object Basic-credentials
• oidc-client-credentials: object oidc-client-credentials

{
    "type":"object",
    "properties":{
        "oidc-client-credentials":{
            "type":"object",
            "properties":{
                "identity-uri":{
                    "type":"string"
                },
                "client-id":{
                    "type":"string"
                },
                "client-secret":{
                    "type":"string"
                },
                "scope":{
                    "type":"string"
                },
                "oidc-auth-server-audience":{
                    "type":"string"
                }
            }
        },
        "basic":{
            "$ref":"#/components/schemas/Basic-credentials"
        }
    }
}

Nested Schema : Basic-credentials

Type: object

Show Source

• password: object password
• username: object username

{
    "type":"object",
    "properties":{
        "username":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PasswordUserName"
            }
        },
        "password":{
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/PasswordUserName"
            }
        }
    }
}

Nested Schema : oidc-client-credentials

Type: object

Show Source

• client-id: string
• client-secret: string
• identity-uri: string
• oidc-auth-server-audience: string
• scope: string

{
    "type":"object",
    "properties":{
        "identity-uri":{
            "type":"string"
        },
        "client-id":{
            "type":"string"
        },
        "client-secret":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "oidc-auth-server-audience":{
            "type":"string"
        }
    }
}

Nested Schema : password

Type: object

Show Source

• Array of: object PasswordUserName

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PasswordUserName"
    }
}

Nested Schema : username

Type: object

Show Source

• Array of: object PasswordUserName

{
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/PasswordUserName"
    }
}

Nested Schema : PasswordUserName

Type: object

Show Source

• secret-key: string
• secret-name: string

{
    "type":"object",
    "properties":{
        "secret-name":{
            "type":"string"
        },
        "secret-key":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Body ()

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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Body ()

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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Body ()

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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

409 Response

Conflict

Body ()

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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Body ()

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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to update a listener registration by submitting a patch request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X PATCH https://{FABRIC_HOST}/admin/listenerRegistrations/{id} -H "Content-Type: application/json" -D @update_listenerregistration.json| json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

 [
  {
    "op": "replace",
    "path": "/listener-locality/external-listener/listener-url",
    "value": "http://cgbu-idc-dev14.ad1.fusionappsdephx.oraclevcn.com:9002/"
  }
]

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://cgbu-idc-dev14.ad1.fusionappsdephx.oraclevcn.com:9002/",
            "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"
}

Back to Top