Jump to

• Request
• Response

Install Standard Plugin

post

/rest/ofscMetadata/v1/plugins/{pluginLabel}/custom-actions/install

This operation installs the standard plugins as defined in the path parameter. If a plugin with the given label is available, then it will return "Plugin already existing" error message, otherwise the plugin will get installed successfully.

Request

Path Parameters

• pluginLabel(required): string
  The label of the standard plugin.

Back to Top

Response

Supported Media Types

• application/json

204 Response

This section describes the 204 status response for this operation. This response code indicates that the operation completed successfully. This operation does not return elements in the response body.

404 Response

This section describes the 404 status response for this operation. This response code indicates that the standard plugin with the provided label is not found.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

409 Response

This section describes the 409 status response for this operation. This response code indicates that the operation failed due to a conflict.

The conflict can be of the following types:

Error Code	Reason
LABEL_NOT_UNIQUE	A plugin with the same label is already installed
OLDER_PRODUCT_VERSION	The platform version is less than the required version
EXISTING_PROPERTY_TYPE_MISMATCH	Property that the plugin requires is already existing with a different type
INVALID_PROPERTY	Plugin has invalid property

Body ()

Root Schema : ErrorWithResponseCode

Type: object

Show Source

• detail(required): string
  The detailed description of this error.
• o:errorCode(required): string
  Application error code, which is different from HTTP error code.
• status(required): string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        }
    },
    "required":[
        "type",
        "title",
        "status",
        "detail",
        "o:errorCode"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top