SOAP API HostService, Complex Types
Complex Type: ArrayOfHostDataModel
Description
A response collection of host data models.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
HostDataModel | HostDataModel | Yes | Host response model. |
Complex Type: ErrorInfo
Description
Error details model.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
ErrorID | int | No | The unique ID of the error details. |
Details | string | Yes | The error details for this instance of the error. |
ErrorMessage | string | Yes | The error message of the error. |
Complex Type: HostDataModel
Description
Host response model.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
HostID | int | No | The unique ID of the host object. |
EntityID | int | No | The unique ID of the entity object. |
HostName | string | Yes | The name of the host. |
Identifiers | ArrayOfHostIdentifierDataModel | Yes | A list of the host identifiers associated of the host. |
ShortDescription | string | Yes | The short description of the host. |
LongDescription | string | Yes | The long description of the host. |
RecordStatus | RecordStatusEnum | No | The record status of the host. |
DateUpdated | dateTime | No | The last update date of the host. This value is read only. |
RiskThreshold | RiskLevelEnum | No | The risk threshold of the host. |
OSType | HostOSEnum | No | The type of the host OS. |
OSVersion | string | Yes | The host OS version. |
Complex Type: HostIdentifierDataModel
Description
Host identifier response model.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
HostIdentifierID | int | No | The unique ID of the host identifier object. |
HostID | int | No | The unique ID of the associated host object. |
IdentifierType | HostIdentifierTypeEnum | No | The type of the identifier. |
IdentifierValue | string | Yes | The identifier value. |
Complex Type: LogRhythmWebServiceFault
Description
This is the error message object for all of LogRhythm Web Services. This object provides custom meaningful error messages to the client while retaining security precautions for the system.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
FaultID | guid | No | The unique ID for the fault object. |
Details | string | Yes | The fault details. |
FaultTime | dateTime | No | The time the fault instance occurred. |
ErrorID | int | No | The unique ID of the error object. |
Complex Type: SaveResult
Description
A response object which supplies information about an attempt to insert data. This information includes record ID if created and error / warning messages if generated.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
Succeeded | boolean | No | A flag indicating whether the update succeeded or failed. |
DataID | long | No | The unique ID of the data artifact which were updated. |
Errors | ArrayOfErrorInfo | Yes | The tabular errors object of all errors associated to this save result. |
| Key | int | No | A unique key created by the caller that is returned in the response for matching the response with the request. |
Warnings | ArrayOfstring | Yes | The tabular warning object of all warnings associated with this save result. |