• 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 IArcherRestAPI

Namespace: Estrelica.Archer.Utility
Assembly: Estrelica.Archer.Utility.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IArcherRestAPI

Properties

ArcherVersion

Returns the Archer version number from the connected Archer instance

Declaration
string ArcherVersion { get; }
Property Value
string

Remarks

platformapi/core/system/applicationinfo/version

Methods

AddGroupToRole(int, int)

Adds an Archer Group to an Archer Role

Declaration
bool AddGroupToRole(int groupId, int roleId)
Parameters
int groupId

The id of the group to be added

int roleId

The id of the role to which the group is to be added

Returns
bool

true if the add was successful

Remarks

platformapi/core/system/rolegroup

AddUserToGroup(int, int)

Adds an Archer User to an Archer Group

Declaration
bool AddUserToGroup(int userId, int groupId)
Parameters
int userId

The id of the user to be added

int groupId

The id of the group to which the user is to be added

Returns
bool

true if the add was successful

Remarks

platformapi/core/system/usergroup

AddUserToRole(int, int)

Adds an Archer User to an Archer Role

Declaration
bool AddUserToRole(int userId, int roleId)
Parameters
int userId

The id of the user to be added

int roleId

The id of the role to which the user is to be added

Returns
bool

true if the add was successful

Remarks

platformapi/core/system/userrole

ChangeUserPassword(int, string)

Changes an Archer User's password

Declaration
bool ChangeUserPassword(int userId, string newPassword)
Parameters
int userId

The id of the user to be modified

string newPassword

The new password to be set for the user

Returns
bool

true if the password change was successful

Remarks

platformapi/core/system/userpassword

CreateGroup(string, string, IEnumerable<int>, IEnumerable<int>, IEnumerable<int>)

Creates a new Archer Group having the given name, description, parent and child groups, and users

Declaration
int CreateGroup(string groupName, string description = null, IEnumerable<int> parentGroupIds = null, IEnumerable<int> childGroupIds = null, IEnumerable<int> userIds = null)
Parameters
string groupName

string description

IEnumerable<int> parentGroupIds

IEnumerable<int> childGroupIds

IEnumerable<int> userIds

Returns
int

The id of the created group

Remarks

platformapi/core/system/group

CreateRole(string, string, string, IEnumerable<int>, IEnumerable<int>, bool)

Creates a new Archer Role having the given name, description, alias, groups, users, and default assignment status

Declaration
int CreateRole(string roleName, string description = null, string alias = null, IEnumerable<int> groupIds = null, IEnumerable<int> userIds = null, bool isDefault = false)
Parameters
string roleName

string description

string alias

IEnumerable<int> groupIds

IEnumerable<int> userIds

bool isDefault

Returns
int

The id of the created role

Remarks

platformapi/core/system/role

CreateUser(string, string, string, string, string, int?, int?, string, bool, AccountStatus, int, IEnumerable<int>, IEnumerable<int>)

Creates a new Archer User

Declaration
int CreateUser(string firstName, string lastName, string password, string middleName = null, string username = null, int? domainId = null, int? languageId = null, string timezone = null, bool forcePasswordChange = false, AccountStatus accountStatus = AccountStatus.Active, int securityParameterId = 1, IEnumerable<int> groupIds = null, IEnumerable<int> roleIds = null)
Parameters
string firstName

The user's first name (required)

string lastName

The user's last name (required)

string password

The user's password (required)

string middleName

The user's middle name

string username

The user's username. If null (or already in use) Archer will compose a username automatically.

int? domainId

The integer Id of the user's domain, if applicable

int? languageId

The integer Id of the user's preferred language, if applicable

string timezone

The user's Timezone string. See Estrelica.Archer.Metadata.Timezone.Ids for valid values.
If null, the user will be assigned the default Timezone configured for the Archer instance. If invalid, an exception will be raised.

bool forcePasswordChange

Indicates whether the user will be required to set a new password on first login

AccountStatus accountStatus

The status of the user account. Valid values are Active (default), Inactive, Locked or Deleted

int securityParameterId

The Security Parameter Id of the user. Default is 1 (General User).

IEnumerable<int> groupIds

The Ids of the groups, if any, that the user should be added to.

IEnumerable<int> roleIds

The Ids of the roles, if any, that the user should be added to.

Returns
int

The id of the created user

Remarks

platformapi/core/system/user

DeleteContent(int, bool)

Deletes an Archer Content record

Declaration
bool DeleteContent(int contentId, bool throwExceptionIfInvalid = false)
Parameters
int contentId

The id of the content to be deleted

bool throwExceptionIfInvalid

Returns
bool

true if the deletion was successful

Remarks

platformapi/core/content/

DeleteGroup(int)

Deletes an Archer Group

Declaration
bool DeleteGroup(int groupId)
Parameters
int groupId

The id of the group to be deleted

Returns
bool

true if the deletion was successful

Remarks

platformapi/core/system/group

DeleteRole(int)

Deletes an Archer Role

Declaration
bool DeleteRole(int roleId)
Parameters
int roleId

The id of the role to be deleted

Returns
bool

true if the deletion was successful

Remarks

platformapi/core/system/role

DeleteUser(int)

Deletes an Archer User

Declaration
bool DeleteUser(int userId)
Parameters
int userId

The id of the user to be deleted

Returns
bool

true if the deletion was successful

Remarks

platformapi/core/system/user

ExecuteDatafeed(Guid, bool)

Queues a datafeed for execution, optionally including any referenced datafeeds

Declaration
void ExecuteDatafeed(Guid datafeedGuid, bool includeReferenceFeeds = false)
Parameters
Guid datafeedGuid

The guid of the datafeed to be executed

bool includeReferenceFeeds

True if other datafeeds referenced by the datafeed should also be executed, false if not

Remarks

platformapi/core/datafeed/execution

GetAllApplications(int)

Returns all available applications in the Archer environment

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllApplications(int pageSize = 100)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

Returns all available application metadata deserialized into IEnumerable<IDictionary<string,dynamic>gt;

GetAllContacts(int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllContacts(int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllDatafeedsArcher()

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllDatafeedsArcher()
Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllGroupMemberships(int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllGroupMemberships(int pageSize = 100)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllGroups(int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllGroups(int pageSize = 100)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllLayoutsByLevelId(int)

Returns layouts available for the specified level. If extensions are available this will include non-default layouts, otherwise the returned enumeration will only contain the default layout.

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllLayoutsByLevelId(int levelId)
Parameters
int levelId

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllLevels(int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllLevels(int pageSize = 100)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllQuestionnaires(int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllQuestionnaires(int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllRoleMemberships(int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllRoleMemberships(int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllRoles(int)

Returns all available Roles in the system. If extensions are available these will be augmented with additional information.

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllRoles(int pageSize = 100)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllSecurityParameters(int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllSecurityParameters(int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetAllUsers(int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetAllUsers(int pageSize = 1000)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetApplication(int, bool)

Declaration
IDictionary<string, dynamic> GetApplication(int applicationId, bool treatResourceNotFoundAsNull = true)
Parameters
int applicationId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetAttachment(int, bool)

Declaration
IDictionary<string, dynamic> GetAttachment(int attachmentId, bool treatResourceNotFoundAsNull = true)
Parameters
int attachmentId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetAttachmentDecoded(int, bool)

Declaration
Tuple<string, byte[]> GetAttachmentDecoded(int attachmentId, bool treatResourceNotFoundAsNull = true)
Parameters
int attachmentId

bool treatResourceNotFoundAsNull

Returns
Tuple<string, byte[]>

GetContactsForUser(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetContactsForUser(int userId, int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int userId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetContentByContentIdsAndFieldIds(IEnumerable<int>, IEnumerable<int>, DateTime?, DateTime?, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetContentByContentIdsAndFieldIds(IEnumerable<int> contentIds, IEnumerable<int> fieldIds, DateTime? lastUpdatedStartDate = null, DateTime? lastUpdatedEndDate = null, int pageSize = 1000, bool treatResourceNotFoundAsEmptyResult = false)
Parameters
IEnumerable<int> contentIds

IEnumerable<int> fieldIds

DateTime? lastUpdatedStartDate

DateTime? lastUpdatedEndDate

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetContentById(int)

Declaration
IDictionary<string, dynamic> GetContentById(int contentId)
Parameters
int contentId

Returns
IDictionary<string, dynamic>

GetContentByIdAsXml(int)

Declaration
XElement GetContentByIdAsXml(int contentId)
Parameters
int contentId

Returns
XElement

GetContentByReferenceFieldId(int, int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetContentByReferenceFieldId(int fieldId, int pageSize = 1000)
Parameters
int fieldId

int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetContentHistory(int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetContentHistory(int contentId, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int contentId

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetDatafeedHistory(Guid, int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetDatafeedHistory(Guid datafeedGuid, int pageSize = 2147483647)
Parameters
Guid datafeedGuid

int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetDatafeedHistoryMessages(int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetDatafeedHistoryMessages(int historyMessageId)
Parameters
int historyMessageId

Returns
IEnumerable<IDictionary<string, dynamic>>

GetDatafeedRecentRunDetail(Guid)

Declaration
IDictionary<string, dynamic> GetDatafeedRecentRunDetail(Guid datafeedGuid)
Parameters
Guid datafeedGuid

Returns
IDictionary<string, dynamic>

GetDefaultLayoutForLevel(int, bool)

Declaration
IDictionary<string, dynamic> GetDefaultLayoutForLevel(int levelId, bool treatResourceNotFoundAsNull = true)
Parameters
int levelId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetEventAction(int)

Declaration
IDictionary<string, dynamic> GetEventAction(int eventActionId)
Parameters
int eventActionId

Returns
IDictionary<string, dynamic>

GetEventActionsForEventRule(int, int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetEventActionsForEventRule(int eventRuleId, int pageSize = 100)
Parameters
int eventRuleId

int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetEventRule(int)

Declaration
IDictionary<string, dynamic> GetEventRule(int eventRuleId)
Parameters
int eventRuleId

Returns
IDictionary<string, dynamic>

GetEventRulesForLevel(int, int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetEventRulesForLevel(int levelId, int pageSize = 100)
Parameters
int levelId

int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetFieldDefinition(int, bool)

Declaration
IDictionary<string, dynamic> GetFieldDefinition(int fieldId, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int fieldId

bool treatResourceNotFoundAsEmptyResult

Returns
IDictionary<string, dynamic>

GetFieldDefinitionsForLevel(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetFieldDefinitionsForLevel(int levelId, int pageSize = 1000, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int levelId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetFieldDisplaysForLevel(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetFieldDisplaysForLevel(int levelId, int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int levelId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetFieldIdsByEventRuleFilterByLevelId(int)

Declaration
IEnumerable<int> GetFieldIdsByEventRuleFilterByLevelId(int levelId)
Parameters
int levelId

Returns
IEnumerable<int>

GetGroup(int, bool)

Declaration
IDictionary<string, dynamic> GetGroup(int groupId, bool treatResourceNotFoundAsNull = true)
Parameters
int groupId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetGroupHierarchy(int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetGroupHierarchy(int pageSize = 100)
Parameters
int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetGroupMembership(int)

Declaration
IDictionary<string, dynamic> GetGroupMembership(int groupId)
Parameters
int groupId

Returns
IDictionary<string, dynamic>

GetGroupsForUser(int, int)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetGroupsForUser(int userId, int pageSize = 100)
Parameters
int userId

int pageSize

Returns
IEnumerable<IDictionary<string, dynamic>>

GetHierarchicalValuesForValuesList(int, bool)

Declaration
IDictionary<string, dynamic> GetHierarchicalValuesForValuesList(int valuesListId, bool treatResourceNotFoundAsNull = true)
Parameters
int valuesListId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetLevel(int, bool)

Declaration
IDictionary<string, dynamic> GetLevel(int levelId, bool treatResourceNotFoundAsNull = true)
Parameters
int levelId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetLevelsForModule(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetLevelsForModule(int moduleId, int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int moduleId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetLevelsForReferenceField(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetLevelsForReferenceField(int fieldId, int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int fieldId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetQuestionnaire(int, bool)

Declaration
IDictionary<string, dynamic> GetQuestionnaire(int questionnaireId, bool treatResourceNotFoundAsNull = true)
Parameters
int questionnaireId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetQuestionnaireRule(int, bool)

Declaration
IDictionary<string, dynamic> GetQuestionnaireRule(int questionnaireRuleId, bool treatResourceNotFoundAsNull = true)
Parameters
int questionnaireRuleId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetQuestionnaireRulesForLevel(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetQuestionnaireRulesForLevel(int levelId, int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int levelId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetRole(int)

Declaration
IDictionary<string, dynamic> GetRole(int roleId)
Parameters
int roleId

Returns
IDictionary<string, dynamic>

GetRoleMembership(int, bool)

Declaration
IDictionary<string, dynamic> GetRoleMembership(int roleId, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int roleId

bool treatResourceNotFoundAsEmptyResult

Returns
IDictionary<string, dynamic>

GetSecurityParameter(int, bool)

Declaration
IDictionary<string, dynamic> GetSecurityParameter(int securityParameterId, bool treatResourceNotFoundAsNull = true)
Parameters
int securityParameterId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetSubform(int, bool)

Declaration
IDictionary<string, dynamic> GetSubform(int subformId, bool treatResourceNotFoundAsNull = true)
Parameters
int subformId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetUser(int, bool)

Declaration
IDictionary<string, dynamic> GetUser(int userId, bool treatResourceNotFoundAsNull = true)
Parameters
int userId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetUserGroupSelectionsForField(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetUserGroupSelectionsForField(int fieldId, int pageSize = 100, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int fieldId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetUserIdsForGroup(int, int)

Declaration
IEnumerable<int> GetUserIdsForGroup(int groupId, int pageSize = 1000)
Parameters
int groupId

int pageSize

Returns
IEnumerable<int>

GetUsersForGroup(int, int, string)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetUsersForGroup(int groupId, int pageSize = 1000, string requestBody = null)
Parameters
int groupId

int pageSize

string requestBody

Returns
IEnumerable<IDictionary<string, dynamic>>

GetValuesListDefinition(int, bool)

Declaration
IDictionary<string, dynamic> GetValuesListDefinition(int valuesListId, bool treateResourceNotFoundAsNull = true)
Parameters
int valuesListId

bool treateResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

GetValuesListFieldDefinitionsForLevel(int, int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetValuesListFieldDefinitionsForLevel(int levelId, int pageSize = 1000, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int levelId

int pageSize

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetValuesListValuesForValuesList(int, bool)

Declaration
IEnumerable<IDictionary<string, dynamic>> GetValuesListValuesForValuesList(int valuesListId, bool treatResourceNotFoundAsEmptyResult = true)
Parameters
int valuesListId

bool treatResourceNotFoundAsEmptyResult

Returns
IEnumerable<IDictionary<string, dynamic>>

GetWorkflowActions(int, bool)

Declaration
IDictionary<string, dynamic> GetWorkflowActions(int contentId, bool treatResourceNotFoundAsNull = true)
Parameters
int contentId

bool treatResourceNotFoundAsNull

Returns
IDictionary<string, dynamic>

InsertContent(string)

Declaration
IDictionary<string, dynamic> InsertContent(string jsonContent)
Parameters
string jsonContent

Returns
IDictionary<string, dynamic>

Logout(IArcherAuthProvider)

Declaration
bool Logout(IArcherAuthProvider sessionProvider)
Parameters
IArcherAuthProvider sessionProvider

Returns
bool

PerformWorkflowAction(int, int, string)

Declaration
bool PerformWorkflowAction(int contentId, int completionCode, string workflowNodeId)
Parameters
int contentId

int completionCode

string workflowNodeId

Returns
bool

PostAttachment(string, string, bool)

Declaration
int PostAttachment(string sourceFilename, string attachmentName = null, bool encryptBeforeSaving = false)
Parameters
string sourceFilename

string attachmentName

bool encryptBeforeSaving

Returns
int

PostAttachmentFromBase64(string, string, bool)

Declaration
int PostAttachmentFromBase64(string base64content, string attachmentName, bool encryptBeforeSaving = false)
Parameters
string base64content

string attachmentName

bool encryptBeforeSaving

Returns
int

PostAttachmentFromBytes(byte[], string, bool)

Declaration
int PostAttachmentFromBytes(byte[] content, string attachmentName, bool encryptBeforeSaving = false)
Parameters
byte[] content

string attachmentName

bool encryptBeforeSaving

Returns
int

PostContent(IDictionary<string, dynamic>)

Declaration
IDictionary<string, dynamic> PostContent(IDictionary<string, dynamic> content)
Parameters
IDictionary<string, dynamic> content

Returns
IDictionary<string, dynamic>

RemoveGroupFromRole(int, int)

Removes an Archer Group from an Archer Role

Declaration
bool RemoveGroupFromRole(int groupId, int roleId)
Parameters
int groupId

The id of the group to be removed

int roleId

The id of the role to which the group is to be removed

Returns
bool

true if the removal was successful

Remarks

platformapi/core/system/rolegroup

RemoveUserFromGroup(int, int)

Declaration
bool RemoveUserFromGroup(int userId, int groupId)
Parameters
int userId

int groupId

Returns
bool

RemoveUserFromRole(int, int)

Removes an Archer Group from an Archer Role

Declaration
bool RemoveUserFromRole(int userId, int roleId)
Parameters
int userId

The id of the user to be removed

int roleId

The id of the role to which the user is to be removed

Returns
bool

true if the removal was successful

Remarks

platformapi/core/system/userrole

TerminateSession(string)

Declaration
bool TerminateSession(string sessionToken)
Parameters
string sessionToken

Returns
bool

UpdateContent(string)

Declaration
IDictionary<string, dynamic> UpdateContent(string jsonContent)
Parameters
string jsonContent

Returns
IDictionary<string, dynamic>

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