AdminApi.md

AdminApi

All URIs are relative to https://v2.namsor.com/NamSorAPIv2

Method	HTTP request	Description
anonymize	GET /api2/json/anonymize/{source}/{anonymized}	Activate/deactivate anonymization for a source.
anonymize1	GET /api2/json/anonymize/{source}/{anonymized}/{token}	Activate/deactivate anonymization for a source.
api_key_info	GET /api2/json/apiKeyInfo	Read API Key info.
api_status	GET /api2/json/apiStatus	Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
api_usage	GET /api2/json/apiUsage	Print current API usage.
api_usage_history	GET /api2/json/apiUsageHistory	Print historical API usage.
api_usage_history_aggregate	GET /api2/json/apiUsageHistoryAggregate	Print historical API usage (in an aggregated view, by service, by day/hour/min).
available_services	GET /api2/json/apiServices	List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
disable	GET /api2/json/disable/{source}/{disabled}	Activate/deactivate an API Key.
learnable	GET /api2/json/learnable/{source}/{learnable}/{token}	Activate/deactivate learning from a source.
learnable1	GET /api2/json/learnable/{source}/{learnable}	Activate/deactivate learning from a source.
regions	GET /api2/json/regions	Print basic source statistics.
software_version	GET /api2/json/softwareVersion	Get the current software version
taxonomy_classes	GET /api2/json/taxonomyClasses/{classifierName}	Print the taxonomy classes valid for the given classifier.

anonymize

anonymize(_api::AdminApi, source::String, anonymized::Bool; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse
anonymize(_api::AdminApi, response_stream::Channel, source::String, anonymized::Bool; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse

Activate/deactivate anonymization for a source.

Required Parameters

Name	Type	Description	Notes
_api	AdminApi	API context
source	String		[default to nothing]
anonymized	Bool		[default to nothing]

Return type

Nothing

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

anonymize1

anonymize1(_api::AdminApi, source::String, anonymized::Bool, token::String; _mediaType=nothing) -> APIKeyOut, OpenAPI.Clients.ApiResponse
anonymize1(_api::AdminApi, response_stream::Channel, source::String, anonymized::Bool, token::String; _mediaType=nothing) -> Channel{ APIKeyOut }, OpenAPI.Clients.ApiResponse

Activate/deactivate anonymization for a source.

Required Parameters

Name	Type	Description	Notes
_api	AdminApi	API context
source	String		[default to nothing]
anonymized	Bool		[default to nothing]
token	String		[default to nothing]

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_key_info

api_key_info(_api::AdminApi; _mediaType=nothing) -> APIKeyOut, OpenAPI.Clients.ApiResponse
api_key_info(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIKeyOut }, OpenAPI.Clients.ApiResponse

Read API Key info.

Required Parameters

This endpoint does not need any parameter.

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_status

api_status(_api::AdminApi; _mediaType=nothing) -> APIClassifiersStatusOut, OpenAPI.Clients.ApiResponse
api_status(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIClassifiersStatusOut }, OpenAPI.Clients.ApiResponse

Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.

Required Parameters

This endpoint does not need any parameter.

Return type

APIClassifiersStatusOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_usage

api_usage(_api::AdminApi; _mediaType=nothing) -> APIPeriodUsageOut, OpenAPI.Clients.ApiResponse
api_usage(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIPeriodUsageOut }, OpenAPI.Clients.ApiResponse

Print current API usage.

Required Parameters

This endpoint does not need any parameter.

Return type

APIPeriodUsageOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_usage_history

api_usage_history(_api::AdminApi; _mediaType=nothing) -> APIUsageHistoryOut, OpenAPI.Clients.ApiResponse
api_usage_history(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIUsageHistoryOut }, OpenAPI.Clients.ApiResponse

Print historical API usage.

Required Parameters

This endpoint does not need any parameter.

Return type

APIUsageHistoryOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_usage_history_aggregate

api_usage_history_aggregate(_api::AdminApi; _mediaType=nothing) -> APIUsageAggregatedOut, OpenAPI.Clients.ApiResponse
api_usage_history_aggregate(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIUsageAggregatedOut }, OpenAPI.Clients.ApiResponse

Print historical API usage (in an aggregated view, by service, by day/hour/min).

Required Parameters

This endpoint does not need any parameter.

Return type

APIUsageAggregatedOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

available_services

available_services(_api::AdminApi; _mediaType=nothing) -> APIServicesOut, OpenAPI.Clients.ApiResponse
available_services(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIServicesOut }, OpenAPI.Clients.ApiResponse

List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.

Required Parameters

This endpoint does not need any parameter.

Return type

APIServicesOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable

disable(_api::AdminApi, source::String, disabled::Bool; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse
disable(_api::AdminApi, response_stream::Channel, source::String, disabled::Bool; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse

Activate/deactivate an API Key.

Required Parameters

Name	Type	Description	Notes
_api	AdminApi	API context
source	String	The API Key to set as enabled/disabled.	[default to nothing]
disabled	Bool		[default to nothing]

Return type

Nothing

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

learnable

learnable(_api::AdminApi, source::String, learnable_param::Bool, token::String; _mediaType=nothing) -> APIKeyOut, OpenAPI.Clients.ApiResponse
learnable(_api::AdminApi, response_stream::Channel, source::String, learnable_param::Bool, token::String; _mediaType=nothing) -> Channel{ APIKeyOut }, OpenAPI.Clients.ApiResponse

Activate/deactivate learning from a source.

Required Parameters

Name	Type	Description	Notes
_api	AdminApi	API context
source	String	The API Key to set as learnable/non learnable.	[default to nothing]
learnable_param	Bool		[default to nothing]
token	String		[default to nothing]

Return type

APIKeyOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

learnable1

learnable1(_api::AdminApi, source::String, learnable::Bool; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse
learnable1(_api::AdminApi, response_stream::Channel, source::String, learnable::Bool; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse

Activate/deactivate learning from a source.

Required Parameters

Name	Type	Description	Notes
_api	AdminApi	API context
source	String	The API Key to set as learnable/non learnable.	[default to nothing]
learnable	Bool		[default to nothing]

Return type

Nothing

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

regions

regions(_api::AdminApi; _mediaType=nothing) -> RegionOut, OpenAPI.Clients.ApiResponse
regions(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ RegionOut }, OpenAPI.Clients.ApiResponse

Print basic source statistics.

Required Parameters

This endpoint does not need any parameter.

Return type

RegionOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

software_version

software_version(_api::AdminApi; _mediaType=nothing) -> SoftwareVersionOut, OpenAPI.Clients.ApiResponse
software_version(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ SoftwareVersionOut }, OpenAPI.Clients.ApiResponse

Get the current software version

Required Parameters

This endpoint does not need any parameter.

Return type

SoftwareVersionOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

taxonomy_classes

taxonomy_classes(_api::AdminApi, classifier_name::String; _mediaType=nothing) -> APIClassifierTaxonomyOut, OpenAPI.Clients.ApiResponse
taxonomy_classes(_api::AdminApi, response_stream::Channel, classifier_name::String; _mediaType=nothing) -> Channel{ APIClassifierTaxonomyOut }, OpenAPI.Clients.ApiResponse

Print the taxonomy classes valid for the given classifier.

Required Parameters

Name	Type	Description	Notes
_api	AdminApi	API context
classifier_name	String		[default to nothing]

Return type

APIClassifierTaxonomyOut

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]