AnalyzeRe.APITypes Namespace Reference

Classes
class	APIResource_WithDataEndpoint
	Minor extension to the base APIResource class that adds a "/data" sub-resource, since this is common to several resources. More...
class	APIType_Polymorphic
	Base class used by all types and resources. More...
class	CommandSubResource
	Describes a command sub-resource available off a resource which can be POSTed to with no data to invoke some sort of action. More...
class	DataSubResource
	Describes an additional data sub-resource available off a resource. Endpoint supports GET and PUT. More...
interface	IAPI_Polymorphic
	Interface for polymorphic types on the server. More...
interface	IAPIAnalysis
	Interface for resources that reference an analysis profile. More...
interface	IAPIResource_WithDataEndpoint
	Describes an APIResource class that adds a "/data" sub-resource, since this functionality is common to several different resources. TODO: Make this a mix-in if C# ever supports mix-ins or something similar. More...
interface	IEndpoint
	Describes an endpoint on the server that can be interacted with. Inheriting from this interface means you can return some relative path (off a base API URL) at which the endpoint can be visited. More...
interface	IResourceCollection
	Describes a collection of resources which can be listed. More...
interface	IStoredAPIResource
	Interface for Base class used by all stored resources. More...
interface	IStoredAPIResource_WithStatus
	Describes an APIResource class that has a "status" property and corresponding "status_message" which is used to monitor whether the resource has been validated server_side and is ready to be used. More...
class	LargeDataSubResource
	Describes an endpoint off of some types of resources from which an associated "large data file" can be accessed. This is a standard endpoint that exists for all of IAPIResource_WithDataEndpoint resource types which surfaces a standard set of large file upload functionality. This endpoint supports GET and PUT, as well as chunked large data upload using POST and PATCH. More...
class	OptionsResponse
	Used to deserialize server OPTIONS response. More...
class	Reference
	Implements the basic reference entity interface, but has no support for resolving references. More...
class	ResourceCollection
	Describes a collection of resources which can be listed. More...
class	ResourcePathBuilder
	Used to define resources / requests easily and get the resource request path in return. An implementing class should implement the server_point string getter, and call the appropriate base constructor from its constructor to define the sub-resource URL.
class	ServerError
	Used to deserialize server error messages. More...
class	StoredAPIResource
	Base class used by all persistent resources. More...
class	StoredAPIResource_Polymorphic
	Stored resource that is polymorphic (has more than one sub-type). More...
class	StoredAPIResource_WithStatus
	Base class for a StoredAPIResource that has a "status" property and corresponding "status_message" which is used to monitor whether the resource has been validated server_side and is ready to be used. More...
class	SubResource
	Describes an additional sub-resource available off a resource which is not actually a property of that resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support GET. More...
class	SubResourceCollection
	Describes a collection of resources available off another resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support list operations. More...
class	SubResourceEndpoint
	Describes an additional sub-resource available off a resource which is not actually a property of that resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support one or more REST methods. More...