• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Estrelica
    • Core
    • CoreConfig
    • CoreConfig.Settings
  • Estrelica.Archer.AccessControl
    • AccessControlEdit
    • AccountStatus
    • ContactSubType
    • ContactType
    • IArcherGroup
    • IArcherGroupEdit
    • IArcherRole
    • IArcherRoleEdit
    • IArcherUser
    • IArcherUserEdit
    • ISecurityParameter
    • IUserContact
    • IUserProvider
    • UserType
  • Estrelica.Archer.Content
    • ArcherContentExtensions
    • ContentFilterHelper
    • ContentReportOptions
    • ContentSearchOptions
    • ContentSource
    • ContentType
    • CurrentDateOperator
    • DatafeedHistoryStatus
    • DatafeedStatus
    • DatafeedType
    • DateOffsetOperator
    • DateValueOperator
    • DisplayFieldExtensions
    • EqualityOperator
    • FieldHistoryAuditType
    • HistoryAuditType
    • IAdvancedWorkflowAudit
    • IArcherContent
    • IArcherContentAccess
    • IArcherContentEdit
    • IArcherContentIdQuery
    • IArcherDateFieldQuery
    • IArcherDocument
    • IArcherMembershipQuery<T>
    • IArcherNumericFieldQuery
    • IArcherRecord
    • IArcherRecordQuery
    • IArcherReport
    • IArcherTextFieldQuery
    • IArcherUserGroupFieldQuery
    • IArcherValuesListQuery
    • IContentHistory
    • IContentInformation
    • IContentReport
    • IContentReportOptions
    • IContentUpdateInformation
    • ICrossReferencedRecordsSelectionEdit
    • IDatafeed
    • IDatafeedHistory
    • IDatafeedHistoryMessage
    • IDatafeedRecordCount
    • IDateValueEdit
    • IDisplayField
    • IDocumentSelectionEdit
    • IEditableField
    • IExternalLink
    • IExternalLinkEdit
    • IExternalLinksSelectionEdit
    • IFieldAudit
    • IFieldHistory
    • IFieldHistoryEx
    • IFieldQuery
    • IFieldValueEdit<T>
    • IHistoryAudit
    • INumericValueEdit
    • IObjectValue
    • IReferencedRecordsSelection
    • IReferencedRecordsSelectionEdit
    • ISearchDisplayFieldOptions
    • ISearchOptions
    • ISignatureAudit
    • IStatisticsReport
    • ISubEditableField
    • ISystemUpdateInformation
    • ITextValueEdit
    • IUserGroupListSelection
    • IUserGroupListSelectionEdit
    • IValuesListBaseSelection
    • IValuesListBaseSelectionEdit
    • IValuesListSelection
    • IValuesListSelectionEdit
    • IValuesListSingleSelection
    • IValuesListSingleSelectionEdit
    • IWorkflowAction
    • IWorkflowNode
    • LastUpdatedPreference
    • NumericRangeOperator
    • RecordCountType
    • RecordStatus
    • ReportSource
    • SortField
    • SortType
    • ValueOperator
    • ValuesOperator
    • WorkflowAuditActionType
  • Estrelica.Archer.Entity
    • ArcherEntityExtensions
    • ASOStatus
    • EntityType
    • IArcherAliasableEntity
    • IArcherAliasedEntity
    • IArcherASOEntity
    • IArcherASONamedEntity
    • IArcherBase
    • IArcherContentUpdateInfoEntity
    • IArcherDescribableEntity
    • IArcherDescribedEntity
    • IArcherEntity
    • IArcherEntityBase
    • IArcherGuidEntity
    • IArcherNameableEntity
    • IArcherNamedEntity
    • IArcherUpdateInfoEntity
    • IEditableArcherEntity
    • IUpdateInformation
    • SourceAttribute
    • UpstreamPropertyAttribute
  • Estrelica.Archer.Events
    • EventActionLayoutType
    • EventActionType
    • EventDateActionType
    • EventItemActionType
    • EventSectionActionType
    • IEventAction
    • IEventRule
    • ISetDateOption
  • Estrelica.Archer.Layouts
    • ILayout
    • ILayoutEntity
    • ILayoutItem
    • ILayoutSection
    • ILayoutTab
    • LayoutItemType
    • LayoutMemberType
    • LayoutSectionType
    • LayoutTabType
  • Estrelica.Archer.Metadata
    • ArcherMetadataExtensions
    • FilterConditionType
    • FilterCriteriaOperatorType
    • IArcherApplication
    • IArcherLevel
    • IArcherModule
    • IArcherQuestionnaire
    • IArcherSolution
    • IArcherSubForm
    • IArcherValuesList
    • IArcherValuesListValue
    • IFilterCondition
    • IFilterCriteria
    • ILevelFilter
    • ILevelFilterValue
    • IModuleOwner
    • IModuleOwnerGroup
    • IModuleOwnerUser
    • IModuleReference
    • INumericRange
    • INumericRangeValue
    • IQuestionnaireRule
    • ModuleClass
    • ModuleStatus
    • ModuleType
    • QuestionnaireRuleType
    • ReportType
    • Timezone
    • ValuesListType
    • ValueSortType
  • Estrelica.Archer.Metadata.Field
    • ArcherFieldExtensions
    • DefaultDateType
    • ExternalLinkProtocol
    • FieldEncryptionState
    • FieldType
    • IArcherField
    • IAssetResponsibilitiesField
    • IAttachmentField
    • IAvailableUserGroupSelections
    • IBaseDateField
    • ICalculatedValuesListField
    • IContentAccessHistoryField
    • ICrossApplicationStatusTrackingField
    • ICrossModuleStatusTrackingField
    • ICrossReferenceField
    • IDateField
    • IDiscussionField
    • IDocumentField
    • IExternalLinksField
    • IFirstPublishedField
    • IGroupPermission
    • IHistoryLogField
    • IImageField
    • IIPAddressField
    • ILastUpdatedField
    • IMatrixField
    • ImplementsAPIKey
    • ImplementsFieldTypeAttribute
    • IMultipleReferenceDisplayField
    • INumericField
    • IPermissionInheritance
    • IQuestionnaireReferenceField
    • IRecordStatusField
    • IReferenceField
    • IRelatedRecordsField
    • IRiskAssessmentField
    • ISchedulerField
    • ISubformField
    • ITechnologiesListField
    • ITechnologyVersionsListField
    • ITextField
    • ITrackingIDField
    • IUserGroupListField
    • IUserPermission
    • IValuesListField
    • IVotingField
    • SystemFieldType
    • UserGroupType
    • VotingType
  • Estrelica.Archer.Metadata.Field.Properties
    • DisplayControl
    • FieldLayoutFormat
    • IAdvancedDisplayOption
    • IAdvancedDisplayProperty
    • IAllowLookupProperty
    • IAllowSortingProperty
    • IColumnCountProperty
    • IDisplayControlProperty
    • IDisplayInHeaderProperty
    • IEncryptionStateProperty
    • IFieldValidationTypeProperty
    • IHeightWidthProperty
    • IIncludeTimeInformationProperty
    • IIncludeUserInformationProperty
    • IIsAuditEnabledProperty
    • IIsBulkCreateEnabledProperty
    • IIsBulkUpdateEnabledProperty
    • IIsCalculatedProperty
    • IIsEditableGridDisplayProperty
    • IIsEditableInSearchProperty
    • IIsEncryptedProperty
    • IIsFindEnabledProperty
    • IIsKeyProperty
    • IIsQuestionProperty
    • IIsRequiredProperty
    • IIsRestrictedToLevelProperty
    • IIsSupressedProperty
    • IIsTrendingEnabledProperty
    • IIsUniqueProperty
    • ILinkProperty
    • ILookupReportProperty
    • IMaxAttachmentsAllowedProperty
    • IMaxFileSizeProperty
    • IMaximumSelectionProperty
    • IMaxIntValueProperty
    • IMaxLongValueProperty
    • IMinAttachmentsAllowedProperty
    • IMinimumSelectionProperty
    • IMinIntValueProperty
    • IMinLongValueProperty
    • IMinMaxSelectionProperty
    • IPrefixProperty
    • ISuffixProperty
    • ITrendingDurationProperty
    • ITrendingDurationTypeProperty
    • MatrixAxis
    • NegativeDisplayType
  • Estrelica.Archer.Metadata.Properties
    • IIsDeprecatedProperty
    • IIsDirectToEditEnabledProperty
    • IIsMobileEnabledProperty
    • IIsNotificationProperty
    • IIsTaskManagementEnabledProperty
    • IIsWaveEnabledProperty
    • IKeepLicensedProperty
    • ISearchViewProperty
  • Estrelica.Archer.Utility
    • APIExceptionExtensions
    • APIPreference
    • APISource
    • ArcherAPIException
    • ArcherEntitySerializer
    • BaseDataWrapper<K>
    • CachedResolver
    • DictionaryDataWrapper<K>
    • DomainFormat
    • EditUtilities
    • ExtensionsUnavailableException
    • FilterCriteriaHelper
    • IAccessResolver
    • IAPIFacade
    • IArcherRestAPI
    • IArcherSoapAPI
    • IArcherUndocumentedAPI
    • ICastleHillExtendedAPI
    • IContentResolver
    • ILayoutResolver
    • IMetadataResolver
    • IReportResolver
    • IValueAccessor
    • ObjectDataWrapper<T, K>
    • ObjectKeyAttribute
    • ValuesListChangeEvent
    • ValuesListChangeEventArgs
  • Estrelica.Interfaces
    • IArcherAuthProvider
    • ICacheProvider
    • IClearable
    • IDatabaseAuthProvider
    • IEditable
    • IEditable<V>
    • IEditableCollection<V>
    • IEditableEnumerable<V>
    • IEditableFieldSelection<V>
    • IEditableInterface<I>
    • IEntityResolver
    • IExtendedAPIAuthProvider
    • IHttpClientAccessor
    • ILogCleanup
    • ILogSubscriber
    • InvalidateEntity<K>
    • InvalidateEntityEventArgs<K>
    • IRecordAccess
    • IRecordAccess<T>
    • IResolverProvider
    • ISessionProvider
    • ISystemUpdateable
    • ITrafficCounter
    • LogLevel
  • Estrelica.Logging
    • BaseLogger
    • ConsoleLogger
    • FileLogger
    • FileLogger.TimestampFormat
    • Logger
    • TraceLogger
  • Estrelica.Utility
    • Arguments
    • BaseRecordAccess
    • DataReaderExtensions
    • DateTimeExtensions
    • Debouncer
    • DebugLog
    • DeferEnumerable<T>
    • DeferValue<V>
    • DictionaryExtensions
    • EnumHelper
    • ExceptionExtensions
    • GuidUtility
    • HandledException
    • HashSetExtensions
    • ICacheHandler
    • ICollectionExtensions
    • IDeferrable
    • IDeferredValue
    • IEnumerableExtensions
    • IgnoreDefaultValuesDictionary<K, V>
    • JsonDictionary<V>
    • OperationExtensions
    • Resource
    • SqlConnectionExtensions
    • SqlUtilities
    • StreamExtensions
    • StringExtensions
    • TableMapper
    • TimeoutDictionary<K, V>
    • TypeExtensions
    • XElementExtensions

Interface IAPIFacade

Inherited Members
IArcherSoapAPI.ExecuteReport(int)
IArcherSoapAPI.ExecuteReport(Guid)
IArcherSoapAPI.ExecuteStatisticsReport(int)
IArcherSoapAPI.ExecuteStatisticsReport(Guid)
IArcherSoapAPI.ExecuteReport(int, int)
IArcherSoapAPI.ExecuteReport(Guid, int)
IArcherSoapAPI.ExecuteStatisticsReport(int, int)
IArcherSoapAPI.ExecuteStatisticsReport(Guid, int)
IArcherSoapAPI.ExecuteSearch(string)
IArcherSoapAPI.ExecuteSearch(string, int)
IArcherSoapAPI.GetModuleIdByGuid(Guid, string)
IArcherSoapAPI.GetReportsArcher()
IArcherSoapAPI.GetReportSearchOptionsArcher(int)
IArcherSoapAPI.GetReportSearchOptionsArcher(Guid)
IArcherSoapAPI.GetUserId(string, string)
IArcherSoapAPI.GetUserWS(int)
IArcherSoapAPI.CreateValuesListValue(int, string)
IArcherSoapAPI.DeleteValuesListValue(int, int)
IArcherSoapAPI.UpdateValuesListValueName(int, string)
IArcherSoapAPI.UpdateValuesListValueNameAndNumericValue(int, string, decimal?)
IArcherSoapAPI.ClearValuesListValueNumericValue(int)
IArcherRestAPI.ArcherVersion
IArcherRestAPI.AddGroupToRole(int, int)
IArcherRestAPI.AddUserToRole(int, int)
IArcherRestAPI.AddUserToGroup(int, int)
IArcherRestAPI.CreateGroup(string, string, IEnumerable<int>, IEnumerable<int>, IEnumerable<int>)
IArcherRestAPI.CreateRole(string, string, string, IEnumerable<int>, IEnumerable<int>, bool)
IArcherRestAPI.ChangeUserPassword(int, string)
IArcherRestAPI.CreateUser(string, string, string, string, string, int?, int?, string, bool, AccountStatus, int, IEnumerable<int>, IEnumerable<int>)
IArcherRestAPI.DeleteContent(int, bool)
IArcherRestAPI.DeleteGroup(int)
IArcherRestAPI.DeleteRole(int)
IArcherRestAPI.DeleteUser(int)
IArcherRestAPI.ExecuteDatafeed(Guid, bool)
IArcherRestAPI.GetAllApplications(int)
IArcherRestAPI.GetAllContacts(int, bool)
IArcherRestAPI.GetAllGroups(int)
IArcherRestAPI.GetAllLayoutsByLevelId(int)
IArcherRestAPI.GetAllLevels(int)
IArcherRestAPI.GetAllQuestionnaires(int, bool)
IArcherRestAPI.GetAllRoles(int)
IArcherRestAPI.GetAllSecurityParameters(int, bool)
IArcherRestAPI.GetAllUsers(int)
IArcherRestAPI.GetApplication(int, bool)
IArcherRestAPI.GetAttachment(int, bool)
IArcherRestAPI.GetAttachmentDecoded(int, bool)
IArcherRestAPI.GetContactsForUser(int, int, bool)
IArcherRestAPI.GetContentById(int)
IArcherRestAPI.GetContentByIdAsXml(int)
IArcherRestAPI.GetContentByReferenceFieldId(int, int)
IArcherRestAPI.GetContentHistory(int, bool)
IArcherRestAPI.GetContentByContentIdsAndFieldIds(IEnumerable<int>, IEnumerable<int>, DateTime?, DateTime?, int, bool)
IArcherRestAPI.GetAllDatafeedsArcher()
IArcherRestAPI.GetDatafeedHistory(Guid, int)
IArcherRestAPI.GetDatafeedHistoryMessages(int)
IArcherRestAPI.GetDatafeedRecentRunDetail(Guid)
IArcherRestAPI.GetDefaultLayoutForLevel(int, bool)
IArcherRestAPI.GetEventAction(int)
IArcherRestAPI.GetEventActionsForEventRule(int, int)
IArcherRestAPI.GetEventRule(int)
IArcherRestAPI.GetEventRulesForLevel(int, int)
IArcherRestAPI.GetFieldDefinition(int, bool)
IArcherRestAPI.GetFieldDefinitionsForLevel(int, int, bool)
IArcherRestAPI.GetFieldDisplaysForLevel(int, int, bool)
IArcherRestAPI.GetFieldIdsByEventRuleFilterByLevelId(int)
IArcherRestAPI.GetGroup(int, bool)
IArcherRestAPI.GetGroupHierarchy(int)
IArcherRestAPI.GetAllGroupMemberships(int)
IArcherRestAPI.GetGroupMembership(int)
IArcherRestAPI.GetGroupsForUser(int, int)
IArcherRestAPI.GetHierarchicalValuesForValuesList(int, bool)
IArcherRestAPI.GetLevel(int, bool)
IArcherRestAPI.GetLevelsForModule(int, int, bool)
IArcherRestAPI.GetLevelsForReferenceField(int, int, bool)
IArcherRestAPI.GetQuestionnaire(int, bool)
IArcherRestAPI.GetQuestionnaireRule(int, bool)
IArcherRestAPI.GetQuestionnaireRulesForLevel(int, int, bool)
IArcherRestAPI.GetAllRoleMemberships(int, bool)
IArcherRestAPI.GetRole(int)
IArcherRestAPI.GetRoleMembership(int, bool)
IArcherRestAPI.GetSecurityParameter(int, bool)
IArcherRestAPI.GetSubform(int, bool)
IArcherRestAPI.GetUser(int, bool)
IArcherRestAPI.GetUserGroupSelectionsForField(int, int, bool)
IArcherRestAPI.GetUserIdsForGroup(int, int)
IArcherRestAPI.GetValuesListDefinition(int, bool)
IArcherRestAPI.GetValuesListFieldDefinitionsForLevel(int, int, bool)
IArcherRestAPI.GetValuesListValuesForValuesList(int, bool)
IArcherRestAPI.GetUsersForGroup(int, int, string)
IArcherRestAPI.InsertContent(string)
IArcherRestAPI.TerminateSession(string)
IArcherRestAPI.Logout(IArcherAuthProvider)
IArcherRestAPI.PostAttachment(string, string, bool)
IArcherRestAPI.PostAttachmentFromBytes(byte[], string, bool)
IArcherRestAPI.PostAttachmentFromBase64(string, string, bool)
IArcherRestAPI.PostContent(IDictionary<string, dynamic>)
IArcherRestAPI.RemoveGroupFromRole(int, int)
IArcherRestAPI.RemoveUserFromRole(int, int)
IArcherRestAPI.RemoveUserFromGroup(int, int)
IArcherRestAPI.UpdateContent(string)
IArcherRestAPI.GetWorkflowActions(int, bool)
IArcherRestAPI.PerformWorkflowAction(int, int, string)
ICastleHillExtendedAPI.ExtendedAPIVersion
ICastleHillExtendedAPI.GetAllSolutions(bool)
ICastleHillExtendedAPI.GetAllSubformIds(bool)
ICastleHillExtendedAPI.GetArcherApplicationDetails()
ICastleHillExtendedAPI.GetCalcFormulaForField(int, bool)
ICastleHillExtendedAPI.GetCalcFormulasForLevel(int, bool)
ICastleHillExtendedAPI.GetContentInfoForLevel(int, int, bool)
ICastleHillExtendedAPI.GetContentInfoForModule(int, int, bool)
ICastleHillExtendedAPI.GetContentStats(DateTime, IDictionary<int, int>, int, bool)
ICastleHillExtendedAPI.GetUpdatedContentIdsByLevel(int, DateTime?, DateTime?, bool, int, bool)
ICastleHillExtendedAPI.GetUpdatedContentIdsByModule(int, DateTime?, DateTime?, bool, int, bool)
ICastleHillExtendedAPI.GetDatafeedsForLevel(int, bool)
ICastleHillExtendedAPI.GetEmptyValuesListIds(bool)
ICastleHillExtendedAPI.GetExtendedFieldInfoForLevel(int, bool)
ICastleHillExtendedAPI.GetFieldAuditInfoForLevel(int, int, bool)
ICastleHillExtendedAPI.GetFilterCriteria(int, bool, bool)
ICastleHillExtendedAPI.GetFilterCriteriaXml(int, bool, bool)
ICastleHillExtendedAPI.GetIdGuidMappings(EntityType, bool)
ICastleHillExtendedAPI.GetGuidIdMappings(EntityType, bool)
ICastleHillExtendedAPI.GetLevelFiltersForLevel(int, int, bool)
ICastleHillExtendedAPI.GetModuleOwners(int, int, bool)
ICastleHillExtendedAPI.GetModulesForSolution(int, bool)
ICastleHillExtendedAPI.GetNumericRanges(bool)
ICastleHillExtendedAPI.GetReportDetails(int, bool)
ICastleHillExtendedAPI.GetSolution(int, bool)
ICastleHillExtendedAPI.GetUsernamesAndDomains(bool)
ICastleHillExtendedAPI.GetUserDomains(bool)
ICastleHillExtendedAPI.GetUsernamesByUserId(bool, DomainFormat)
ICastleHillExtendedAPI.GetReportSearchOptions(int, bool, bool)
ICastleHillExtendedAPI.GetAllDatafeeds()
IArcherUndocumentedAPI.OptInForUndocumentedAPI
Namespace: Estrelica.Archer.Utility
Assembly: Estrelica.Archer.Utility.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IAPIFacade : IArcherSoapAPI, IArcherRestAPI, ICastleHillExtendedAPI, IArcherUndocumentedAPI

Properties

BasicHttpBinding

Allows BasicHttpBinding settings to be overridden for all Archer webservices (SOAP) calls made by the APIFacade

Declaration
[Obsolete("This property is obsolete.  Settings on this property will be ignored.", false)]
BasicHttpBinding BasicHttpBinding { get; }
Property Value
BasicHttpBinding

Remarks

This is no longer needed since the SOAP calls no longer depend on WCF.

EnableExtensions

Allows extensions to be enabled/disabled, for use in testing non-extension behavior in environments where extensions are available.

Declaration
bool EnableExtensions { get; set; }
Property Value
bool

ExtensionPreference

If extensions are licensed, available and enabled, this indicates which extension path takes precedence when both are discovered. Options are DatabaseFirst, ExtendedAPIFirst. Default is DatabaseFirst.

Declaration
APIPreference ExtensionPreference { get; set; }
Property Value
APIPreference

Methods

ExtensionsAvailable(Version)

Returns the APISource "extensions type" that are available for the current session.

Declaration
APISource ExtensionsAvailable(Version requiredVersion = null)
Parameters
Version requiredVersion

Optional param for an expected Extended API version

Returns
APISource

None if no extensions are available, ExtendedAPI if the Extended API is available (and, if specified, is at least "requiredVersion", Database if Database extensions are available

Extension Methods

EnumHelper.In<TEnum>(TEnum, params TEnum[])
IEnumerableExtensions.ToEnumerable<T>(T)
StringExtensions.AssertNotNull<T>(T, string)
TypeExtensions.WithDispose<T, V>(T, Func<T, V>)
EnumHelper.CastNullable<TEnum>(object)
TypeExtensions.ConvertTo<V>(object)
TypeExtensions.TryConvert<V>(object, out V)
Back to top Copyright 2019-2023 by CastleHill Software LLC