Jump to

• Request
• Response
• Examples

Get an import package status

get

/AgentWeb/api/elementmanager/import/EMPackages/{id}

Gets import package status given an id

Request

Path Parameters

• id(required): integer
  Specify the id of the package

Header Parameters

• API_VERSION: string
  API VERSION for the header

  Default Value: 1

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

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 get the status of an import.

cURL Command Example

curl -X GET https://mysite.example.com/AgentWeb/api/elementmanager/import/EMPackages/100010 -H "USERSESSION: feihg98GnT7i" -H "API_VERSION: 1" -H "Content-Type: application/json"

Response Body Example

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

{
    "description": "State of the import package",
    "id": 100010,
    "name": "Test import report",
    "status": {
        "code": "10",
        "description": "Import Complete"
    },
    "items": [
        {
            "id": 101257,
            "elementId": 38,
            "name": "ContactReportOpen",
            "type": "Report",
            "stage": {
                "code": "5",
                "description": "Artifact Live"
            },
            "folderPath": "AgentBrowser/ContactFilter"
        }
    ]
}

Back to Top