Jump to

• Request
• Response
• Examples

Import or rollback a package

patch

/AgentWeb/api/elementmanager/import/EMPackages

Imports or rollbacks an Element Manager 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 action and id

Root Schema : EMImportPatchInfo

Type: object

Show Source

• action(required): string
  Allowed Values: [ "import", "rollback", "resume" ]
• enabledBusinessRules: array enabledBusinessRules
  If the attribute is present, only the business rules with the specified element ids will be enabled in edit mode after import. If not present, package defaults shall be applied.
• excludedItems: array excludedItems
• id(required): string
• isExcludeItemsRequest: boolean
  Set this to true if some items are to be removed. If set to true, specify the items to be excluded under excludedItems parameter
• overrideLock: boolean
  Set this to true if lock has to be overridden by default for items involving editor locks, if the lock has been acquired by another user
• permissions: array permissions
  Permission values for items
• skipCustomObjectDeployment: boolean
  Set this to true if deployment of custom objects is to be skipped (applicable only if all objects/attributes pre-exists in target)

{
    "type":"object",
    "required":[
        "id",
        "action"
    ],
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "import",
                "rollback",
                "resume"
            ]
        },
        "id":{
            "type":"string"
        },
        "overrideLock":{
            "type":"boolean",
            "description":"Set this to true if lock has to be overridden by default for items involving editor locks, if the lock has been acquired by another user"
        },
        "skipCustomObjectDeployment":{
            "type":"boolean",
            "description":"Set this to true if deployment of custom objects is to be skipped (applicable only if all objects/attributes pre-exists in target)"
        },
        "permissions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMPermissions"
            },
            "description":"Permission values for items"
        },
        "enabledBusinessRules":{
            "description":"If the attribute is present, only the business rules with the specified element ids will be enabled in edit mode after import. If not present, package defaults shall be applied.",
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "isExcludeItemsRequest":{
            "type":"boolean",
            "description":"Set this to true if some items are to be removed. If set to true, specify the items to be excluded under excludedItems parameter"
        },
        "excludedItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExcludedItem"
            }
        }
    },
    "example":{
        "action":"import/rollback",
        "id":"import-id",
        "permissions":[
            {
                "elementIds":[
                    "576"
                ],
                "profilePermissions":[
                    {
                        "profileIds":[
                            "205"
                        ],
                        "interfaceIds":[
                            "1",
                            "2"
                        ]
                    }
                ]
            },
            {
                "elementIds":[
                    "577",
                    "450"
                ],
                "profilePermissions":[
                    {
                        "profileIds":[
                            "205",
                            "206"
                        ],
                        "permission":"edit"
                    }
                ]
            },
            {
                "elementIds":[
                    "578"
                ],
                "interfacePermission":[
                    "1",
                    "2"
                ]
            }
        ],
        "enabledBusinessRules":[
            "100003",
            "100004"
        ]
    }
}

Example:

{
    "action":"import/rollback",
    "id":"import-id",
    "permissions":[
        {
            "elementIds":[
                "576"
            ],
            "profilePermissions":[
                {
                    "profileIds":[
                        "205"
                    ],
                    "interfaceIds":[
                        "1",
                        "2"
                    ]
                }
            ]
        },
        {
            "elementIds":[
                "577",
                "450"
            ],
            "profilePermissions":[
                {
                    "profileIds":[
                        "205",
                        "206"
                    ],
                    "permission":"edit"
                }
            ]
        },
        {
            "elementIds":[
                "578"
            ],
            "interfacePermission":[
                "1",
                "2"
            ]
        }
    ],
    "enabledBusinessRules":[
        "100003",
        "100004"
    ]
}

Nested Schema : enabledBusinessRules

Type: array

If the attribute is present, only the business rules with the specified element ids will be enabled in edit mode after import. If not present, package defaults shall be applied.

Show Source

• Array of: integer

{
    "description":"If the attribute is present, only the business rules with the specified element ids will be enabled in edit mode after import. If not present, package defaults shall be applied.",
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : excludedItems

Type: array

Show Source

• Array of: object ExcludedItem

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

Nested Schema : permissions

Type: array

Permission values for items

Show Source

• Array of: object EMPermissions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/EMPermissions"
    },
    "description":"Permission values for items"
}

Nested Schema : ExcludedItem

Type: object

Show Source

• id(required): integer(int64)
  Id of the item to be removed, obtained from the GET package status API
• key: string
• type(required): string
  Allowed Values: [ "Report", "Workspace", "DesktopAddIn", "BrowserExtension", "NavigationSet", "CustomObject", "SystemAttribute", "StandardText", "Variable", "ObjectEventHandler", "ConfigurationSetting", "MessageBase", "BusinessRule", "BusinessRuleVariable", "WorkspaceScript", "ExternalObject", "Image", "WorkflowImage", "CustomScript" ]

{
    "type":"object",
    "required":[
        "id",
        "type"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Id of the item to be removed, obtained from the GET package status API"
        },
        "type":{
            "type":"string",
            "enum":[
                "Report",
                "Workspace",
                "DesktopAddIn",
                "BrowserExtension",
                "NavigationSet",
                "CustomObject",
                "SystemAttribute",
                "StandardText",
                "Variable",
                "ObjectEventHandler",
                "ConfigurationSetting",
                "MessageBase",
                "BusinessRule",
                "BusinessRuleVariable",
                "WorkspaceScript",
                "ExternalObject",
                "Image",
                "WorkflowImage",
                "CustomScript"
            ]
        },
        "key":{
            "type":"string"
        }
    }
}

Nested Schema : EMPermissions

Type: object

Show Source

• elementIds(required): array elementIds
• interfacePermission: array interfacePermission
• profilePermission(required): array profilePermission

{
    "type":"object",
    "required":[
        "elementIds",
        "profilePermission"
    ],
    "properties":{
        "elementIds":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "profilePermission":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMProfilePermissions"
            }
        },
        "interfacePermission":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        }
    }
}

Nested Schema : elementIds

Type: array

Show Source

• Array of: integer

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

Nested Schema : interfacePermission

Type: array

Show Source

• Array of: integer

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

Nested Schema : profilePermission

Type: array

Show Source

• Array of: object EMProfilePermissions

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

Nested Schema : EMProfilePermissions

Type: object

Show Source

• interfaceIds: array interfaceIds
• permission: object EMPermission
• profileIds(required): array profileIds

{
    "type":"object",
    "required":[
        "profileIds"
    ],
    "properties":{
        "profileIds":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "permission":{
            "$ref":"#/definitions/EMPermission"
        },
        "interfaceIds":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        }
    }
}

Nested Schema : interfaceIds

Type: array

Show Source

• Array of: integer

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

Nested Schema : EMPermission

Type: object

Show Source

• permission: string
  Allowed Values: [ "open", "edit" ]

{
    "type":"object",
    "properties":{
        "permission":{
            "type":"string",
            "enum":[
                "open",
                "edit"
            ]
        }
    },
    "required":[
        "code",
        "description"
    ]
}

Nested Schema : profileIds

Type: array

Show Source

• Array of: integer

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

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 import a package.

cURL Command Example

curl -X PATCH https://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages -H "USERSESSION: feihg98GnT7i" -H "API_VERSION: 1" -H "Content-Type: application/json" -d "{ \"action\": \"import\", \"id\": \"100015\" }"

Request Body Example

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

{
  "action": "import",
  "id": "100015"
}

Response Body Example

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

{
    "description": "Import the package",
    "id": 100015,
    "name": "incident update",
    "href": "http://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100015"
}

Back to Top