REST API for Element Manager in B2C Service

Search items for export

post

/AgentWeb/api/elementmanager/search/EMElements

Gives list of filtered items

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

Specify the parameters on items to be searched

Root Schema : EMSearchParam

Type: object

Show Source

filter: object EMFilter
limit: integer
rulePath: string
searchString: string

Full or part of the name of the item to be searched for
searchTypes: array searchTypes

Type of the item to be searched
startingIndex: integer
updatedTime: object EMFilter

{
    "type":"object",
    "properties":{
        "searchString":{
            "type":"string",
            "description":"Full or part of the name of the item to be searched for"
        },
        "searchTypes":{
            "type":"array",
            "description":"Type of the item to be searched",
            "items":{
                "$ref":"#/definitions/EMSearchType"
            }
        },
        "limit":{
            "type":"integer"
        },
        "startingIndex":{
            "type":"integer"
        },
        "filter":{
            "$ref":"#/definitions/EMFilter"
        },
        "updatedTime":{
            "$ref":"#/definitions/EMFilter"
        },
        "rulePath":{
            "type":"string"
        }
    },
    "example":{
        "limit":100,
        "searchTypes":[
            "Report",
            "Workspace",
            "BusinessRule"
        ],
        "searchString":"%",
        "startingIndex":0,
        "filter":{
            "filterOperator":"and",
            "children":[
                {
                    "filterOperator":"none",
                    "filterTerm":{
                        "name":"ParentId",
                        "condition":"isEqual",
                        "value":100485
                    }
                },
                {
                    "filterOperator":"none",
                    "filterTerm":{
                        "name":"Id",
                        "condition":"isGreater",
                        "value":101435
                    }
                }
            ]
        },
        "updatedTime":{
            "filterOperator":"between",
            "children":[
                {
                    "filterOperator":"none",
                    "filterTerm":{
                        "name":"updatedTime",
                        "value":"2021-02-01T00:00:00.000Z"
                    }
                },
                {
                    "filterOperator":"none",
                    "filterTerm":{
                        "name":"updatedTime",
                        "value":"2021-06-02T00:00:00.000Z"
                    }
                }
            ]
        },
        "rulePath":"Incident/States/%"
    }
}

Example:

{
    "limit":100,
    "searchTypes":[
        "Report",
        "Workspace",
        "BusinessRule"
    ],
    "searchString":"%",
    "startingIndex":0,
    "filter":{
        "filterOperator":"and",
        "children":[
            {
                "filterOperator":"none",
                "filterTerm":{
                    "name":"ParentId",
                    "condition":"isEqual",
                    "value":100485
                }
            },
            {
                "filterOperator":"none",
                "filterTerm":{
                    "name":"Id",
                    "condition":"isGreater",
                    "value":101435
                }
            }
        ]
    },
    "updatedTime":{
        "filterOperator":"between",
        "children":[
            {
                "filterOperator":"none",
                "filterTerm":{
                    "name":"updatedTime",
                    "value":"2021-02-01T00:00:00.000Z"
                }
            },
            {
                "filterOperator":"none",
                "filterTerm":{
                    "name":"updatedTime",
                    "value":"2021-06-02T00:00:00.000Z"
                }
            }
        ]
    },
    "rulePath":"Incident/States/%"
}

Nested Schema : EMFilter

Type: object

Show Source

children: array children
filterOperator(required): string

Allowed Values: [ "and", "or", "none", "between", "lessThan", "greaterThan" ]
filterTerm: object EMFilterTerm

{
    "type":"object",
    "properties":{
        "filterOperator":{
            "type":"string",
            "enum":[
                "and",
                "or",
                "none",
                "between",
                "lessThan",
                "greaterThan"
            ]
        },
        "filterTerm":{
            "$ref":"#/definitions/EMFilterTerm"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMFilter"
            }
        }
    },
    "required":[
        "filterOperator"
    ]
}

Nested Schema : searchTypes

Type: array

Type of the item to be searched

Show Source

Array of: string

Allowed Values: [ "Report", "Workspace", "Profile", "Interface", "AddIn", "NavigationSet", "CustomObject", "SystemAttribute", "StandardText", "Variable", "ObjectEventHandler", "WorkspaceScript", "ExternalObject", "CustomScript", "CustomizableMenu", "Product", "Category", "Disposition", "CustomBusinessEvent" ]

{
    "type":"array",
    "description":"Type of the item to be searched",
    "items":{
        "$ref":"#/definitions/EMSearchType"
    }
}

Nested Schema : children

Type: array

Show Source

Array of: object EMFilter

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

Nested Schema : EMFilterTerm

Type: object

Show Source

condition(required): string

Allowed Values: [ "isNotNull", "isNull", "isEqual", "isNotEqual", "isIn", "isNotIn", "between", "greaterThan", "lessThan" ]
name(required): string

Allowed Values: [ "Id", "ParentId", "label", "typeId" ]
value(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "Id",
                "ParentId",
                "label",
                "typeId"
            ]
        },
        "condition":{
            "type":"string",
            "enum":[
                "isNotNull",
                "isNull",
                "isEqual",
                "isNotEqual",
                "isIn",
                "isNotIn",
                "between",
                "greaterThan",
                "lessThan"
            ]
        },
        "value":{
            "type":"string"
        }
    },
    "required":[
        "name",
        "condition",
        "value"
    ]
}

Response

Supported Media Types

application/json

200 Response

Search results of items to be exported

Root Schema : EMSearchResult

Type: object

Show Source

resultSet(required): array resultSet

{
    "type":"object",
    "properties":{
        "resultSet":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMResultSet"
            }
        }
    },
    "required":[
        "resultSet"
    ]
}

Nested Schema : resultSet

Type: array

Show Source

Array of: object EMResultSet

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

Nested Schema : EMResultSet

Type: object

Show Source

items(required): array items
type(required): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMSearchResultItem"
            }
        }
    },
    "required":[
        "type",
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object EMSearchResultItem

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

Nested Schema : EMSearchResultItem

Type: object

Show Source

children(required): array children
hasMoreChildren(required): boolean
id(required): integer
isParent(required): boolean
level(required): integer
name(required): string
type(required): object EMIdNamePair

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "type":{
            "$ref":"#/definitions/EMIdNamePair"
        },
        "name":{
            "type":"string"
        },
        "level":{
            "type":"integer"
        },
        "isParent":{
            "type":"boolean"
        },
        "hasMoreChildren":{
            "type":"boolean"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EMSearchResultItem"
            }
        }
    },
    "required":[
        "id",
        "type",
        "name",
        "level",
        "isParent",
        "hasMoreChildren",
        "children"
    ]
}

Nested Schema : children

Type: array

Show Source

Array of: object EMSearchResultItem

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

Nested Schema : EMIdNamePair

Type: object

Show Source

id: integer
name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        }
    }
}

Examples

The following example shows how to search for EM packages using the searchString parameter.

cURL Command Example

curl -X POST https://mysite.example.com/AgentWeb/api/elementmanager/search/EMElements -H "USERSESSION: feihg98GnT7i" -H "API_VERSION: 1" -H "Content-Type: application/json" -d "{ \"limit\": 10, \"searchString\": \"AutomationServerAddIn\", \"startingIndex\": 0 }"

Request Body Example

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

{
  "limit": 10,
  "searchString": "AutomationServerAddIn",
  "startingIndex": 0
}

Response Body Example

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

{
    "description": "Search results",
    "resultSet": [
        {
            "type": "AddIn",
            "hasMoreItems": false,
            "items": [
                {
                    "id": 100000,
                    "type": {
                        "id": 271,
                        "name": "AddIn"
                    },
                    "name": "Agent Desktop Add-Ins",
                    "level": 1,
                    "hasMoreChildren": true,
                    "sequence": 0,
                    "children": [
                        {
                            "id": 3,
                            "type": {
                                "id": 0,
                                "name": "DesktopAddIn"
                            },
                            "name": "AutomationServerAddIn.zip",
                            "level": 2,
                            "hasMoreChildren": false,
                            "sequence": 2,
                            "children": [],
                            "isParent": false
                        }
                    ],
                    "isParent": true
                }
            ]
        }
    ]
}