Jump to

• Request
• Response
• Examples

Create an import package

post

/AgentWeb/api/elementmanager/import/EMPackages

Creates an Element Manger import package

Request

Header Parameters

• API_VERSION: string
  API VERSION for the header

  Default Value: 1

  Allowed Values: [ "1" ]
• USERSESSION(required): string
  Authentication token for the header

Body ()

Specify the name and base64 encoded string of the zip file to be imported

Root Schema : EMImportInfo

Type: object

Show Source

• attributes: object attributes
• importType: string
  Allowed Values: [ "PackageImport", "CustomImport" ]

  Default value, if not provided, will be PackageImport
• name(required): string
• packageContent(required): string
  For CustomImport of ObjectEventHandler, packageContent must be base64 encoded version of the required PHP file.

{
    "type":"object",
    "required":[
        "name",
        "packageContent"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "packageContent":{
            "type":"string",
            "description":"For CustomImport of ObjectEventHandler, packageContent must be base64 encoded version of the required PHP file."
        },
        "importType":{
            "type":"string",
            "enum":[
                "PackageImport",
                "CustomImport"
            ],
            "description":"Default value, if not provided, will be PackageImport"
        },
        "attributes":{
            "type":"object",
            "properties":{
                "customImportAttributes":{
                    "$ref":"#/definitions/EMCustomImportAttributes"
                }
            }
        }
    },
    "example":{
        "name":"<import-name>",
        "packageContent":"<zip-content-utf8>"
    }
}

Example:

{
    "name":"<import-name>",
    "packageContent":"<zip-content-utf8>"
}

Nested Schema : attributes

Type: object

Show Source

• customImportAttributes: object EMCustomImportAttributes

{
    "type":"object",
    "properties":{
        "customImportAttributes":{
            "$ref":"#/definitions/EMCustomImportAttributes"
        }
    }
}

Nested Schema : EMCustomImportAttributes

Type: object

Show Source

• addInAttributes: object EMAddInAttributes
• customScriptAttributes: object EMCustomScriptAttributes
• extensionAttributes: object EMExtensionAttributes
• folderPath: string
• itemName: string
• itemType(required): string
  Allowed Values: [ "BrowserExtension", "DesktopAddIn", "ObjectEventHandler", "CustomScript", "Report" ]

{
    "type":"object",
    "properties":{
        "itemName":{
            "type":"string"
        },
        "itemType":{
            "type":"string",
            "enum":[
                "BrowserExtension",
                "DesktopAddIn",
                "ObjectEventHandler",
                "CustomScript",
                "Report"
            ]
        },
        "folderPath":{
            "type":"string"
        },
        "extensionAttributes":{
            "$ref":"#/definitions/EMExtensionAttributes",
            "description":"The properties to be set for custom import of extensions"
        },
        "addInAttributes":{
            "$ref":"#/definitions/EMAddInAttributes",
            "description":"The properties to be set for custom import of custom Addins"
        },
        "customScriptAttributes":{
            "$ref":"#/definitions/EMCustomScriptAttributes",
            "description":"The properties to be set for custom import of custom scripts"
        }
    },
    "required":[
        "itemType"
    ]
}

Nested Schema : EMAddInAttributes

Type: object

Show Source

• notes: string

{
    "type":"object",
    "properties":{
        "notes":{
            "type":"string"
        }
    }
}

Nested Schema : EMCustomScriptAttributes

Type: object

Show Source

• phpVersion: string
  The PHP version to which the file is to be imported
• subFolderPath: string
  The folder path within custom folder, to which the file is to be imported.

{
    "type":"object",
    "properties":{
        "subFolderPath":{
            "type":"string",
            "description":"The folder path within custom folder, to which the file is to be imported."
        },
        "phpVersion":{
            "type":"string",
            "description":"The PHP version to which the file is to be imported"
        }
    }
}

Nested Schema : EMExtensionAttributes

Type: object

Show Source

• extensionConfigFile: string
• extensionInitFile(required): string
• extensionSchemaFiles: array extensionSchemaFiles
• extensionType(required): string
  Allowed Values: [ "Analytics", "Workspace", "Library", "Console" ]
• notes: string

{
    "type":"object",
    "properties":{
        "extensionType":{
            "type":"string",
            "enum":[
                "Analytics",
                "Workspace",
                "Library",
                "Console"
            ]
        },
        "extensionInitFile":{
            "type":"string"
        },
        "extensionConfigFile":{
            "type":"string"
        },
        "extensionSchemaFiles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "notes":{
            "type":"string"
        }
    },
    "required":[
        "extensionType",
        "extensionInitFile"
    ]
}

Nested Schema : extensionSchemaFiles

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Status of import

Body ()

Root Schema : EMStatus

Type: object

Show Source

• desc(required): string
• exception: object PublicApiExceptionResponse
• href(required): string
• id(required): integer(int64)
• items(required): array items
• name(required): string
• status(required): object EMPackageStatus
• statusId: integer
• type(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "href":{
            "type":"string"
        },
        "statusId":{
            "type":"integer"
        },
        "status":{
            "$ref":"#/definitions/EMPackageStatus"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMProcessedItem"
            }
        },
        "exception":{
            "$ref":"#/definitions/PublicApiExceptionResponse"
        }
    },
    "required":[
        "name",
        "type",
        "desc",
        "id",
        "href",
        "status",
        "items"
    ]
}

Nested Schema : PublicApiExceptionResponse

Type: object

Show Source

• className: string
• detail: string
• errorCode(required): integer
• href(required): string
• instance: string
• methodName: string
• status(required): integer
• title(required): integer(int64)
• type(required): string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"integer",
            "format":"int64"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer"
        },
        "href":{
            "type":"string"
        },
        "methodName":{
            "type":"string"
        },
        "className":{
            "type":"string"
        }
    },
    "required":[
        "title",
        "type",
        "status",
        "href",
        "errorCode"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object EMProcessedItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/EMProcessedItem"
    }
}

Nested Schema : EMPackageStatus

Type: object

Show Source

• code(required): integer
• description(required): string
• errorCode(required): string
  Error details of the item

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "errorCode":{
            "type":"string",
            "description":"Error details of the item"
        },
        "code":{
            "type":"integer"
        }
    },
    "required":[
        "description",
        "code",
        "errorCode"
    ]
}

Nested Schema : EMProcessedItem

Type: object

Show Source

• elementId(required): integer
• folderPath: string
• id(required): integer(int64)
• name(required): string
• stage(required): object EMCodeDescPair
• type(required): string
• validationError: object EMCodeDescPair

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "type":{
            "type":"string"
        },
        "stage":{
            "$ref":"#/definitions/EMCodeDescPair",
            "description":"Current status of the item"
        },
        "name":{
            "type":"string"
        },
        "elementId":{
            "type":"integer"
        },
        "folderPath":{
            "type":"string"
        },
        "validationError":{
            "$ref":"#/definitions/EMCodeDescPair",
            "description":"Error details of the item"
        }
    },
    "required":[
        "id",
        "type",
        "stage",
        "name",
        "elementId"
    ]
}

Nested Schema : EMCodeDescPair

Type: object

Show Source

• code(required): string
• description(required): string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "required":[
        "code",
        "description"
    ]
}

Back to Top

Examples

The following example shows how to initiate an import.

cURL Command Example

curl -X POST https://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages -H "USERSESSION: feihg98GnT7i" -H "API_VERSION: 1" -H "Content-Type: application/json" -d "{ \"name\": \"incident update\", \"packageContent\": \"package_converted_using_base64_encoder_tool\"}"

Request Body Example

The following shows an example of the request body in JSON format.

{
  "name": "incident update",
  "packageContent": "package_converted_using_base64_encoder_tool"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "description": "Prepare package for import",
    "id": 100015,
    "href": "http://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100015"
}

Back to Top