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

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

Nested Schema : FppSeriesOptInDetails

Type: object

Opt-In details for FPP series

Match All

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 : 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"
        }
    }
}

Examples

Select an example Payload

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

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. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403 Response

Forbidden. The user is forbidden to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top