Jump to

• Request
• Response

Update Retry Profile

put

ss/oc-cnpolicy-configuration/v1/services/common/retryprofiles/{retryProfileName}

Request

Supported Media Types

• application/json

Path Parameters

• retryProfileName: string
  Retry Profile Name

Body ()

body

Root Schema : RetryProfiles

Type: object

Title: RetryProfiles

Show Source

• alternateRoutingSettings(optional): object AlternateRoutingSettings
  Title: AlternateRoutingSettings
• enableAlternateRouting(optional): boolean
• enableRetry(optional): boolean
• name(optional): string
• retrySettings(optional): object RetrySettings
  Title: RetrySettings

{
    "type":"object",
    "properties":{
        "alternateRoutingSettings":{
            "$ref":"#/definitions/AlternateRoutingSettings"
        },
        "enableAlternateRouting":{
            "type":"boolean"
        },
        "enableRetry":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "retrySettings":{
            "$ref":"#/definitions/RetrySettings"
        }
    },
    "title":"RetryProfiles"
}

Nested Schema : AlternateRoutingSettings

Type: object

Title: AlternateRoutingSettings

Show Source

• enableFallback(optional): boolean
• errorCodesList(optional): array errorCodesList
• maxNumOfAlternateRoutingAttempts(optional): integer(int32)
  enter a range in [1-10] number

  Example: 3
• retryFallbackAfterInterval(optional): integer(int32)
  Enter a range in [0-1440].

  Example: 3
• useAlternateSCPforAlternateRouting(optional): boolean

{
    "type":"object",
    "properties":{
        "enableFallback":{
            "type":"boolean"
        },
        "errorCodesList":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "maxNumOfAlternateRoutingAttempts":{
            "type":"integer",
            "format":"int32",
            "example":3,
            "description":"enter a range in [1-10] number"
        },
        "retryFallbackAfterInterval":{
            "type":"integer",
            "format":"int32",
            "example":3,
            "description":"Enter a range in [0-1440]."
        },
        "useAlternateSCPforAlternateRouting":{
            "type":"boolean"
        }
    },
    "title":"AlternateRoutingSettings"
}

Nested Schema : RetrySettings

Type: object

Title: RetrySettings

Show Source

• maximumNumberOfRetries(optional): integer(int32)
  enter a range in [1-10] number

  Example: 3

{
    "type":"object",
    "properties":{
        "maximumNumberOfRetries":{
            "type":"integer",
            "format":"int32",
            "example":3,
            "description":"enter a range in [1-10] number"
        }
    },
    "title":"RetrySettings"
}

Nested Schema : errorCodesList

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Update Retry Profile

Body ()

Root Schema : RetryProfiles

Type: object

Title: RetryProfiles

Show Source

• alternateRoutingSettings(optional): object AlternateRoutingSettings
  Title: AlternateRoutingSettings
• enableAlternateRouting(optional): boolean
• enableRetry(optional): boolean
• name(optional): string
• retrySettings(optional): object RetrySettings
  Title: RetrySettings

{
    "type":"object",
    "properties":{
        "alternateRoutingSettings":{
            "$ref":"#/definitions/AlternateRoutingSettings"
        },
        "enableAlternateRouting":{
            "type":"boolean"
        },
        "enableRetry":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "retrySettings":{
            "$ref":"#/definitions/RetrySettings"
        }
    },
    "title":"RetryProfiles"
}

Nested Schema : AlternateRoutingSettings

Type: object

Title: AlternateRoutingSettings

Show Source

• enableFallback(optional): boolean
• errorCodesList(optional): array errorCodesList
• maxNumOfAlternateRoutingAttempts(optional): integer(int32)
  enter a range in [1-10] number

  Example: 3
• retryFallbackAfterInterval(optional): integer(int32)
  Enter a range in [0-1440].

  Example: 3
• useAlternateSCPforAlternateRouting(optional): boolean

{
    "type":"object",
    "properties":{
        "enableFallback":{
            "type":"boolean"
        },
        "errorCodesList":{
            "type":"array",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "maxNumOfAlternateRoutingAttempts":{
            "type":"integer",
            "format":"int32",
            "example":3,
            "description":"enter a range in [1-10] number"
        },
        "retryFallbackAfterInterval":{
            "type":"integer",
            "format":"int32",
            "example":3,
            "description":"Enter a range in [0-1440]."
        },
        "useAlternateSCPforAlternateRouting":{
            "type":"boolean"
        }
    },
    "title":"AlternateRoutingSettings"
}

Nested Schema : RetrySettings

Type: object

Title: RetrySettings

Show Source

• maximumNumberOfRetries(optional): integer(int32)
  enter a range in [1-10] number

  Example: 3

{
    "type":"object",
    "properties":{
        "maximumNumberOfRetries":{
            "type":"integer",
            "format":"int32",
            "example":3,
            "description":"enter a range in [1-10] number"
        }
    },
    "title":"RetrySettings"
}

Nested Schema : errorCodesList

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

201 Response

Created

400 Response

Bad request

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

405 Response

Method Not Allowed

406 Response

Not Acceptable

408 Response

Request Timeout

409 Response

Conflict

412 Response

Precondition Failed

500 Response

Internal Server Error

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top