Jump to

• Request
• Response

Import Plugins

post

/rest/ofscMetadata/v1/plugins/custom-actions/import

This operation imports all plugins defined in a valid pluginFile input xml [all the plugin properties should be installed before invoking this API]. If a plugin with the given label is available, then it updates the existing plugin otherwise it will create a new plugin. If there are secure parameters that also needs to be filled in the xml.

The valid versions of installable plugins are available in https://www-sites.oracle.com/downloads/samplecode/ofsc-samplecode-downloads.html

Note: The maximum size of the file that can be uploaded is limited to 67 MB, this limit depends on the Oracle Field Service environment configuration.

Configuration: You must grant permissions to the Metadata API and must set Read-Write access to the Plugins entity in the Configuration, Applications (API permissions) screen.

Request

Supported Media Types

• multipart/form-data

Form Parameters

• pluginFile(required): file
  A valid input plugin xml.

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.

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