Jump to

• Request
• Response
• Examples

Create an export package

post

/AgentWeb/api/elementmanager/export/EMPackages

Creates an Element Manger export 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 ()

For new exports, specify the name and id of items to be exported. For excluding items from exported packages, specify export id and items to be deleted

Root Schema : EMPackage

Type: object

Show Source

• desc: string
• excludedItems: array excludedItems
  Array of items to be excluded in exclude request
• id: number
  Id of the item
• ignoreDependencies: boolean
  Set to true if package has to be exported without dependencies
• isExcludeItemsRequest: boolean
  Set to true if some items are to be removed. If set to true, specify the items to be excluded under excludedItems parameter
• items: array items
• name: string
  Name of the item to be exported (required for custom scripts)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the item to be exported (required for custom scripts)"
        },
        "id":{
            "type":"number",
            "description":"Id of the item"
        },
        "desc":{
            "type":"string"
        },
        "ignoreDependencies":{
            "type":"boolean",
            "description":"Set to true if package has to be exported without dependencies"
        },
        "isExcludeItemsRequest":{
            "type":"boolean",
            "description":"Set to true if some items are to be removed. If set to true, specify the items to be excluded under excludedItems parameter"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMItem"
            }
        },
        "excludedItems":{
            "type":"array",
            "description":"Array of items to be excluded in exclude request",
            "items":{
                "$ref":"#/definitions/ExcludedItem"
            }
        }
    },
    "required":[
    ],
    "example":{
        "name":"sample",
        "desc":"description",
        "items":[
            {
                "id":"0",
                "type":"Workspace"
            }
        ]
    }
}

Example:

{
    "name":"sample",
    "desc":"description",
    "items":[
        {
            "id":"0",
            "type":"Workspace"
        }
    ]
}

Nested Schema : excludedItems

Type: array

Array of items to be excluded in exclude request

Show Source

• Array of: object ExcludedItem

{
    "type":"array",
    "description":"Array of items to be excluded in exclude request",
    "items":{
        "$ref":"#/definitions/ExcludedItem"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object EMItem

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

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 : EMItem

Type: object

Show Source

• id: integer(int64)
• key: string
• name: string
• phpVersion: string
  The PHP version of the file
• subFolderPath: string
• type(required): string
  Allowed Values: [ "Report", "Workspace", "AddIn", "NavigationSet", "CustomObject", "SystemAttribute", "StandardText", "Variable", "ObjectEventHandler", "ConfigurationSetting", "MessageBase", "BusinessRule", "BusinessRuleVariable", "WorkspaceScript", "ExternalObject", "CustomScript" ]

{
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "subFolderPath":{
            "type":"string"
        },
        "phpVersion":{
            "type":"string",
            "description":"The PHP version of the file"
        },
        "type":{
            "type":"string",
            "enum":[
                "Report",
                "Workspace",
                "AddIn",
                "NavigationSet",
                "CustomObject",
                "SystemAttribute",
                "StandardText",
                "Variable",
                "ObjectEventHandler",
                "ConfigurationSetting",
                "MessageBase",
                "BusinessRule",
                "BusinessRuleVariable",
                "WorkspaceScript",
                "ExternalObject",
                "CustomScript"
            ]
        },
        "key":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Status of export

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 create an export package.

cURL Command Example

curl -X POST https://mysite.example.com/AgentWeb/api/elementmanager/export/EMPackages -H "USERSESSION: feihg98GnT7i" -H "API_VERSION: 1" -H "Content-Type: application/json" -d "{  \"name\": \"Test Em ext\", \"desc\": \"Export testing em extension\", \"items\": [ { \"id\": 101810, \"type\": \"Report\" } ] }"

Request Body Example

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

{
  "name": "Test Em ext",
  "desc": "Export testing em extension",
  "items": [
    {
      "id": 101810,
      "type": "Report"
    }
  ]
}

Response Body Example

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

{
    "description": "Prepare package for export",
    "id": 100012,
    "name": "Test Em ext",
    "status": {
        "code": "1",
        "description": "Export prepare start"
    },
    "href": "http://mysite.example.com/AgentWeb/api/elementmanager/export/EMPackages/100012"
}

Back to Top