Jump to

• Request
• Response

Modify MDC Session control parameters

post

/oam/services/rest/mdc/dc/mode

Request

Supported Media Types

• application/json

Body ()

MDC session control paramters in JSON format

Root Schema : mdcSessionControlParameters

Type: object

{"config":{"entry":[{"key":"SessionMustBeAnchoredToDataCenterServicingUser","value":true (Invalidate) or false (No Invalidation)},{"key":"SessionDataRetrievalOnDemand","value":true (Cross DC Retrieval) or false (No Cross DC Retrieval)},{"key":"SessionContinuationOnSyncFailure","value":true (Invalidation/Retrieval should succeed) or false (Ignore failure)},{"key":"Reauthenticate","value":true (Force Reauthentication) or false (No Reauthentication)},{"key":"SessionDataRetrievalOnDemandMax_retry_attempts","value":Value equal to the binary that represents the number of times to retry data retrieval if it fails. DEFAULT: 2},{"key":"SessionDataRetrievalOnDemandMax_conn_wait_time","value":value equal to the binary that represents the total amount of time in seconds to wait for a connection. DEFAULT: 1000}, {"key":"MDCGitoCookieDomain","value":Domain in which OAM_GITO cookie should be set. OPTIONAL: To be set in MDC Deployments where a common domain hierarchy can be derived}]}}

Show Source

• config(optional): object config

{
    "type":"object",
    "properties":{
        "config":{
            "type":"object",
            "properties":{
                "entry":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "key":{
                                "type":"string"
                            },
                            "value":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    },
    "description":"{\"config\":{\"entry\":[{\"key\":\"SessionMustBeAnchoredToDataCenterServicingUser\",\"value\":true (Invalidate) or false (No Invalidation)},{\"key\":\"SessionDataRetrievalOnDemand\",\"value\":true (Cross DC Retrieval) or false (No Cross DC Retrieval)},{\"key\":\"SessionContinuationOnSyncFailure\",\"value\":true (Invalidation/Retrieval should succeed) or false (Ignore failure)},{\"key\":\"Reauthenticate\",\"value\":true (Force Reauthentication) or false (No Reauthentication)},{\"key\":\"SessionDataRetrievalOnDemandMax_retry_attempts\",\"value\":Value equal to the binary that represents the number of times to retry data retrieval if it fails. DEFAULT: 2},{\"key\":\"SessionDataRetrievalOnDemandMax_conn_wait_time\",\"value\":value equal to the binary that represents the total amount of time in seconds to wait for a connection. DEFAULT: 1000}, {\"key\":\"MDCGitoCookieDomain\",\"value\":Domain in which OAM_GITO cookie should be set. OPTIONAL: To be set in MDC Deployments where a common domain hierarchy can be derived}]}}"
}

Nested Schema : config

Type: object

Show Source

• entry(optional): array entry

{
    "type":"object",
    "properties":{
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string"
                    },
                    "value":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "key":{
                "type":"string"
            },
            "value":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

400 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

401 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

500 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

504 Response

Error

Body ()

Root Schema : errorresponse

Type: object

Show Source

• errorCode(optional): string
• errorDesc(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorDesc":{
            "type":"string"
        }
    }
}

Back to Top