SOAP API ListService, Complex Types
Complex Type: ArrayOfListDataModel
Description
A response collection of list data models.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
ListDataModel | ListDataModel | Yes | List data object used in alarms and log queries. |
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: ListDataModel
Description
List data object used in alarms and log queries.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
ListID | int | No | The unique ID of the list. |
ListName | string | Yes | The name of the list. |
ListGuid | guid | No | The list globally unique ID. |
ListTypeEnum | ListTypeEnum | No | The type of the list. |
ShortDescription | string | Yes | The short description of the list. |
LongDescription | string | Yes | The long description of the list. |
ReadPermissions | ReadWritePermissionEnum | No | The read permissions of the list. |
WritePermissions | ReadWritePermissionEnum | No | The write permissions of the list. |
IsRestrictedRead | boolean | No | If true, this instance is restricted read. |
RecordStatus | RecordStatusEnum | No | The record status of the list. |
UseContext | ListUseContextEnum | No | The use context of the list. |
DateUpdated | dateTime | No | The date updated of the list. This value is read only. |
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: PickListDataResults
Description
List object used for paging list of key value pairs.
Derived by
Restricting anyType
Content Model
Contains elements as defined in the following table.
Component | Type | Nillable? | Description |
|---|---|---|---|
List | ArrayOfKeyValuePairOfintstring | Yes | The key value (unique ID / name) list. |
HasMoreResults | boolean | No | If true, there are more pages in the query result set. |
NextPageID | string | Yes | The unique ID of the next page in this query result set. |
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. |
Warnings | ArrayOfstring | Yes | The tabular warning object of all warnings associated with this save result. |