ARCAPI

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Description = A library providing an API on top of the -PropertyStream-.0x000D0x000A0x000D0x000AThe API can for instance be offered over HTTP / HTTPS with the help of Microsoft.AspNetCore.Mvc (see -ARAAPI-)0x000D0x000Abut -ARCAPI- itself is totally independent of any specific web-server technology.0x000D0x000A0x000D0x000AThe API provided supports both0x000D0x000A 1) GraphQL (-GQController-) and0x000D0x000A2) REST (-RQController-).0x000D0x000A0x000D0x000AIn addition to JSON format the API also provides a rudimentary HTML / Javascript based interface for direct user interaction (nominally for administrative users / power users).0x000D0x000A0x000D0x000AThe HTML views are created automatically based on -TaggingOfPropertyKeys-, including Javascript forms for creating new properties.0x000D0x000A0x000D0x000AThe HTML interface automatically constructs views also for GraphQL queries, meaning that rich functionality can be programmed from 'outside' the API in line with the GraphQL philosophy.0x000D0x000A0x000D0x000AThis HTML interface is quite sufficient as an internal administrative tool / support department tool for your application.0x000D0x000A0x000D0x000ADepends on -ARCDoc-, -ARCQuery- and -ARCSec-.0x000D0x000A0x000D0x000ASee also -BaseController- and -AddController-.0x000D0x000A0x000D0x000A
__TOCDet/DocFragType = Assembly
__TOCDet/Name = ARCAPI
Class/__TOCDet/_Description = All classes with some AgoRapide specific attributes found in assembly ARCAPI
Class/AddController/__TOCDet/Assembly = ARCAPI
Class/AddController/__TOCDet/Description = Parses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000ASends to -ExternalReceiver- if given.0x000D0x000AAdds to the given -DataStorage- unless -DoNotStoreInternally- is specified.0x000D0x000A0x000D0x000ABulk addition of data:0x000D0x000AIf HTTP POST is used and the parameter postData is given, then it will be treated as a collection of -PropertyStreamLine-s, to which the original request will be prepended for every line.0x000D0x000AExample:0x000D0x000AIf request is 'Add/Customer/42' and postData is the following two lines0x000D0x000A  FirstName = John0x000D0x000A  LastName = Smith0x000D0x000Athen it will be treated as two separate requests like0x000D0x000A  Add/Customer/42/FirstName = John0x000D0x000A  Add/Customer/42/LastName = Smith0x000D0x000A0x000D0x000ATODO: Support use of Query for adding values to multiple entities at once.0x000D0x000ATODO: like 'Add/Customer/WHERE FirstName = John/NameEvaluation = NiceName'0x000D0x000A0x000D0x000AHint: You can test input validation by using the inbuilt classes of -ARCDoc-.0x000D0x000A(assuming that the Apple and Orange classes are included in -AllIPDerivedTypes-.)0x000D0x000AExample queries:0x000D0x000Aapi/Add/Apple/1/Colour = Red   // Should succeed0x000D0x000Aapi/Add/Apple/1/Colour = Redd  // Should fail0x000D0x000Aapi/Add/Apple/1/Color = Red    // Does not fail since Apple class accepts any property (it inherits -PRich-).0x000D0x000Aapi/Add/Orange/1/Color = Red    // Sould fail since Orange accepts only Colour and Name (it inherits -PExact-).0x000D0x000A
Class/AddController/__TOCDet/DocFragType = Class
Class/AddController/__TOCDet/Name = AddController
Class/AddController/__TOCDet/Namespace = ARCAPI
Class/AddController/__TOCDet/Type = AddController
Class/AddController/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/AddController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
Class/AddController/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/AddController/__TOCDet/Attribute/ClassType = AddController
Class/AddController/__TOCDet/Attribute/Description = Parses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000ASends to -ExternalReceiver- if given.0x000D0x000AAdds to the given -DataStorage- unless -DoNotStoreInternally- is specified.0x000D0x000A0x000D0x000ABulk addition of data:0x000D0x000AIf HTTP POST is used and the parameter postData is given, then it will be treated as a collection of -PropertyStreamLine-s, to which the original request will be prepended for every line.0x000D0x000AExample:0x000D0x000AIf request is 'Add/Customer/42' and postData is the following two lines0x000D0x000A  FirstName = John0x000D0x000A  LastName = Smith0x000D0x000Athen it will be treated as two separate requests like0x000D0x000A  Add/Customer/42/FirstName = John0x000D0x000A  Add/Customer/42/LastName = Smith0x000D0x000A0x000D0x000ATODO: Support use of Query for adding values to multiple entities at once.0x000D0x000ATODO: like 'Add/Customer/WHERE FirstName = John/NameEvaluation = NiceName'0x000D0x000A0x000D0x000AHint: You can test input validation by using the inbuilt classes of -ARCDoc-.0x000D0x000A(assuming that the Apple and Orange classes are included in -AllIPDerivedTypes-.)0x000D0x000AExample queries:0x000D0x000Aapi/Add/Apple/1/Colour = Red   // Should succeed0x000D0x000Aapi/Add/Apple/1/Colour = Redd  // Should fail0x000D0x000Aapi/Add/Apple/1/Color = Red    // Does not fail since Apple class accepts any property (it inherits -PRich-).0x000D0x000Aapi/Add/Orange/1/Color = Red    // Sould fail since Orange accepts only Colour and Name (it inherits -PExact-).0x000D0x000A
Class/AddController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Class/AddController/AllowFilter/__TOCDet/Assembly = ARCAPI
Class/AddController/AllowFilter/__TOCDet/Description = Describes what data is allowed to change through a list of -Subscription- instances.0x000D0x000A0x000D0x000ANot set (Null) by default, meaning that EVERYTHING may be changed0x000D0x000ASet to 'new List0x003CSubscription0x003E 0x007B Subscription.Parse("-*") 0x007D' if you want to disallow editing altogether.0x000D0x000A0x000D0x000AA typical setting could be the following list:0x000D0x000A  '+dt/'0x000D0x000AThat is, only allowing changes to -dt-.0x000D0x000A0x000D0x000A
Class/AddController/AllowFilter/__TOCDet/DocFragType = ClassMember
Class/AddController/AllowFilter/__TOCDet/IsInherited = False
Class/AddController/AllowFilter/__TOCDet/IsInheritedDoc = False
Class/AddController/AllowFilter/__TOCDet/Lines = 10
Class/AddController/AllowFilter/__TOCDet/Name = AllowFilter
Class/AddController/AllowFilter/__TOCDet/Namespace = ARCAPI
Class/AddController/AllowFilter/__TOCDet/Type = AddController
Class/AddController/AllowFilter/__TOCDet/Attribute/DeclaringType = AddController
Class/AddController/AllowFilter/__TOCDet/Attribute/Description = Describes what data is allowed to change through a list of -Subscription- instances.0x000D0x000A0x000D0x000ANot set (Null) by default, meaning that EVERYTHING may be changed0x000D0x000ASet to 'new List0x003CSubscription0x003E 0x007B Subscription.Parse("-*") 0x007D' if you want to disallow editing altogether.0x000D0x000A0x000D0x000AA typical setting could be the following list:0x000D0x000A  '+dt/'0x000D0x000AThat is, only allowing changes to -dt-.0x000D0x000A0x000D0x000A
Class/AddController/AllowFilter/__TOCDet/Attribute/MethodName = AllowFilter
Class/AddController/AllowFilter/__TOCDet/Attribute/MethodSignature = System.Collections.Generic.List0x006010x005BARCCore.Subscription0x005D AllowFilter
Class/AddController/APIMethod/__TOCDet/Assembly = ARCAPI
Class/AddController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/AddController/APIMethod/__TOCDet/DocFragType = ClassMember
Class/AddController/APIMethod/__TOCDet/IsInherited = False
Class/AddController/APIMethod/__TOCDet/IsInheritedDoc = True
Class/AddController/APIMethod/__TOCDet/Name = APIMethod
Class/AddController/APIMethod/__TOCDet/Namespace = ARCAPI
Class/AddController/APIMethod/__TOCDet/Type = AddController
Class/AddController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
Class/AddController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/AddController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
Class/AddController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
Class/AddController/ToString/__TOCDet/Assembly = ARCAPI
Class/AddController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/AddController/ToString/__TOCDet/DocFragType = ClassMember
Class/AddController/ToString/__TOCDet/IsInherited = True
Class/AddController/ToString/__TOCDet/IsInheritedDoc = True
Class/AddController/ToString/__TOCDet/Name = ToString
Class/AddController/ToString/__TOCDet/Namespace = ARCAPI
Class/AddController/ToString/__TOCDet/Type = AddController
Class/AddController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
Class/AddController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/AddController/ToString/__TOCDet/Attribute/MethodName = ToString
Class/AddController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
Class/BaseController/__TOCDet/Assembly = ARCAPI
Class/BaseController/__TOCDet/Description = Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'as/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a container by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A
Class/BaseController/__TOCDet/DocFragType = Class
Class/BaseController/__TOCDet/Name = BaseController
Class/BaseController/__TOCDet/Namespace = ARCAPI
Class/BaseController/__TOCDet/Type = BaseController
Class/BaseController/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/BaseController/__TOCDet/Attribute/BaseTypes = PConcurrent
Class/BaseController/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/BaseController/__TOCDet/Attribute/ClassType = BaseController
Class/BaseController/__TOCDet/Attribute/CorrespondingEnumType = BaseControllerP
Class/BaseController/__TOCDet/Attribute/Description = Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'as/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a container by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A
Class/BaseController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Class/BaseController/__TOCDet/Attribute/SubTypes = AddController0x003BEditController0x003BGQController0x003BRQController
Class/BaseController/APIMethod/__TOCDet/Assembly = ARCAPI
Class/BaseController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/BaseController/APIMethod/__TOCDet/DocFragType = ClassMember
Class/BaseController/APIMethod/__TOCDet/IsInherited = False
Class/BaseController/APIMethod/__TOCDet/IsInheritedDoc = False
Class/BaseController/APIMethod/__TOCDet/Lines = 3
Class/BaseController/APIMethod/__TOCDet/Name = APIMethod
Class/BaseController/APIMethod/__TOCDet/Namespace = ARCAPI
Class/BaseController/APIMethod/__TOCDet/Type = BaseController
Class/BaseController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
Class/BaseController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/BaseController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
Class/BaseController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
Class/BaseController/BuildControllerStorage/__TOCDet/Assembly = ARCAPI
Class/BaseController/BuildControllerStorage/__TOCDet/Description = Builds a collection of 'std' (standard) controller instances to use for serving API requests.0x000D0x000A0x000D0x000AReflection is used to search the 'assemblies' parameter for classes implementing -BaseController-.0x000D0x000A0x000D0x000ANote that if the returned storage is coupled to the -PropertyStream- then additional elements may be added later, either through API methods or through -Subscription- (or the 'std' instances' properties may also be changed, through the same mechanisms).0x000D0x000A0x000D0x000ATODO: Consider moving this method to -DataStorage-.
Class/BaseController/BuildControllerStorage/__TOCDet/DocFragType = ClassMember
Class/BaseController/BuildControllerStorage/__TOCDet/IsInherited = False
Class/BaseController/BuildControllerStorage/__TOCDet/IsInheritedDoc = False
Class/BaseController/BuildControllerStorage/__TOCDet/Lines = 7
Class/BaseController/BuildControllerStorage/__TOCDet/Name = BuildControllerStorage
Class/BaseController/BuildControllerStorage/__TOCDet/Namespace = ARCAPI
Class/BaseController/BuildControllerStorage/__TOCDet/Type = BaseController
Class/BaseController/BuildControllerStorage/__TOCDet/Attribute/DeclaringType = BaseController
Class/BaseController/BuildControllerStorage/__TOCDet/Attribute/Description = Builds a collection of 'std' (standard) controller instances to use for serving API requests.0x000D0x000A0x000D0x000AReflection is used to search the 'assemblies' parameter for classes implementing -BaseController-.0x000D0x000A0x000D0x000ANote that if the returned storage is coupled to the -PropertyStream- then additional elements may be added later, either through API methods or through -Subscription- (or the 'std' instances' properties may also be changed, through the same mechanisms).0x000D0x000A0x000D0x000ATODO: Consider moving this method to -DataStorage-.
Class/BaseController/BuildControllerStorage/__TOCDet/Attribute/MethodName = BuildControllerStorage
Class/BaseController/BuildControllerStorage/__TOCDet/Attribute/MethodSignature = ARCCore.IP BuildControllerStorage(System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D)
Class/BaseController/CatchAll/__TOCDet/Assembly = ARCAPI
Class/BaseController/CatchAll/__TOCDet/Description = Serves the typical single generic API method in an AgoRapide API.0x000D0x000A0x000D0x000AFinds the correct controller to handle the query (from -ControllerStorage), and returns result from that controller.0x000D0x000A0x000D0x000AThe API-routing corresponds to the type name of the controller (without the 'Controller' part if desired) and optionally the ~id of the controller when other than the standard instance.0x000D0x000AFor -RQController-, the routing would typically be like this:0x000D0x000A  'RQ/0x005Bparameters0x005D'  (identical to 'RQController/0x005Bparameters0x005D').0x000D0x000AThe debug instance is available like this:0x000D0x000A  'RQ~dbg/0x005Bparameters0x005D'  (identical to 'RQ/~dbg/0x005Bparameters0x005D' / 'RQController~dbg/0x005Bparameters0x005D' / 'RQController/~dbg/0x005Bparameters0x005D').0x000D0x000A0x000D0x000AIf query does not 'reach' any controller, routing information is returned instead (from -ControllerStorage-).0x000D0x000AFor instance querying nothing at all will list corresponding information from -ControllerStorage- instead.0x000D0x000A0x000D0x000ANote how uses -Lock- in order to be thread safe in connection with -OutsideLocalReceiver-.
Class/BaseController/CatchAll/__TOCDet/DocFragType = ClassMember
Class/BaseController/CatchAll/__TOCDet/IsInherited = False
Class/BaseController/CatchAll/__TOCDet/IsInheritedDoc = False
Class/BaseController/CatchAll/__TOCDet/Lines = 14
Class/BaseController/CatchAll/__TOCDet/Name = CatchAll
Class/BaseController/CatchAll/__TOCDet/Namespace = ARCAPI
Class/BaseController/CatchAll/__TOCDet/Type = BaseController
Class/BaseController/CatchAll/__TOCDet/Attribute/DeclaringType = BaseController
Class/BaseController/CatchAll/__TOCDet/Attribute/Description = Serves the typical single generic API method in an AgoRapide API.0x000D0x000A0x000D0x000AFinds the correct controller to handle the query (from -ControllerStorage), and returns result from that controller.0x000D0x000A0x000D0x000AThe API-routing corresponds to the type name of the controller (without the 'Controller' part if desired) and optionally the ~id of the controller when other than the standard instance.0x000D0x000AFor -RQController-, the routing would typically be like this:0x000D0x000A  'RQ/0x005Bparameters0x005D'  (identical to 'RQController/0x005Bparameters0x005D').0x000D0x000AThe debug instance is available like this:0x000D0x000A  'RQ~dbg/0x005Bparameters0x005D'  (identical to 'RQ/~dbg/0x005Bparameters0x005D' / 'RQController~dbg/0x005Bparameters0x005D' / 'RQController/~dbg/0x005Bparameters0x005D').0x000D0x000A0x000D0x000AIf query does not 'reach' any controller, routing information is returned instead (from -ControllerStorage-).0x000D0x000AFor instance querying nothing at all will list corresponding information from -ControllerStorage- instead.0x000D0x000A0x000D0x000ANote how uses -Lock- in order to be thread safe in connection with -OutsideLocalReceiver-.
Class/BaseController/CatchAll/__TOCDet/Attribute/MethodName = CatchAll
Class/BaseController/CatchAll/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult CatchAll(System.String, System.String, ARCAPI.DataStorage)
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Assembly = ARCAPI
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Description = Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).0x000D0x000A0x000D0x000AFor Requests ending with /.html HTML-format is assumed, for .json JSON is assumed and so on.0x000D0x000A0x000D0x000ADefault format is -HTML-.0x000D0x000A0x000D0x000A.json may be given as .json0x007Bdepth0x007D indicating to which depth the serialization mechanism should work. 1 is default.0x000D0x000A0x000D0x000AIf a format is specified (as the end-item in the request item list) then that corresponding item is removed from list.0x000D0x000A0x000D0x000ATODO: Improve this, especially the index.html-part which is not generic
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/DocFragType = ClassMember
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/IsInherited = False
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/IsInheritedDoc = False
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Lines = 11
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Name = GetFormatAndAdjustRequest
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Namespace = ARCAPI
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Type = BaseController
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/DeclaringType = BaseController
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/Description = Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).0x000D0x000A0x000D0x000AFor Requests ending with /.html HTML-format is assumed, for .json JSON is assumed and so on.0x000D0x000A0x000D0x000ADefault format is -HTML-.0x000D0x000A0x000D0x000A.json may be given as .json0x007Bdepth0x007D indicating to which depth the serialization mechanism should work. 1 is default.0x000D0x000A0x000D0x000AIf a format is specified (as the end-item in the request item list) then that corresponding item is removed from list.0x000D0x000A0x000D0x000ATODO: Improve this, especially the index.html-part which is not generic
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/MethodName = GetFormatAndAdjustRequest
Class/BaseController/GetFormatAndAdjustRequest/__TOCDet/Attribute/MethodSignature = System.ValueTuple0x006020x005BARCAPI.ResponseFormat,System.Int320x005D GetFormatAndAdjustRequest(System.Collections.Generic.List0x006010x005BSystem.String0x005D ByRef)
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Assembly = ARCAPI
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Description = If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.0x000D0x000AOtherwise, empty string is returned.
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/DocFragType = ClassMember
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/IsInherited = False
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/IsInheritedDoc = False
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Lines = 2
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Name = GetTimestampIsOldWarningHTML
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Namespace = ARCAPI
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Type = BaseController
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/DeclaringType = BaseController
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/Description = If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.0x000D0x000AOtherwise, empty string is returned.
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/MethodName = GetTimestampIsOldWarningHTML
Class/BaseController/GetTimestampIsOldWarningHTML/__TOCDet/Attribute/MethodSignature = System.String GetTimestampIsOldWarningHTML(ARCCore.IP)
Class/BaseController/ToString/__TOCDet/Assembly = ARCAPI
Class/BaseController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/BaseController/ToString/__TOCDet/DocFragType = ClassMember
Class/BaseController/ToString/__TOCDet/IsInherited = True
Class/BaseController/ToString/__TOCDet/IsInheritedDoc = True
Class/BaseController/ToString/__TOCDet/Name = ToString
Class/BaseController/ToString/__TOCDet/Namespace = ARCAPI
Class/BaseController/ToString/__TOCDet/Type = BaseController
Class/BaseController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
Class/BaseController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/BaseController/ToString/__TOCDet/Attribute/MethodName = ToString
Class/BaseController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Assembly = ARCAPI
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Description = Navigates to the specified level (usually within -Storage-).0x000D0x000A0x000D0x000AIf unsuccesful returns a corresponding error message with link to last 'correct' level.0x000D0x000AExample: If attempting to navigate to 'Customer/42/MiddleName' but 'MiddleName' does not exist, will offer link to Customer/42.0x000D0x000A0x000D0x000AIf unsuccessful, then the out-parameter errorResponseHTML will also contain an eventual warning from -GetTimestampIsOldWarningHTML-.0x000D0x000AThis is pertinent in cases where the actual key has just not been read yet from the -PropertyStream--storage.0x000D0x000A0x000D0x000AAlso able to understand and parse -QueryExpression-.0x000D0x000A0x000D0x000ANote that also used for navigating within -ControllerStorage-, that is, to route an API-method to the desired controller.0x000D0x000A0x000D0x000ATODO: This concept is quite generic. It is useful also in console applications and similar.0x000D0x000ATODO: Move to ARCCore instead.
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/DocFragType = ClassMember
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/IsInherited = False
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/IsInheritedDoc = False
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Lines = 14
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Name = TryNavigateToLevelInDataStorage
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Namespace = ARCAPI
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Type = BaseController
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/DeclaringType = BaseController
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/Description = Navigates to the specified level (usually within -Storage-).0x000D0x000A0x000D0x000AIf unsuccesful returns a corresponding error message with link to last 'correct' level.0x000D0x000AExample: If attempting to navigate to 'Customer/42/MiddleName' but 'MiddleName' does not exist, will offer link to Customer/42.0x000D0x000A0x000D0x000AIf unsuccessful, then the out-parameter errorResponseHTML will also contain an eventual warning from -GetTimestampIsOldWarningHTML-.0x000D0x000AThis is pertinent in cases where the actual key has just not been read yet from the -PropertyStream--storage.0x000D0x000A0x000D0x000AAlso able to understand and parse -QueryExpression-.0x000D0x000A0x000D0x000ANote that also used for navigating within -ControllerStorage-, that is, to route an API-method to the desired controller.0x000D0x000A0x000D0x000ATODO: This concept is quite generic. It is useful also in console applications and similar.0x000D0x000ATODO: Move to ARCCore instead.
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/MethodName = TryNavigateToLevelInDataStorage
Class/BaseController/TryNavigateToLevelInDataStorage/__TOCDet/Attribute/MethodSignature = Boolean TryNavigateToLevelInDataStorage(ARCAPI.DataStorage, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, ARCAPI.BaseController, System.ValueTuple0x006020x005BSystem.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D,ARCCore.IP0x005D ByRef, System.String ByRef, ARCCore.IP)
Class/ContentResult/__TOCDet/Assembly = ARCAPI
Class/ContentResult/__TOCDet/Description = Mimicks Microsoft.AspNetCore.Mvc.ContentResult.0x000D0x000A0x000D0x000ANote that although -ARCAPI- is supposed to work with a Microsoft.AspNetCore.Mvc application, it does not link to the Microsoft.AspNetCore.Mvc library itself.0x000D0x000ATherefore the returned instance from controller methods like -APIMethod- or -APIMethod-) is not an instance of Microsoft.AspNetCore.Mvc.ContentResult (or Microsoft.AspNetCore.Mvc.ActionResult) but rather an instance of this class, AgoRapide -ContentResult-.0x000D0x000A0x000D0x000AThis class reflects the components needed to construct a Microsoft.AspNetCore.Mvc.ContentResult instance, namely 0x000D0x000A'(string Content, string ContentType, System.Net.HttpStatusCode StatusCode)'.0x000D0x000A0x000D0x000AThis class is immutable.0x000D0x000A
Class/ContentResult/__TOCDet/DocFragType = Class
Class/ContentResult/__TOCDet/Name = ContentResult
Class/ContentResult/__TOCDet/Namespace = ARCAPI
Class/ContentResult/__TOCDet/Type = ContentResult
Class/ContentResult/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/ContentResult/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/ContentResult/__TOCDet/Attribute/ClassType = ContentResult
Class/ContentResult/__TOCDet/Attribute/Description = Mimicks Microsoft.AspNetCore.Mvc.ContentResult.0x000D0x000A0x000D0x000ANote that although -ARCAPI- is supposed to work with a Microsoft.AspNetCore.Mvc application, it does not link to the Microsoft.AspNetCore.Mvc library itself.0x000D0x000ATherefore the returned instance from controller methods like -APIMethod- or -APIMethod-) is not an instance of Microsoft.AspNetCore.Mvc.ContentResult (or Microsoft.AspNetCore.Mvc.ActionResult) but rather an instance of this class, AgoRapide -ContentResult-.0x000D0x000A0x000D0x000AThis class reflects the components needed to construct a Microsoft.AspNetCore.Mvc.ContentResult instance, namely 0x000D0x000A'(string Content, string ContentType, System.Net.HttpStatusCode StatusCode)'.0x000D0x000A0x000D0x000AThis class is immutable.0x000D0x000A
Class/ContentResult/CreateError/__TOCDet/Assembly = ARCAPI
Class/ContentResult/CreateError/__TOCDet/Description = TODO: Add a key / value format for error messages, like done for -Log-.
Class/ContentResult/CreateError/__TOCDet/DocFragType = ClassMember
Class/ContentResult/CreateError/__TOCDet/IsInherited = False
Class/ContentResult/CreateError/__TOCDet/IsInheritedDoc = False
Class/ContentResult/CreateError/__TOCDet/Lines = 1
Class/ContentResult/CreateError/__TOCDet/Name = CreateError
Class/ContentResult/CreateError/__TOCDet/Namespace = ARCAPI
Class/ContentResult/CreateError/__TOCDet/Type = ContentResult
Class/ContentResult/CreateError/__TOCDet/Attribute/DeclaringType = ContentResult
Class/ContentResult/CreateError/__TOCDet/Attribute/Description = TODO: Add a key / value format for error messages, like done for -Log-.
Class/ContentResult/CreateError/__TOCDet/Attribute/MethodName = CreateError
Class/ContentResult/CreateError/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult CreateError(ARCAPI.ResponseFormat, System.String)
Class/ContentResult/CreateHTMLOK/__TOCDet/Assembly = ARCAPI
Class/ContentResult/CreateHTMLOK/__TOCDet/Description = NOTE: Parameter must be a complete HTML page.0x000D0x000AHINT: Use -GenerateHTMLPage- in order to create parameter.
Class/ContentResult/CreateHTMLOK/__TOCDet/DocFragType = ClassMember
Class/ContentResult/CreateHTMLOK/__TOCDet/IsInherited = False
Class/ContentResult/CreateHTMLOK/__TOCDet/IsInheritedDoc = False
Class/ContentResult/CreateHTMLOK/__TOCDet/Lines = 2
Class/ContentResult/CreateHTMLOK/__TOCDet/Name = CreateHTMLOK
Class/ContentResult/CreateHTMLOK/__TOCDet/Namespace = ARCAPI
Class/ContentResult/CreateHTMLOK/__TOCDet/Type = ContentResult
Class/ContentResult/CreateHTMLOK/__TOCDet/Attribute/DeclaringType = ContentResult
Class/ContentResult/CreateHTMLOK/__TOCDet/Attribute/Description = NOTE: Parameter must be a complete HTML page.0x000D0x000AHINT: Use -GenerateHTMLPage- in order to create parameter.
Class/ContentResult/CreateHTMLOK/__TOCDet/Attribute/MethodName = CreateHTMLOK
Class/ContentResult/CreateHTMLOK/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult CreateHTMLOK(System.String)
Class/DataStorage/__TOCDet/Assembly = ARCAPI
Class/DataStorage/__TOCDet/Description = The all-in-memory global application data storage.0x000D0x000A0x000D0x000ADoes also contain the necessary global locking object for thread-safe access (-Lock-).0x000D0x000A0x000D0x000AIs usually accessed within -ARAAPI- as a static instance Program.DataStorage.0x000D0x000A0x000D0x000ACan be kept up to date by -Subscription- to -PropertyStream- (see -OutsideLocalReceiver-).0x000D0x000A0x000D0x000AWill usually contain (in addition to -dt-), also other 'branches' like -app- and -doc-.0x000D0x000A0x000D0x000ASee constructor for information about -ExposingApplicationState- through this class.0x000D0x000A0x000D0x000AThis class is immutable.
Class/DataStorage/__TOCDet/DocFragType = Class
Class/DataStorage/__TOCDet/Name = DataStorage
Class/DataStorage/__TOCDet/Namespace = ARCAPI
Class/DataStorage/__TOCDet/Type = DataStorage
Class/DataStorage/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/DataStorage/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/DataStorage/__TOCDet/Attribute/ClassType = DataStorage
Class/DataStorage/__TOCDet/Attribute/Description = The all-in-memory global application data storage.0x000D0x000A0x000D0x000ADoes also contain the necessary global locking object for thread-safe access (-Lock-).0x000D0x000A0x000D0x000AIs usually accessed within -ARAAPI- as a static instance Program.DataStorage.0x000D0x000A0x000D0x000ACan be kept up to date by -Subscription- to -PropertyStream- (see -OutsideLocalReceiver-).0x000D0x000A0x000D0x000AWill usually contain (in addition to -dt-), also other 'branches' like -app- and -doc-.0x000D0x000A0x000D0x000ASee constructor for information about -ExposingApplicationState- through this class.0x000D0x000A0x000D0x000AThis class is immutable.
Class/DataStorage/.ctor/__TOCDet/Assembly = ARCAPI
Class/DataStorage/.ctor/__TOCDet/Description = This method will:0x000D0x000AInitialize -Storage-,0x000D0x000AInitialize -ControllerStorage-.0x000D0x000A
Class/DataStorage/.ctor/__TOCDet/DocFragType = ClassMember
Class/DataStorage/.ctor/__TOCDet/IsInherited = False
Class/DataStorage/.ctor/__TOCDet/IsInheritedDoc = False
Class/DataStorage/.ctor/__TOCDet/Lines = 4
Class/DataStorage/.ctor/__TOCDet/Name = .ctor
Class/DataStorage/.ctor/__TOCDet/Namespace = ARCAPI
Class/DataStorage/.ctor/__TOCDet/Type = DataStorage
Class/DataStorage/.ctor/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/.ctor/__TOCDet/Attribute/Description = This method will:0x000D0x000AInitialize -Storage-,0x000D0x000AInitialize -ControllerStorage-.0x000D0x000A
Class/DataStorage/.ctor/__TOCDet/Attribute/MethodName = .ctor
Class/DataStorage/.ctor/__TOCDet/Attribute/MethodSignature = Void .ctor(ARCCore.IK, System.Collections.Generic.IEnumerable0x006010x005BSystem.Reflection.Assembly0x005D, Boolean, ARCCore.IP)
Class/DataStorage/ControllerStorage/__TOCDet/Assembly = ARCAPI
Class/DataStorage/ControllerStorage/__TOCDet/Description = Usually (but not always) a branch of -Storage- (like Storage0x005B"log"0x005D0x005B"0x007BnodeId0x007D"0x005D0x005B"Controller"0x005D).0x000D0x000A0x000D0x000AEnables -BaseController-.- CatchAll- to dispatch an API request to the correct controller.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for documentation.0x000D0x000A0x000D0x000A
Class/DataStorage/ControllerStorage/__TOCDet/DocFragType = ClassMember
Class/DataStorage/ControllerStorage/__TOCDet/IsInherited = False
Class/DataStorage/ControllerStorage/__TOCDet/IsInheritedDoc = False
Class/DataStorage/ControllerStorage/__TOCDet/Lines = 7
Class/DataStorage/ControllerStorage/__TOCDet/Name = ControllerStorage
Class/DataStorage/ControllerStorage/__TOCDet/Namespace = ARCAPI
Class/DataStorage/ControllerStorage/__TOCDet/Type = DataStorage
Class/DataStorage/ControllerStorage/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/ControllerStorage/__TOCDet/Attribute/Description = Usually (but not always) a branch of -Storage- (like Storage0x005B"log"0x005D0x005B"0x007BnodeId0x007D"0x005D0x005B"Controller"0x005D).0x000D0x000A0x000D0x000AEnables -BaseController-.- CatchAll- to dispatch an API request to the correct controller.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for documentation.0x000D0x000A0x000D0x000A
Class/DataStorage/ControllerStorage/__TOCDet/Attribute/MethodName = ControllerStorage
Class/DataStorage/ControllerStorage/__TOCDet/Attribute/MethodSignature = ARCCore.IP ControllerStorage
Class/DataStorage/Create/__TOCDet/Assembly = ARCAPI
Class/DataStorage/Create/__TOCDet/Description = Creates a -DataStorage- instance with default parameters.0x000D0x000A0x000D0x000ANote: You are not obliged to use this method, you can call constructor directly instead and set up this instance 'manually'.0x000D0x000A0x000D0x000AThis method will:0x000D0x000ACall constructor with assemblies from -UtilCore-.-Assemblies- and -DoNotStoreInternally- FALSE,0x000D0x000ACreate -dt- container (if not already set)r0x000ACreate -doc- container with -Documentator-,0x000D0x000ASet -DocLinks-,0x000D0x000AConnect -ExternalReceiver- to -SendFromLocalOrigin- and0x000D0x000ACreate -app- container with data about -StreamProcessor-, -ControllerStorage-, -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom-.
Class/DataStorage/Create/__TOCDet/DocFragType = ClassMember
Class/DataStorage/Create/__TOCDet/IsInherited = False
Class/DataStorage/Create/__TOCDet/IsInheritedDoc = False
Class/DataStorage/Create/__TOCDet/Lines = 10
Class/DataStorage/Create/__TOCDet/Name = Create
Class/DataStorage/Create/__TOCDet/Namespace = ARCAPI
Class/DataStorage/Create/__TOCDet/Type = DataStorage
Class/DataStorage/Create/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/Create/__TOCDet/Attribute/Description = Creates a -DataStorage- instance with default parameters.0x000D0x000A0x000D0x000ANote: You are not obliged to use this method, you can call constructor directly instead and set up this instance 'manually'.0x000D0x000A0x000D0x000AThis method will:0x000D0x000ACall constructor with assemblies from -UtilCore-.-Assemblies- and -DoNotStoreInternally- FALSE,0x000D0x000ACreate -dt- container (if not already set)r0x000ACreate -doc- container with -Documentator-,0x000D0x000ASet -DocLinks-,0x000D0x000AConnect -ExternalReceiver- to -SendFromLocalOrigin- and0x000D0x000ACreate -app- container with data about -StreamProcessor-, -ControllerStorage-, -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom-.
Class/DataStorage/Create/__TOCDet/Attribute/MethodName = Create
Class/DataStorage/Create/__TOCDet/Attribute/MethodSignature = ARCAPI.DataStorage Create(ARCCore.IK, ARCCore.IP, ARCCore.StreamProcessor)
Class/DataStorage/DocLinks/__TOCDet/Assembly = ARCAPI
Class/DataStorage/DocLinks/__TOCDet/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A
Class/DataStorage/DocLinks/__TOCDet/DocFragType = ClassMember
Class/DataStorage/DocLinks/__TOCDet/IsInherited = False
Class/DataStorage/DocLinks/__TOCDet/IsInheritedDoc = False
Class/DataStorage/DocLinks/__TOCDet/Lines = 13
Class/DataStorage/DocLinks/__TOCDet/Name = DocLinks
Class/DataStorage/DocLinks/__TOCDet/Namespace = ARCAPI
Class/DataStorage/DocLinks/__TOCDet/Type = DataStorage
Class/DataStorage/DocLinks/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/DocLinks/__TOCDet/Attribute/Description = Note that may be null.0x000D0x000A0x000D0x000AA collection of relevant keys from -Storage-, usually limited to Storage0x005B"doc"0x005D.0x000D0x000A0x000D0x000AEnables -LinkInsertionInDocumentation-.0x000D0x000AOriginates (normally) from -DocLinkCollection-.-Create-.0x000D0x000A0x000D0x000AMost relevant when querying (static) documentation because when storage is static then this parameter can be pre-calculated at application startup.0x000D0x000AIf on the other hand storage is dynamically updated throughout the application lifetime then this parameter must also be continously updated, something which could have an unacceptable performance impact.0x000D0x000A0x000D0x000AOften set at application startup with links to (static) documentation.0x000D0x000AThis will improve error message for instance, by enabling linking directy to the documentation in the error message.0x000D0x000A
Class/DataStorage/DocLinks/__TOCDet/Attribute/MethodName = DocLinks
Class/DataStorage/DocLinks/__TOCDet/Attribute/MethodSignature = ARCDoc.DocLinkCollection DocLinks
Class/DataStorage/DoNotStoreInternally/__TOCDet/Assembly = ARCAPI
Class/DataStorage/DoNotStoreInternally/__TOCDet/Description = Typically used by -AddController-.0x000D0x000A0x000D0x000ASignals that properties should not be added to -DataStorage- directly. 0x000D0x000AWill typically be used in situations where one wants to ensure that data is actually added to -CoreDB- before showing it in the API. This would again typically be implemented by using -ExternalReceiver- and waiting for the data to come back over a -Subscription- to the -PropertyStream-.0x000D0x000A0x000D0x000ANOTE: As of Jun 2020 there is no mechanism in AgoRapide for ensuring that this actually happens other than for the client to use polling against the API to ensure that the round-trip to the core and back has completed.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
Class/DataStorage/DoNotStoreInternally/__TOCDet/DocFragType = ClassMember
Class/DataStorage/DoNotStoreInternally/__TOCDet/IsInherited = False
Class/DataStorage/DoNotStoreInternally/__TOCDet/IsInheritedDoc = False
Class/DataStorage/DoNotStoreInternally/__TOCDet/Lines = 8
Class/DataStorage/DoNotStoreInternally/__TOCDet/Name = DoNotStoreInternally
Class/DataStorage/DoNotStoreInternally/__TOCDet/Namespace = ARCAPI
Class/DataStorage/DoNotStoreInternally/__TOCDet/Type = DataStorage
Class/DataStorage/DoNotStoreInternally/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/DoNotStoreInternally/__TOCDet/Attribute/Description = Typically used by -AddController-.0x000D0x000A0x000D0x000ASignals that properties should not be added to -DataStorage- directly. 0x000D0x000AWill typically be used in situations where one wants to ensure that data is actually added to -CoreDB- before showing it in the API. This would again typically be implemented by using -ExternalReceiver- and waiting for the data to come back over a -Subscription- to the -PropertyStream-.0x000D0x000A0x000D0x000ANOTE: As of Jun 2020 there is no mechanism in AgoRapide for ensuring that this actually happens other than for the client to use polling against the API to ensure that the round-trip to the core and back has completed.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
Class/DataStorage/DoNotStoreInternally/__TOCDet/Attribute/MethodName = DoNotStoreInternally
Class/DataStorage/DoNotStoreInternally/__TOCDet/Attribute/MethodSignature = Boolean DoNotStoreInternally
Class/DataStorage/ExternalReceiver/__TOCDet/Assembly = ARCAPI
Class/DataStorage/ExternalReceiver/__TOCDet/Description = Typically used by -AddController-. 0x000D0x000AWill normally be a method calling -SendFromLocalOrigin-.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
Class/DataStorage/ExternalReceiver/__TOCDet/DocFragType = ClassMember
Class/DataStorage/ExternalReceiver/__TOCDet/IsInherited = False
Class/DataStorage/ExternalReceiver/__TOCDet/IsInheritedDoc = False
Class/DataStorage/ExternalReceiver/__TOCDet/Lines = 4
Class/DataStorage/ExternalReceiver/__TOCDet/Name = ExternalReceiver
Class/DataStorage/ExternalReceiver/__TOCDet/Namespace = ARCAPI
Class/DataStorage/ExternalReceiver/__TOCDet/Type = DataStorage
Class/DataStorage/ExternalReceiver/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/ExternalReceiver/__TOCDet/Attribute/Description = Typically used by -AddController-. 0x000D0x000AWill normally be a method calling -SendFromLocalOrigin-.0x000D0x000A0x000D0x000ANote: It is meaningless to have -DoNotStoreInternally = FALSE and -ExternalReceiver- = NULL at the same time.
Class/DataStorage/ExternalReceiver/__TOCDet/Attribute/MethodName = ExternalReceiver
Class/DataStorage/ExternalReceiver/__TOCDet/Attribute/MethodSignature = System.Action0x006010x005BSystem.String0x005D ExternalReceiver
Class/DataStorage/Lock/__TOCDet/Assembly = ARCAPI
Class/DataStorage/Lock/__TOCDet/Description = Locking object for thread-safe access from simultaneous API requests.0x000D0x000AAlso used when keeping storage up-to-date by -Subscription- to -PropertyStream- through -OutsideLocalReceiver-.
Class/DataStorage/Lock/__TOCDet/DocFragType = ClassMember
Class/DataStorage/Lock/__TOCDet/IsInherited = False
Class/DataStorage/Lock/__TOCDet/IsInheritedDoc = False
Class/DataStorage/Lock/__TOCDet/Lines = 2
Class/DataStorage/Lock/__TOCDet/Name = Lock
Class/DataStorage/Lock/__TOCDet/Namespace = ARCAPI
Class/DataStorage/Lock/__TOCDet/Type = DataStorage
Class/DataStorage/Lock/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/Lock/__TOCDet/Attribute/Description = Locking object for thread-safe access from simultaneous API requests.0x000D0x000AAlso used when keeping storage up-to-date by -Subscription- to -PropertyStream- through -OutsideLocalReceiver-.
Class/DataStorage/Lock/__TOCDet/Attribute/MethodName = Lock
Class/DataStorage/Lock/__TOCDet/Attribute/MethodSignature = System.Threading.ReaderWriterLockSlim Lock
Class/DataStorage/Storage/__TOCDet/Assembly = ARCAPI
Class/DataStorage/Storage/__TOCDet/Description = The actual storage.0x000D0x000A0x000D0x000AThe root-pointer to all objects stored.
Class/DataStorage/Storage/__TOCDet/DocFragType = ClassMember
Class/DataStorage/Storage/__TOCDet/IsInherited = False
Class/DataStorage/Storage/__TOCDet/IsInheritedDoc = False
Class/DataStorage/Storage/__TOCDet/Lines = 3
Class/DataStorage/Storage/__TOCDet/Name = Storage
Class/DataStorage/Storage/__TOCDet/Namespace = ARCAPI
Class/DataStorage/Storage/__TOCDet/Type = DataStorage
Class/DataStorage/Storage/__TOCDet/Attribute/DeclaringType = DataStorage
Class/DataStorage/Storage/__TOCDet/Attribute/Description = The actual storage.0x000D0x000A0x000D0x000AThe root-pointer to all objects stored.
Class/DataStorage/Storage/__TOCDet/Attribute/MethodName = Storage
Class/DataStorage/Storage/__TOCDet/Attribute/MethodSignature = ARCCore.IP Storage
Class/EditController/__TOCDet/Assembly = ARCAPI
Class/EditController/__TOCDet/Description = Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000AThe HTML form offered will POST directly to -AddController- with the postData-parameter set.0x000D0x000A0x000D0x000ATODO: Note that -JSON- is currently not supported.0x000D0x000ATODO: It might appear to be irrelevant, but it could contain the basic elements for building an HTML editing environment,0x000D0x000ATODO: enabling to client to construct its own HTML page.
Class/EditController/__TOCDet/DocFragType = Class
Class/EditController/__TOCDet/Name = EditController
Class/EditController/__TOCDet/Namespace = ARCAPI
Class/EditController/__TOCDet/Type = EditController
Class/EditController/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/EditController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
Class/EditController/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/EditController/__TOCDet/Attribute/ClassType = EditController
Class/EditController/__TOCDet/Attribute/Description = Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000AThe HTML form offered will POST directly to -AddController- with the postData-parameter set.0x000D0x000A0x000D0x000ATODO: Note that -JSON- is currently not supported.0x000D0x000ATODO: It might appear to be irrelevant, but it could contain the basic elements for building an HTML editing environment,0x000D0x000ATODO: enabling to client to construct its own HTML page.
Class/EditController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Class/EditController/APIMethod/__TOCDet/Assembly = ARCAPI
Class/EditController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/EditController/APIMethod/__TOCDet/DocFragType = ClassMember
Class/EditController/APIMethod/__TOCDet/IsInherited = False
Class/EditController/APIMethod/__TOCDet/IsInheritedDoc = True
Class/EditController/APIMethod/__TOCDet/Name = APIMethod
Class/EditController/APIMethod/__TOCDet/Namespace = ARCAPI
Class/EditController/APIMethod/__TOCDet/Type = EditController
Class/EditController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
Class/EditController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/EditController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
Class/EditController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
Class/EditController/ToString/__TOCDet/Assembly = ARCAPI
Class/EditController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/EditController/ToString/__TOCDet/DocFragType = ClassMember
Class/EditController/ToString/__TOCDet/IsInherited = True
Class/EditController/ToString/__TOCDet/IsInheritedDoc = True
Class/EditController/ToString/__TOCDet/Name = ToString
Class/EditController/ToString/__TOCDet/Namespace = ARCAPI
Class/EditController/ToString/__TOCDet/Type = EditController
Class/EditController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
Class/EditController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/EditController/ToString/__TOCDet/Attribute/MethodName = ToString
Class/EditController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
Class/GQController/__TOCDet/Assembly = ARCAPI
Class/GQController/__TOCDet/Description = Offers GraphQL queries.0x000D0x000A0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A
Class/GQController/__TOCDet/DocFragType = Class
Class/GQController/__TOCDet/Name = GQController
Class/GQController/__TOCDet/Namespace = ARCAPI
Class/GQController/__TOCDet/Type = GQController
Class/GQController/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/GQController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
Class/GQController/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/GQController/__TOCDet/Attribute/ClassType = GQController
Class/GQController/__TOCDet/Attribute/Description = Offers GraphQL queries.0x000D0x000A0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A
Class/GQController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Class/GQController/APIMethod/__TOCDet/Assembly = ARCAPI
Class/GQController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/GQController/APIMethod/__TOCDet/DocFragType = ClassMember
Class/GQController/APIMethod/__TOCDet/IsInherited = False
Class/GQController/APIMethod/__TOCDet/IsInheritedDoc = True
Class/GQController/APIMethod/__TOCDet/Name = APIMethod
Class/GQController/APIMethod/__TOCDet/Namespace = ARCAPI
Class/GQController/APIMethod/__TOCDet/Type = GQController
Class/GQController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
Class/GQController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/GQController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
Class/GQController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
Class/GQController/ToString/__TOCDet/Assembly = ARCAPI
Class/GQController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/GQController/ToString/__TOCDet/DocFragType = ClassMember
Class/GQController/ToString/__TOCDet/IsInherited = True
Class/GQController/ToString/__TOCDet/IsInheritedDoc = True
Class/GQController/ToString/__TOCDet/Name = ToString
Class/GQController/ToString/__TOCDet/Namespace = ARCAPI
Class/GQController/ToString/__TOCDet/Type = GQController
Class/GQController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
Class/GQController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/GQController/ToString/__TOCDet/Attribute/MethodName = ToString
Class/GQController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
Class/RQController/__TOCDet/Assembly = ARCAPI
Class/RQController/__TOCDet/Description = RQ = REST Query. Executes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000AThis class understands two main query-methods, 1) Direct key-based into data storage, and 2) -QueryExpression- based.0x000D0x000A0x000D0x000A1) Direct key-based into data storage:0x000D0x000ASome query-examples:0x000D0x000A'Customer/42' =0x003E Get all the keys for Customer with id 42, but do not get sub-keys.0x000D0x000A'Customer/42/*' =0x003E Get all the keys for Customer with id 42, and also all underlying sub-keys (and their sub-keys and so on).0x000D0x000AAppend query with '.json' in order to get -JSON- (default is -HTML-) .0x000D0x000AFor -HTML- this controller is able to do -LinkInsertionInDocumentation-, presumed that -DocLinks- is set.0x000D0x000A0x000D0x000A2) -QueryExpression- based.0x000D0x000ASome query-examples:0x000D0x000A'Customer/WHERE FirstName = John/SELECT FirstName, LastName/SKIP 10/TAKE 10'0x000D0x000A(see -QueryExpression- for more examples).0x000D0x000A0x000D0x000A
Class/RQController/__TOCDet/DocFragType = Class
Class/RQController/__TOCDet/Name = RQController
Class/RQController/__TOCDet/Namespace = ARCAPI
Class/RQController/__TOCDet/Type = RQController
Class/RQController/__TOCDet/Attribute/AssemblyName = ARCAPI
Class/RQController/__TOCDet/Attribute/BaseTypes = PConcurrent0x003BBaseController
Class/RQController/__TOCDet/Attribute/ClassNamespace = ARCAPI
Class/RQController/__TOCDet/Attribute/ClassType = RQController
Class/RQController/__TOCDet/Attribute/Description = RQ = REST Query. Executes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000AThis class understands two main query-methods, 1) Direct key-based into data storage, and 2) -QueryExpression- based.0x000D0x000A0x000D0x000A1) Direct key-based into data storage:0x000D0x000ASome query-examples:0x000D0x000A'Customer/42' =0x003E Get all the keys for Customer with id 42, but do not get sub-keys.0x000D0x000A'Customer/42/*' =0x003E Get all the keys for Customer with id 42, and also all underlying sub-keys (and their sub-keys and so on).0x000D0x000AAppend query with '.json' in order to get -JSON- (default is -HTML-) .0x000D0x000AFor -HTML- this controller is able to do -LinkInsertionInDocumentation-, presumed that -DocLinks- is set.0x000D0x000A0x000D0x000A2) -QueryExpression- based.0x000D0x000ASome query-examples:0x000D0x000A'Customer/WHERE FirstName = John/SELECT FirstName, LastName/SKIP 10/TAKE 10'0x000D0x000A(see -QueryExpression- for more examples).0x000D0x000A0x000D0x000A
Class/RQController/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Class/RQController/APIMethod/__TOCDet/Assembly = ARCAPI
Class/RQController/APIMethod/__TOCDet/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/RQController/APIMethod/__TOCDet/DocFragType = ClassMember
Class/RQController/APIMethod/__TOCDet/IsInherited = False
Class/RQController/APIMethod/__TOCDet/IsInheritedDoc = True
Class/RQController/APIMethod/__TOCDet/Name = APIMethod
Class/RQController/APIMethod/__TOCDet/Namespace = ARCAPI
Class/RQController/APIMethod/__TOCDet/Type = RQController
Class/RQController/APIMethod/__TOCDet/Attribute/DeclaringType = BaseController
Class/RQController/APIMethod/__TOCDet/Attribute/Description = The (only) API method that this controller supports.0x000D0x000A0x000D0x000A
Class/RQController/APIMethod/__TOCDet/Attribute/MethodName = APIMethod
Class/RQController/APIMethod/__TOCDet/Attribute/MethodSignature = ARCAPI.ContentResult APIMethod(ARCAPI.ResponseFormat, Int32, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String, ARCAPI.DataStorage)
Class/RQController/ToString/__TOCDet/Assembly = ARCAPI
Class/RQController/ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/RQController/ToString/__TOCDet/DocFragType = ClassMember
Class/RQController/ToString/__TOCDet/IsInherited = True
Class/RQController/ToString/__TOCDet/IsInheritedDoc = True
Class/RQController/ToString/__TOCDet/Name = ToString
Class/RQController/ToString/__TOCDet/Namespace = ARCAPI
Class/RQController/ToString/__TOCDet/Type = RQController
Class/RQController/ToString/__TOCDet/Attribute/DeclaringType = PConcurrent
Class/RQController/ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
Class/RQController/ToString/__TOCDet/Attribute/MethodName = ToString
Class/RQController/ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
Enum/__TOCDet/_Description = All enums found in assembly ARCAPI
Enum/BaseControllerP/__TOCDet/Assembly = ARCAPI
Enum/BaseControllerP/__TOCDet/Description = Describes class -BaseController-.
Enum/BaseControllerP/__TOCDet/DocFragType = Enum
Enum/BaseControllerP/__TOCDet/Name = BaseControllerP
Enum/BaseControllerP/__TOCDet/Namespace = ARCAPI
Enum/BaseControllerP/__TOCDet/Type = BaseControllerP
Enum/BaseControllerP/__TOCDet/Attribute/AREnumType = PropertyKeyEnum
Enum/BaseControllerP/__TOCDet/Attribute/AssemblyName = ARCAPI
Enum/BaseControllerP/__TOCDet/Attribute/CorrespondingClass = BaseController
Enum/BaseControllerP/__TOCDet/Attribute/Description = Describes class -BaseController-.
Enum/BaseControllerP/__TOCDet/Attribute/EnumNamespace = ARCAPI
Enum/BaseControllerP/__TOCDet/Attribute/EnumType = BaseControllerP
Enum/BaseControllerP/CountException/__TOCDet/Assembly = ARCAPI
Enum/BaseControllerP/CountException/__TOCDet/Description = Number of exceptions at call to -APIMethod- since application initialization
Enum/BaseControllerP/CountException/__TOCDet/DocFragType = EnumMember
Enum/BaseControllerP/CountException/__TOCDet/Name = CountException
Enum/BaseControllerP/CountException/__TOCDet/Namespace = ARCAPI
Enum/BaseControllerP/CountException/__TOCDet/Type = BaseControllerP
Enum/BaseControllerP/CountException/__TOCDet/Attribute/Description = Number of exceptions at call to -APIMethod- since application initialization
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKLogAttribute/DoNotLogAtAll = True
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKLogAttribute/EnumMember = CountException
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKLogAttribute/EnumType = BaseControllerP
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/BoilerplateCodeProperties = // Autogenerated boilerplate code. Paste into your class as needed.0x000D0x000Apublic Int64 CountException0x007B0x000D0x000A  get =0x003E IP.GetPV0x003CInt640x003E(BaseControllerP.CountException)0x003B0x000D0x000A  set =0x003E IP.SetPV(BaseControllerP.CountException, value)0x003B0x000D0x000A0x007D0x000D0x000Apublic AddCountException(Int64 countException) =0x003E IP.AddPV(BaseControllerP.CountException, countException)0x003B0x000D0x000Apublic Int64? GetCountException() =0x003E TryGetCountException(out var retval) ? retval : null0x003B0x000D0x000Apublic Int64 GetCountException(Int64 defaultValue) =0x003E TryGetCountException(out var retval) ? retval : defaultValue0x003B0x000D0x000Apublic bool TryGetCountException(out Int64 countException) =0x003E IP.TryGetPV(BaseControllerP.CountException, out countException)0x003B0x000D0x000A0x000D0x000A0x000D0x000A
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/Cardinality = HistoryOnly
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/Description = Number of exceptions at call to -APIMethod- since application initialization
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/EnumMember = CountException
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/EnumType = BaseControllerP
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/IsObligatory = False
Enum/BaseControllerP/CountException/__TOCDet/Attribute/PKTypeAttribute/Type = Int64
Enum/BaseControllerP/CountRequest/__TOCDet/Assembly = ARCAPI
Enum/BaseControllerP/CountRequest/__TOCDet/Description = Number of calls to -APIMethod- since application initialization
Enum/BaseControllerP/CountRequest/__TOCDet/DocFragType = EnumMember
Enum/BaseControllerP/CountRequest/__TOCDet/Name = CountRequest
Enum/BaseControllerP/CountRequest/__TOCDet/Namespace = ARCAPI
Enum/BaseControllerP/CountRequest/__TOCDet/Type = BaseControllerP
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/Description = Number of calls to -APIMethod- since application initialization
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKLogAttribute/DoNotLogAtAll = True
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKLogAttribute/EnumMember = CountRequest
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKLogAttribute/EnumType = BaseControllerP
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/BoilerplateCodeProperties = // Autogenerated boilerplate code. Paste into your class as needed.0x000D0x000Apublic Int64 CountRequest0x007B0x000D0x000A  get =0x003E IP.GetPV0x003CInt640x003E(BaseControllerP.CountRequest)0x003B0x000D0x000A  set =0x003E IP.SetPV(BaseControllerP.CountRequest, value)0x003B0x000D0x000A0x007D0x000D0x000Apublic AddCountRequest(Int64 countRequest) =0x003E IP.AddPV(BaseControllerP.CountRequest, countRequest)0x003B0x000D0x000Apublic Int64? GetCountRequest() =0x003E TryGetCountRequest(out var retval) ? retval : null0x003B0x000D0x000Apublic Int64 GetCountRequest(Int64 defaultValue) =0x003E TryGetCountRequest(out var retval) ? retval : defaultValue0x003B0x000D0x000Apublic bool TryGetCountRequest(out Int64 countRequest) =0x003E IP.TryGetPV(BaseControllerP.CountRequest, out countRequest)0x003B0x000D0x000A0x000D0x000A0x000D0x000A
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/Cardinality = HistoryOnly
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/Description = Number of calls to -APIMethod- since application initialization
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/EnumMember = CountRequest
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/EnumType = BaseControllerP
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/IsObligatory = False
Enum/BaseControllerP/CountRequest/__TOCDet/Attribute/PKTypeAttribute/Type = Int64
Enum/BaseControllerP/LogLevel/__TOCDet/Assembly = ARCAPI
Enum/BaseControllerP/LogLevel/__TOCDet/DocFragType = EnumMember
Enum/BaseControllerP/LogLevel/__TOCDet/Name = LogLevel
Enum/BaseControllerP/LogLevel/__TOCDet/Namespace = ARCAPI
Enum/BaseControllerP/LogLevel/__TOCDet/Type = BaseControllerP
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKLogAttribute/DoNotLogAtAll = True
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKLogAttribute/EnumMember = LogLevel
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKLogAttribute/EnumType = BaseControllerP
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKTypeAttribute/BoilerplateCodeProperties = // Autogenerated boilerplate code. Paste into your class as needed.0x000D0x000Apublic String LogLevel0x007B0x000D0x000A  get =0x003E IP.GetPV0x003CString0x003E(BaseControllerP.LogLevel)0x003B0x000D0x000A  set =0x003E IP.SetPV(BaseControllerP.LogLevel, value)0x003B0x000D0x000A0x007D0x000D0x000Apublic AddLogLevel(String logLevel) =0x003E IP.AddPV(BaseControllerP.LogLevel, logLevel)0x003B0x000D0x000Apublic String? GetLogLevel() =0x003E TryGetLogLevel(out var retval) ? retval : null0x003B0x000D0x000Apublic String GetLogLevel(String defaultValue) =0x003E TryGetLogLevel(out var retval) ? retval : defaultValue0x003B0x000D0x000Apublic bool TryGetLogLevel(out String logLevel) =0x003E IP.TryGetPV(BaseControllerP.LogLevel, out logLevel)0x003B0x000D0x000A0x000D0x000A0x000D0x000A
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKTypeAttribute/Cardinality = HistoryOnly
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKTypeAttribute/EnumMember = LogLevel
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKTypeAttribute/EnumType = BaseControllerP
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKTypeAttribute/IsObligatory = False
Enum/BaseControllerP/LogLevel/__TOCDet/Attribute/PKTypeAttribute/Type = String
Enum/ResponseFormat/__TOCDet/Assembly = ARCAPI
Enum/ResponseFormat/__TOCDet/Description = The response format, HTML or JSON, for an API request.0x000D0x000A0x000D0x000ANote: Looking up documentation for individual members of this enum may be inconsistent because value may be interpreted as response format, not a key
Enum/ResponseFormat/__TOCDet/DocFragType = Enum
Enum/ResponseFormat/__TOCDet/Name = ResponseFormat
Enum/ResponseFormat/__TOCDet/Namespace = ARCAPI
Enum/ResponseFormat/__TOCDet/Type = ResponseFormat
Enum/ResponseFormat/__TOCDet/Attribute/AREnumType = OrdinaryEnum
Enum/ResponseFormat/__TOCDet/Attribute/AssemblyName = ARCAPI
Enum/ResponseFormat/__TOCDet/Attribute/Description = The response format, HTML or JSON, for an API request.0x000D0x000A0x000D0x000ANote: Looking up documentation for individual members of this enum may be inconsistent because value may be interpreted as response format, not a key
Enum/ResponseFormat/__TOCDet/Attribute/EnumNamespace = ARCAPI
Enum/ResponseFormat/__TOCDet/Attribute/EnumType = ResponseFormat
Enum/ResponseFormat/HTML/__TOCDet/Assembly = ARCAPI
Enum/ResponseFormat/HTML/__TOCDet/DocFragType = EnumMember
Enum/ResponseFormat/HTML/__TOCDet/Name = HTML
Enum/ResponseFormat/HTML/__TOCDet/Namespace = ARCAPI
Enum/ResponseFormat/HTML/__TOCDet/Type = ResponseFormat
Enum/ResponseFormat/HTML/__TOCDet/Attribute/EnumMember = HTML
Enum/ResponseFormat/HTML/__TOCDet/Attribute/EnumType = ResponseFormat
Enum/ResponseFormat/JSON/__TOCDet/Assembly = ARCAPI
Enum/ResponseFormat/JSON/__TOCDet/DocFragType = EnumMember
Enum/ResponseFormat/JSON/__TOCDet/Name = JSON
Enum/ResponseFormat/JSON/__TOCDet/Namespace = ARCAPI
Enum/ResponseFormat/JSON/__TOCDet/Type = ResponseFormat
Enum/ResponseFormat/JSON/__TOCDet/Attribute/EnumMember = JSON
Enum/ResponseFormat/JSON/__TOCDet/Attribute/EnumType = ResponseFormat

Edit single sub keys only: __TOCDet / Class / Enum

Generated 2025-11-22 18:47:13.941 UTC