Jump to

• Request
• Response

Opt-In FPP Image Series

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/fppSeriesOptIn

Opt-in an FPP image series to be used for database maintenance activities from Enterprise Manager. Note- The FPP image series will be denoted as an image. The different images in this image series will show up as versions in Enterprise Manager.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match One Schema

Show Source

• object FppSeriesOptInDetails
  Opt-In details for FPP series
• object ExapatchOptInDetails
  Opt-In Details for Exapatch Series

{
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInDetails"
        },
        {
            "$ref":"#/components/schemas/ExapatchOptInDetails"
        }
    ]
}

Nested Schema : FppSeriesOptInDetails

Type: object

Opt-In details for FPP series

Match All

Opt-In details for FPP series

Show Source

• object FppSeriesOptInInputDetails
  FPP image series details

{
    "description":"Opt-In details for FPP series",
    "type":"object",
    "required":[
        "series"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInInputDetails"
        }
    ]
}

Nested Schema : ExapatchOptInDetails

Type: object

Opt-In Details for Exapatch Series

Match All

Opt-In Details for Exapatch Series

Show Source

• object ExapatchOptInInputDetails
  Exapatch Image Series details

{
    "description":"Opt-In Details for Exapatch Series",
    "type":"object",
    "required":[
        "series"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchOptInInputDetails"
        }
    ]
}

Nested Schema : FppSeriesOptInInputDetails

Type: object

FPP image series details

Show Source

• series: array series
  Array of the image series

{
    "type":"object",
    "description":"FPP image series details",
    "properties":{
        "series":{
            "description":"Array of the image series",
            "type":"array",
            "items":{
                "type":"object",
                "oneOf":[
                    {
                        "required":[
                            "seriesName",
                            "serverName"
                        ]
                    },
                    {
                        "required":[
                            "seriesId"
                        ]
                    }
                ],
                "properties":{
                    "seriesId":{
                        "type":"string",
                        "description":"ID of the FPP series"
                    },
                    "seriesName":{
                        "type":"string",
                        "description":"Name of the FPP series"
                    },
                    "serverName":{
                        "type":"string",
                        "description":"FPP server cluster name"
                    },
                    "currentVersionImageId":{
                        "type":"string",
                        "description":"ID of the image version to be marked as current"
                    }
                }
            }
        }
    }
}

Nested Schema : series

Type: array

Array of the image series

Show Source

• Array of: object items

{
    "description":"Array of the image series",
    "type":"array",
    "items":{
        "type":"object",
        "oneOf":[
            {
                "required":[
                    "seriesName",
                    "serverName"
                ]
            },
            {
                "required":[
                    "seriesId"
                ]
            }
        ],
        "properties":{
            "seriesId":{
                "type":"string",
                "description":"ID of the FPP series"
            },
            "seriesName":{
                "type":"string",
                "description":"Name of the FPP series"
            },
            "serverName":{
                "type":"string",
                "description":"FPP server cluster name"
            },
            "currentVersionImageId":{
                "type":"string",
                "description":"ID of the image version to be marked as current"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• currentVersionImageId: string
  ID of the image version to be marked as current
• seriesId: string
  ID of the FPP series
• seriesName: string
  Name of the FPP series
• serverName: string
  FPP server cluster name

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName"
            ]
        },
        {
            "required":[
                "seriesId"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"ID of the FPP series"
        },
        "seriesName":{
            "type":"string",
            "description":"Name of the FPP series"
        },
        "serverName":{
            "type":"string",
            "description":"FPP server cluster name"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"ID of the image version to be marked as current"
        }
    }
}

Match One Schema

Show Source

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName"
            ]
        },
        {
            "required":[
                "seriesId"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"ID of the FPP series"
        },
        "seriesName":{
            "type":"string",
            "description":"Name of the FPP series"
        },
        "serverName":{
            "type":"string",
            "description":"FPP server cluster name"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"ID of the image version to be marked as current"
        }
    }
}

Nested Schema : ExapatchOptInInputDetails

Type: object

Exapatch Image Series details

Show Source

• series: array series
  Array of Image Series

{
    "type":"object",
    "description":"Exapatch Image Series details",
    "properties":{
        "series":{
            "description":"Array of Image Series",
            "type":"array",
            "items":{
                "type":"object",
                "oneOf":[
                    {
                        "required":[
                            "seriesName",
                            "serverName",
                            "currentVersionImageId",
                            "targetType",
                            "imageFile"
                        ]
                    },
                    {
                        "required":[
                            "seriesId",
                            "currentVersionImageId",
                            "targetType",
                            "imageFile"
                        ]
                    }
                ],
                "properties":{
                    "seriesId":{
                        "type":"string",
                        "description":"seriesid",
                        "example":"E6C5858BD2B46B37E05380FE4564A69B"
                    },
                    "seriesName":{
                        "type":"string",
                        "description":"series name",
                        "example":"Exadata_DB_Series_1_12"
                    },
                    "serverName":{
                        "type":"string",
                        "description":"FPP Server Cluster name",
                        "example":"myFPPserver"
                    },
                    "currentVersionImageId":{
                        "type":"string",
                        "description":"VersionId to be marked as current",
                        "example":"E5B98897FE871AC1E05380FE4564F682"
                    },
                    "targetType":{
                        "type":"string",
                        "description":"targetType for given version",
                        "example":"host"
                    },
                    "imageFile":{
                        "type":"string",
                        "description":"Zip file name that contains the patch image.",
                        "example":"p34752810_191200_Linux-x86-64.zip"
                    },
                    "patchManagerLocation":{
                        "type":"string",
                        "description":"location needed for host target type",
                        "example":"p34752811_191200_Linux-x86-64.zip"
                    }
                }
            }
        }
    }
}

Nested Schema : series

Type: array

Array of Image Series

Show Source

• Array of: object items

{
    "description":"Array of Image Series",
    "type":"array",
    "items":{
        "type":"object",
        "oneOf":[
            {
                "required":[
                    "seriesName",
                    "serverName",
                    "currentVersionImageId",
                    "targetType",
                    "imageFile"
                ]
            },
            {
                "required":[
                    "seriesId",
                    "currentVersionImageId",
                    "targetType",
                    "imageFile"
                ]
            }
        ],
        "properties":{
            "seriesId":{
                "type":"string",
                "description":"seriesid",
                "example":"E6C5858BD2B46B37E05380FE4564A69B"
            },
            "seriesName":{
                "type":"string",
                "description":"series name",
                "example":"Exadata_DB_Series_1_12"
            },
            "serverName":{
                "type":"string",
                "description":"FPP Server Cluster name",
                "example":"myFPPserver"
            },
            "currentVersionImageId":{
                "type":"string",
                "description":"VersionId to be marked as current",
                "example":"E5B98897FE871AC1E05380FE4564F682"
            },
            "targetType":{
                "type":"string",
                "description":"targetType for given version",
                "example":"host"
            },
            "imageFile":{
                "type":"string",
                "description":"Zip file name that contains the patch image.",
                "example":"p34752810_191200_Linux-x86-64.zip"
            },
            "patchManagerLocation":{
                "type":"string",
                "description":"location needed for host target type",
                "example":"p34752811_191200_Linux-x86-64.zip"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• currentVersionImageId: string
  VersionId to be marked as current

  Example: E5B98897FE871AC1E05380FE4564F682
• imageFile: string
  Zip file name that contains the patch image.

  Example: p34752810_191200_Linux-x86-64.zip
• patchManagerLocation: string
  location needed for host target type

  Example: p34752811_191200_Linux-x86-64.zip
• seriesId: string
  seriesid

  Example: E6C5858BD2B46B37E05380FE4564A69B
• seriesName: string
  series name

  Example: Exadata_DB_Series_1_12
• serverName: string
  FPP Server Cluster name

  Example: myFPPserver
• targetType: string
  targetType for given version

  Example: host

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        },
        {
            "required":[
                "seriesId",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"seriesid",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "seriesName":{
            "type":"string",
            "description":"series name",
            "example":"Exadata_DB_Series_1_12"
        },
        "serverName":{
            "type":"string",
            "description":"FPP Server Cluster name",
            "example":"myFPPserver"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"VersionId to be marked as current",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "targetType":{
            "type":"string",
            "description":"targetType for given version",
            "example":"host"
        },
        "imageFile":{
            "type":"string",
            "description":"Zip file name that contains the patch image.",
            "example":"p34752810_191200_Linux-x86-64.zip"
        },
        "patchManagerLocation":{
            "type":"string",
            "description":"location needed for host target type",
            "example":"p34752811_191200_Linux-x86-64.zip"
        }
    }
}

Match One Schema

Show Source

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        },
        {
            "required":[
                "seriesId",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"seriesid",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "seriesName":{
            "type":"string",
            "description":"series name",
            "example":"Exadata_DB_Series_1_12"
        },
        "serverName":{
            "type":"string",
            "description":"FPP Server Cluster name",
            "example":"myFPPserver"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"VersionId to be marked as current",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "targetType":{
            "type":"string",
            "description":"targetType for given version",
            "example":"host"
        },
        "imageFile":{
            "type":"string",
            "description":"Zip file name that contains the patch image.",
            "example":"p34752810_191200_Linux-x86-64.zip"
        },
        "patchManagerLocation":{
            "type":"string",
            "description":"location needed for host target type",
            "example":"p34752811_191200_Linux-x86-64.zip"
        }
    }
}

Examples

Select an example Payload for Database and Grid Infrastructure Payload for Exadata Storage Payload for Exadata Switch Payload for Exadata Host

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. FPP image series Opt-In completed.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object allOf GoldImageFppSeriesOptIn
  FPP image series Opt-In response

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageFppSeriesOptIn"
        }
    ]
}

Nested Schema : GoldImageFppSeriesOptIn

Type: object

FPP image series Opt-In response

Match All

FPP image series Opt-In response

Show Source

• object FppSeriesOptInOptOutResult
  FPP image series Opt-In/Out result

{
    "description":"FPP image series Opt-In response",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInOptOutResult"
        }
    ]
}

Nested Schema : FppSeriesOptInOptOutResult

Type: object

FPP image series Opt-In/Out result

Show Source

• failed: integer
  Count of failed series
• items: array items
  List of items
• successful: integer
  Count of successful series
• total: integer
  Count of total series

{
    "description":"FPP image series Opt-In/Out result",
    "type":"object",
    "properties":{
        "failed":{
            "description":"Count of failed series",
            "type":"integer"
        },
        "successful":{
            "description":"Count of successful series",
            "type":"integer"
        },
        "total":{
            "description":"Count of total series",
            "type":"integer"
        },
        "items":{
            "description":"List of items",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FppSeriesOptInResultSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of items

Show Source

• Array of: object FppSeriesOptInResultSummary
  FPP image series Opt-In response

{
    "description":"List of items",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FppSeriesOptInResultSummary"
    }
}

Nested Schema : FppSeriesOptInResultSummary

Type: object

FPP image series Opt-In response

Show Source

• code: integer
  Series Opt-In HTTP status code
• message: string
  Opt-In message
• seriesId: string
  ID of the FPP series
• seriesName: string
  Name of the FPP series
• serverName: string
  FPP server cluster name

{
    "description":"FPP image series Opt-In response",
    "type":"object",
    "properties":{
        "code":{
            "description":"Series Opt-In HTTP status code",
            "type":"integer"
        },
        "seriesId":{
            "description":"ID of the FPP series",
            "type":"string"
        },
        "seriesName":{
            "description":"Name of the FPP series",
            "type":"string"
        },
        "serverName":{
            "description":"FPP server cluster name",
            "type":"string"
        },
        "message":{
            "description":"Opt-In message",
            "type":"string"
        }
    }
}

Examples

Select an example Payload

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top