The keys for the Grassroots Schema. More...

#include "grassroots_util_library.h"

Include dependency graph for schema_keys.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	CONTEXT_PREFIX_SCHEMA_ORG_S "so:"

#define	CONTEXT_PREFIX_EDAM_ONTOLOGY_S "eo:"

#define	CONTEXT_PREFIX_EXPERIMENTAL_FACTOR_ONTOLOGY_S "efo:"

#define	CONTEXT_PREFIX_SOFTWARE_ONTOLOGY_S "swo:"

#define	CONTEXT_PREFIX_CROP_ONTOLOGY_S "co:"

#define	CONTEXT_PREFIX_ENVIRONMENT_ONTOLOGY_S "envo:"

#define	CONTEXT_PREFIX_AGRONOMY_ONTOLOGY_S "agro:"

#define	CONTEXT_PREFIX_NCI_THESAUSUS_ONTOLOGY_S "ncit:"

#define	CONTEXT_PREFIX_STATS_ONTOLOGY_S "stato:"

Functions
const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_SCHEMA_ORG_S	SCHEMA_KEYS_VAL ("http://schema.org/")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_EDAM_ONOTOLOGY_S	SCHEMA_KEYS_VAL ("http://edamontology.org/")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_EXPERIMENTAL_FACTOR_ONOTOLOGY_S	SCHEMA_KEYS_VAL ("http://www.ebi.ac.uk/efo/")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_SOFTWARE_ONOTOLOGY_S	SCHEMA_KEYS_VAL ("http://www.ebi.ac.uk/swo/")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_CROP_ONTOLOGY_S	SCHEMA_KEYS_VAL ("http://www.cropontology.org/terms/")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_ENVIRONMENT_ONTOLOGY_S	SCHEMA_KEYS_VAL ("http://purl.obolibrary.org/obo/ENVO_")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_AGRONOMY_ONTOLOGY_S	SCHEMA_KEYS_VAL ("http://purl.obolibrary.org/obo/AGRO_")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_NCI_THESAUSUS_ONTOLOGY_S	SCHEMA_KEYS_VAL ("http://purl.obolibrary.org/obo/NCIT_")

const SCHEMA_KEYS_PREFIX char *CONTEXT_URL_STATS_ONTOLOGY_S	SCHEMA_KEYS_VAL ("http://purl.obolibrary.org/obo/STATO_")

const SCHEMA_KEYS_PREFIX char *HEADER_S	SCHEMA_KEYS_VAL ("header")
	The JSON key for the header object of the server response. More...

const SCHEMA_KEYS_PREFIX char *REQUEST_S	SCHEMA_KEYS_VAL ("request")
	The JSON key for a request. More...

const SCHEMA_KEYS_PREFIX char *REQUEST_VERBOSE_S	SCHEMA_KEYS_VAL ("verbose")

const SCHEMA_KEYS_PREFIX char *SERVICE_METADATA_APPLICATION_CATEGORY_S	SCHEMA_KEYS_VAL ("application_category")

const SCHEMA_KEYS_PREFIX char *SERVICE_METADATA_APPLICATION_SUBCATEGORY_S	SCHEMA_KEYS_VAL ("application_subcategory")

const SCHEMA_KEYS_PREFIX char *SCHEMA_TERM_URL_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "sameAs")

const SCHEMA_KEYS_PREFIX char *SCHEMA_TERM_ABBREVIATION_S	SCHEMA_KEYS_VAL ("abbreviation")

const SCHEMA_KEYS_PREFIX char *WEB_SERVICE_METHOD_S	SCHEMA_KEYS_VAL ("method")

const SCHEMA_KEYS_PREFIX char *INDEXING_SERVICE_NAME_S	SCHEMA_KEYS_VAL ("service")

const SCHEMA_KEYS_PREFIX char *INDEXING_SERVICE_ALIAS_S	SCHEMA_KEYS_VAL ("service_alternate_name")

const SCHEMA_KEYS_PREFIX char *INDEXING_TYPE_S	SCHEMA_KEYS_VAL ("@type")

const SCHEMA_KEYS_PREFIX char *INDEXING_TYPE_DESCRIPTION_S	SCHEMA_KEYS_VAL ("type_description")

const SCHEMA_KEYS_PREFIX char *INDEXING_TYPE_DESCRIPTION_SERVICE_GRASSROOTS_S	SCHEMA_KEYS_VAL ("Service")

const SCHEMA_KEYS_PREFIX char *INDEXING_PAYLOAD_DATA_S	SCHEMA_KEYS_VAL ("payload")

const SCHEMA_KEYS_PREFIX char *INDEXING_PAYLOAD_URL_S	SCHEMA_KEYS_VAL ("internal_url")

const SCHEMA_KEYS_PREFIX char *INDEXING_ID_S	SCHEMA_KEYS_VAL ("id")

char *	GetExpandedContextTerm (const char *term_s)
	Expand a context ontology term to its fully qualified version. More...

The Schema definitions for specifying ServiceJobs.
const SCHEMA_KEYS_PREFIX char *ERROR_S	SCHEMA_KEYS_VAL ("error")
	The JSON key for the errors object of the server response. More...

const SCHEMA_KEYS_PREFIX char *JOBS_MANAGER_S	SCHEMA_KEYS_VAL ("jobs_manager")

const SCHEMA_KEYS_PREFIX char *JOB_S	SCHEMA_KEYS_VAL ("job")

const SCHEMA_KEYS_PREFIX char *JOB_SERVICE_S	SCHEMA_KEYS_VAL ("service_name")
	The JSON key of the Service name for a ServiceJob. More...

const SCHEMA_KEYS_PREFIX char *JOB_OMITTED_RESULTS_S	SCHEMA_KEYS_VAL ("results_omitted")

const SCHEMA_KEYS_PREFIX char *JOB_ERRORS_S	SCHEMA_KEYS_VAL ("errors")

const SCHEMA_KEYS_PREFIX char *JOB_RUNTIME_ERRORS_S	SCHEMA_KEYS_VAL ("runtime_errors")
	The JSON key to specify errors for ServiceJobs where the parameters have been valid, yet the job has failed whilst running. More...

const SCHEMA_KEYS_PREFIX char *JOB_METADATA_S	SCHEMA_KEYS_VAL ("metadata")

const SCHEMA_KEYS_PREFIX char *JOB_UUID_S	SCHEMA_KEYS_VAL ("job_uuid")

const SCHEMA_KEYS_PREFIX char *JOB_REMOTE_URI_S	SCHEMA_KEYS_VAL ("remote_uri")

const SCHEMA_KEYS_PREFIX char *JOB_REMOTE_UUID_S	SCHEMA_KEYS_VAL ("remote_uuid")

const SCHEMA_KEYS_PREFIX char *JOB_REMOTE_SERVICE_S	SCHEMA_KEYS_VAL ("remote_service")

const SCHEMA_KEYS_PREFIX char *JOB_REMOTE_S	SCHEMA_KEYS_VAL ("remote_job")

const SCHEMA_KEYS_PREFIX char *JOB_TYPE_S	SCHEMA_KEYS_VAL ("job_type")

Schema definitions for specifying the Grassroots schema version.
const SCHEMA_KEYS_PREFIX char *SCHEMA_S	SCHEMA_KEYS_VAL ("schema")
	The JSON key for the schema object of the server response. More...

const SCHEMA_KEYS_PREFIX char *VERSION_MAJOR_S	SCHEMA_KEYS_VAL ("major")
	The JSON key for specifying the major version of the schema. More...

const SCHEMA_KEYS_PREFIX char *VERSION_MINOR_S	SCHEMA_KEYS_VAL ("minor")
	The JSON key for specifying the minor version of the schema. More...

const SCHEMA_KEYS_PREFIX char *VERSION_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "softwareVersion")

The Schema definitions for specifying the Service Providers.
const SCHEMA_KEYS_PREFIX char *SERVER_MULTIPLE_PROVIDERS_S	SCHEMA_KEYS_VAL ("providers")
	The JSON key for specifying an array of external Grassroots Servers. More...

const SCHEMA_KEYS_PREFIX char *SERVER_PROVIDER_S	SCHEMA_KEYS_VAL ("provider")
	The JSON key for specifying details about this Grassroots Server. More...

const SCHEMA_KEYS_PREFIX char *PROVIDER_NAME_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "name")
	The JSON key for the name of the Server to show to Clients and other connected Servers. More...

const SCHEMA_KEYS_PREFIX char *PROVIDER_DESCRIPTION_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "description")
	The JSON key for the description of the Server to show to Clients and other connected Servers. More...

const SCHEMA_KEYS_PREFIX char *PROVIDER_LOGO_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "logo")
	The JSON key for the url of a logo of the Server to show to Clients and other connected Servers. More...

const SCHEMA_KEYS_PREFIX char *PROVIDER_URI_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "url")
	The JSON key for the URI that accepts Grassroots message on the Server. More...

The Schema definitions for specifying Servers.
const SCHEMA_KEYS_PREFIX char *SERVERS_MANAGER_S	SCHEMA_KEYS_VAL ("servers_manager")

const SCHEMA_KEYS_PREFIX char *SERVERS_S	SCHEMA_KEYS_VAL ("servers")

const SCHEMA_KEYS_PREFIX char *SERVER_UUID_S	SCHEMA_KEYS_VAL ("server_uuid")

const SCHEMA_KEYS_PREFIX char *SERVER_NAME_S	SCHEMA_KEYS_VAL ("server_name")

const SCHEMA_KEYS_PREFIX char *SERVER_CONNECTION_TYPE_S	SCHEMA_KEYS_VAL ("server_connection")

const SCHEMA_KEYS_PREFIX char *SERVER_URI_S	SCHEMA_KEYS_VAL ("server_uri")


const SCHEMA_KEYS_PREFIX char *SERVER_PAIRED_SERVICES_S	SCHEMA_KEYS_VAL ("paired_services")

const SCHEMA_KEYS_PREFIX char *SERVER_LOCAL_PAIRED_SERVCE_S	SCHEMA_KEYS_VAL ("local")

const SCHEMA_KEYS_PREFIX char *SERVER_REMOTE_PAIRED_SERVCE_S	SCHEMA_KEYS_VAL ("remote")


const SCHEMA_KEYS_PREFIX char *CONNECTION_RAW_S	SCHEMA_KEYS_VAL ("connection_raw")

const SCHEMA_KEYS_PREFIX char *CONNECTION_WEB_S	SCHEMA_KEYS_VAL ("connection_web")


const SCHEMA_KEYS_PREFIX char *SERVER_OPERATIONS_S	SCHEMA_KEYS_VAL ("operations")

const SCHEMA_KEYS_PREFIX char *SERVER_OPERATION_S	SCHEMA_KEYS_VAL ("operation")
	The key to specify the operation id. More...

const SCHEMA_KEYS_PREFIX char *OPERATION_ID_OLD_S	SCHEMA_KEYS_VAL ("operationId")
	The key to specify the operation id. More...

const SCHEMA_KEYS_PREFIX char *OPERATION_ID_S	SCHEMA_KEYS_VAL ("so:name")
	The key to specify the operation id. More...

const SCHEMA_KEYS_PREFIX char *OPERATION_ICON_URI_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "image")

const SCHEMA_KEYS_PREFIX char *OPERATION_ICON_DATA_S	SCHEMA_KEYS_VAL ("icon_data")

const SCHEMA_KEYS_PREFIX char *OPERATION_SYNCHRONOUS_S	SCHEMA_KEYS_VAL ("synchronous")

The Schema definitions for specifying Services.
const SCHEMA_KEYS_PREFIX char *SERVICES_NAME_S	SCHEMA_KEYS_VAL ("services")

const SCHEMA_KEYS_PREFIX char *SERVICES_ID_S	SCHEMA_KEYS_VAL ("path")

const SCHEMA_KEYS_PREFIX char *SERVICE_RUN_S	SCHEMA_KEYS_VAL ("start_service")

const SCHEMA_KEYS_PREFIX char *SERVICE_REFRESH_S	SCHEMA_KEYS_VAL ("refresh_service")

const SCHEMA_KEYS_PREFIX char *SERVICE_INDEXING_DATA_S	SCHEMA_KEYS_VAL ("indexing_data")

const SCHEMA_KEYS_PREFIX char *SERVICES_STATUS_S	SCHEMA_KEYS_VAL ("status")

const SCHEMA_KEYS_PREFIX char *SERVICES_STATUS_DEFAULT_S	SCHEMA_KEYS_VAL ("default")

const SCHEMA_KEYS_PREFIX char *TYPE_SERVICE_S	SCHEMA_KEYS_VAL ("grassroots_service")

const SCHEMA_KEYS_PREFIX char *SERVICE_ALIAS_S	SCHEMA_KEYS_CONCAT_VAL (CONTEXT_PREFIX_SCHEMA_ORG_S, "alternateName")

const SCHEMA_KEYS_PREFIX char *SERVICE_UUID_S	SCHEMA_KEYS_VAL ("service_uuid")

const SCHEMA_KEYS_PREFIX char *SERVICE_STATUS_S	SCHEMA_KEYS_VAL ("status_text")

const SCHEMA_KEYS_PREFIX char *SERVICE_RESULTS_S	SCHEMA_KEYS_VAL ("results")

const SCHEMA_KEYS_PREFIX char *SERVICE_CATEGORY_S	SCHEMA_KEYS_VAL ("category")

const SCHEMA_KEYS_PREFIX char *SERVICE_JOBS_S	SCHEMA_KEYS_VAL ("jobs")

const SCHEMA_KEYS_PREFIX char *SERVICE_CONFIG_S	SCHEMA_KEYS_VAL ("config")

const SCHEMA_KEYS_PREFIX char *SERVICE_TYPE_VALUE_S	SCHEMA_KEYS_VAL ("Grassroots:Service")

const SCHEMA_KEYS_PREFIX char *SERVICE_RUN_MODE_S	SCHEMA_KEYS_VAL ("run_mode")

The Schema definitions for specifying LinkedServices.
const SCHEMA_KEYS_PREFIX char *SERVICE_METADATA_APPLICATION_INPUT_S	SCHEMA_KEYS_VAL ("input")

const SCHEMA_KEYS_PREFIX char *SERVICE_METADATA_APPLICATION_OUTPUT_S	SCHEMA_KEYS_VAL ("output")

const SCHEMA_KEYS_PREFIX char *LINKED_SERVICES_S	SCHEMA_KEYS_VAL ("linked_services")

const SCHEMA_KEYS_PREFIX char *LINKED_SERVICE_S	SCHEMA_KEYS_VAL ("linked_service")

const SCHEMA_KEYS_PREFIX char *LINKED_SERVICE_FUNCTION_S	SCHEMA_KEYS_VAL ("function")

const SCHEMA_KEYS_PREFIX char *MAPPED_PARAMS_LIST_S	SCHEMA_KEYS_VAL ("mappings")

const SCHEMA_KEYS_PREFIX char *MAPPED_PARAM_REQUIRED_S	SCHEMA_KEYS_VAL ("required")

const SCHEMA_KEYS_PREFIX char *MAPPED_PARAMS_ROOT_S	SCHEMA_KEYS_VAL ("input_root")

const SCHEMA_KEYS_PREFIX char *MAPPED_PARAM_MULTI_VALUED_S	SCHEMA_KEYS_VAL ("multiple")


const SCHEMA_KEYS_PREFIX char *PLUGIN_NAME_S	SCHEMA_KEYS_VAL ("plugin")

The Schema definitions for specifying ParameterSets.
const SCHEMA_KEYS_PREFIX char *PARAM_SET_KEY_S	SCHEMA_KEYS_VAL ("parameter_set")
	The JSON key for the ParameterSet object of the server response. More...

const SCHEMA_KEYS_PREFIX char *PARAM_SET_PARAMS_S	SCHEMA_KEYS_VAL ("parameters")
	The JSON key for the child object detailing all of the Parameters within a ParameterSet. More...

const SCHEMA_KEYS_PREFIX char *PARAM_SET_GROUPS_S	SCHEMA_KEYS_VAL ("groups")
	The JSON key for the child object containing the names of all of the ParameterGroups within a ParameterSet. More...

The Schema definitions for specifying Parameters
Each Parameter is an object in a json array value which is a child of PARAM_SET_PARAMS_S.
const SCHEMA_KEYS_PREFIX char *PARAM_NAME_S	SCHEMA_KEYS_VAL ("param")
	The JSON key for the name of Parameter. More...

const SCHEMA_KEYS_PREFIX char *PARAM_CONCISE_DEFINITION_S	SCHEMA_KEYS_VAL ("concise")

const SCHEMA_KEYS_PREFIX char *PARAM_STORE_S	SCHEMA_KEYS_VAL ("store")

const SCHEMA_KEYS_PREFIX char *PARAM_TYPE_S	SCHEMA_KEYS_VAL ("type")

const SCHEMA_KEYS_PREFIX char *PARAM_GRASSROOTS_TYPE_INFO_S	SCHEMA_KEYS_VAL ("grassroots_type_number")

const SCHEMA_KEYS_PREFIX char *PARAM_GRASSROOTS_TYPE_INFO_TEXT_S	SCHEMA_KEYS_VAL ("grassroots_type")

const SCHEMA_KEYS_PREFIX char *PARAM_GRASSROOTS_S	SCHEMA_KEYS_VAL ("parameter_type")

const SCHEMA_KEYS_PREFIX char *PARAM_COMPOUND_TEXT_S	SCHEMA_KEYS_VAL ("text")

const SCHEMA_KEYS_PREFIX char *PARAM_COMPOUND_VALUE_S	SCHEMA_KEYS_VAL ("value")
	The JSON key for specifying the value of a Resource. More...

const SCHEMA_KEYS_PREFIX char *PARAM_REFRESH_S	SCHEMA_KEYS_VAL ("refresh")

const SCHEMA_KEYS_PREFIX char *PARAM_READ_ONLY_S	SCHEMA_KEYS_VAL ("read_only")

const SCHEMA_KEYS_PREFIX char *PARAM_DEFAULT_VALUE_S	SCHEMA_KEYS_VAL ("default_value")
	The JSON key for the default value of Parameter. More...

const SCHEMA_KEYS_PREFIX char *PARAM_CURRENT_VALUE_S	SCHEMA_KEYS_VAL ("current_value")
	The JSON key for the current value of Parameter. More...

const SCHEMA_KEYS_PREFIX char *PARAM_OPTIONS_S	SCHEMA_KEYS_VAL ("enum")

const SCHEMA_KEYS_PREFIX char *PARAM_VISIBLE_S	SCHEMA_KEYS_VAL ("visible")
	The JSON key for specifying the default visibility of a ParameterGroup to a user. More...

const SCHEMA_KEYS_PREFIX char *PARAM_GROUP_S	SCHEMA_KEYS_VAL ("group")
	The JSON key for the name of the ParameterGroup for this Parameter. More...

const SCHEMA_KEYS_PREFIX char *PARAM_GROUP_REPEATABLE_S	SCHEMA_KEYS_VAL ("repeatable")
	The JSON key for specifying whether the parameters within a ParameterGroup can be repeated multiple times. More...

const SCHEMA_KEYS_PREFIX char *PARAM_GROUP_REPEATABLE_LABEL_S	SCHEMA_KEYS_VAL ("repeatable_label")
	If the parameters are repeatable, specify the parameter to use the entry labels. More...

const SCHEMA_KEYS_PREFIX char *PARAM_MIN_S	SCHEMA_KEYS_VAL ("min")
	The JSON key for specifying the minimum value that a numeric Parameter can take. More...

const SCHEMA_KEYS_PREFIX char *PARAM_MAX_S	SCHEMA_KEYS_VAL ("max")
	The JSON key for specifying the maximum value that a numeric Parameter can take. More...

const SCHEMA_KEYS_PREFIX char *PARAM_LEVEL_S	SCHEMA_KEYS_VAL ("level")
	The JSON key for specifying the level of the Parameter. More...

const SCHEMA_KEYS_PREFIX char *PARAM_LEVEL_TEXT_S	SCHEMA_KEYS_VAL ("level_text")

const SCHEMA_KEYS_PREFIX char *PARAM_LEVEL_TEXT_ALL_S	SCHEMA_KEYS_VAL ("all")
	The JSON key for specifying that a Parameter is suitable for all levels. More...

const SCHEMA_KEYS_PREFIX char *PARAM_LEVEL_TEXT_SIMPLE_S	SCHEMA_KEYS_VAL ("simple")
	The JSON key for specifying that a Parameter to be available for a client at the beginner level. More...

const SCHEMA_KEYS_PREFIX char *PARAM_LEVEL_TEXT_ADVANCED_S	SCHEMA_KEYS_VAL ("advanced")
	The JSON key for specifying that a Parameter to be available for a client at the advanced level. More...

const SCHEMA_KEYS_PREFIX char *PARAM_SERVER_ID_S	SCHEMA_KEYS_VAL ("server_id")

const SCHEMA_KEYS_PREFIX char *PARAM_REMOTE_S	SCHEMA_KEYS_VAL ("remote_details")

const SCHEMA_KEYS_PREFIX char *PARAM_VALUE_SET_FROM_TEXT_S	SCHEMA_KEYS_VAL ("value_as_text")

const SCHEMA_KEYS_PREFIX char *KEYWORDS_QUERY_S	SCHEMA_KEYS_VAL ("query")

The Schema definitions for specifying Resources.
The JSON keys for defining a Resource
const SCHEMA_KEYS_PREFIX char *RESOURCE_S	SCHEMA_KEYS_VAL ("resource")
	The JSON key for specifying a Resource object. More...

const SCHEMA_KEYS_PREFIX char *RESOURCE_PROTOCOL_S	SCHEMA_KEYS_VAL ("protocol")
	The JSON key for specifying the protocol for a Resource. More...

const SCHEMA_KEYS_PREFIX char *RESOURCE_TITLE_S	SCHEMA_KEYS_VAL ("title")
	The JSON key for specifying a title to display to Clients and external Servers, rather than show the name. More...

const SCHEMA_KEYS_PREFIX char *RESOURCE_DATA_S	SCHEMA_KEYS_VAL ("data")
	The JSON key for specifying any inline data for a Resource. More...

The Schema definitions for specifying user credentials.
const SCHEMA_KEYS_PREFIX char *USER_S	SCHEMA_KEYS_VAL ("user")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_S	SCHEMA_KEYS_VAL ("credentials")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_USERNAME_S	SCHEMA_KEYS_VAL ("username")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_PASSWORD_S	SCHEMA_KEYS_VAL ("password")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_UUID_S	SCHEMA_KEYS_VAL ("user_uuid")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_TOKEN_KEY_S	SCHEMA_KEYS_VAL ("token_key")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_TOKEN_SECRET_S	SCHEMA_KEYS_VAL ("token_secret")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_APP_KEY_S	SCHEMA_KEYS_VAL ("app_key")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_APP_SECRET_S	SCHEMA_KEYS_VAL ("app_secret")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_ENCRYPTION_METHOD_S	SCHEMA_KEYS_VAL ("encrypt_method")

const SCHEMA_KEYS_PREFIX char *CREDENTIALS_ENCRYPTION_KEY_S	SCHEMA_KEYS_VAL ("encrypt_key")

The Schema definitions for specifying DRMAA details.
const SCHEMA_KEYS_PREFIX char *DRMAA_S	SCHEMA_KEYS_VAL ("drmaa")

const SCHEMA_KEYS_PREFIX char *DRMAA_PROGRAM_NAME_S	SCHEMA_KEYS_VAL ("program_name")

const SCHEMA_KEYS_PREFIX char *DRMAA_ENVIRONMENT_S	SCHEMA_KEYS_VAL ("env_vars")

const SCHEMA_KEYS_PREFIX char *DRMAA_JOB_NAME_S	SCHEMA_KEYS_VAL ("job_name")

const SCHEMA_KEYS_PREFIX char *DRMAA_QUEUE_S	SCHEMA_KEYS_VAL ("queue")

const SCHEMA_KEYS_PREFIX char *DRMAA_WORKING_DIR_S	SCHEMA_KEYS_VAL ("working_dir")

const SCHEMA_KEYS_PREFIX char *DRMAA_OUTPUT_FILE_S	SCHEMA_KEYS_VAL ("output_file")

const SCHEMA_KEYS_PREFIX char *DRMAA_ID_S	SCHEMA_KEYS_VAL ("drmma_job_id")

const SCHEMA_KEYS_PREFIX char *DRMAA_UUID_S	SCHEMA_KEYS_VAL ("drmma_grassroots_uuid")

const SCHEMA_KEYS_PREFIX char *DRMAA_OUT_ID_S	SCHEMA_KEYS_VAL ("drmma_job_out_id")

const SCHEMA_KEYS_PREFIX char *DRMAA_HOSTNAME_S	SCHEMA_KEYS_VAL ("host")

const SCHEMA_KEYS_PREFIX char *DRMAA_EMAILS_S	SCHEMA_KEYS_VAL ("emails")

const SCHEMA_KEYS_PREFIX char *DRMAA_ARGS_S	SCHEMA_KEYS_VAL ("args")

const SCHEMA_KEYS_PREFIX char *DRMAA_NUM_CORES_S	SCHEMA_KEYS_VAL ("num_cores")

const SCHEMA_KEYS_PREFIX char *DRMAA_MEM_USAGE_S	SCHEMA_KEYS_VAL ("mem")

Detailed Description

The keys for the Grassroots Schema.

The messages sent between the Grassroots Servers and Clients are JSON-based and the various available keys are documented in this file.

The keys are available as constant strings where the first word or phrase shows the object which the key represents a member of. For instance ::PARAM_CURRENT_VALUE_S and ::PARAM_SET_NAME_S refer to the current value of a Parameter and the name of a ParameterSet respectively.

Under normal usage you will not need to explicitly do the conversion of a JSON description to the object that it represents in a step-by-step way as each object will have functions to do this e.g. a ParameterSet has GetParameterSetAsJSON() to get the JSON message for a given ParameterSet and CreateParameterSetFromJSON() to convert back from the JSON to a ParameterSet.

Macro Definition Documentation

◆ CONTEXT_PREFIX_SCHEMA_ORG_S

#define CONTEXT_PREFIX_SCHEMA_ORG_S "so:"

◆ CONTEXT_PREFIX_EDAM_ONTOLOGY_S

#define CONTEXT_PREFIX_EDAM_ONTOLOGY_S "eo:"

◆ CONTEXT_PREFIX_EXPERIMENTAL_FACTOR_ONTOLOGY_S

#define CONTEXT_PREFIX_EXPERIMENTAL_FACTOR_ONTOLOGY_S "efo:"

◆ CONTEXT_PREFIX_SOFTWARE_ONTOLOGY_S

#define CONTEXT_PREFIX_SOFTWARE_ONTOLOGY_S "swo:"

◆ CONTEXT_PREFIX_CROP_ONTOLOGY_S

#define CONTEXT_PREFIX_CROP_ONTOLOGY_S "co:"

◆ CONTEXT_PREFIX_ENVIRONMENT_ONTOLOGY_S

#define CONTEXT_PREFIX_ENVIRONMENT_ONTOLOGY_S "envo:"

◆ CONTEXT_PREFIX_AGRONOMY_ONTOLOGY_S

#define CONTEXT_PREFIX_AGRONOMY_ONTOLOGY_S "agro:"

◆ CONTEXT_PREFIX_NCI_THESAUSUS_ONTOLOGY_S

#define CONTEXT_PREFIX_NCI_THESAUSUS_ONTOLOGY_S "ncit:"

◆ CONTEXT_PREFIX_STATS_ONTOLOGY_S

#define CONTEXT_PREFIX_STATS_ONTOLOGY_S "stato:"

Function Documentation

◆ SCHEMA_KEYS_VAL() [1/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_SCHEMA_ORG_S SCHEMA_KEYS_VAL ( "http://schema.org/" )

◆ SCHEMA_KEYS_VAL() [2/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_EDAM_ONOTOLOGY_S SCHEMA_KEYS_VAL ( "http://edamontology.org/" )

◆ SCHEMA_KEYS_VAL() [3/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_EXPERIMENTAL_FACTOR_ONOTOLOGY_S SCHEMA_KEYS_VAL ( "http://www.ebi.ac.uk/efo/" )

◆ SCHEMA_KEYS_VAL() [4/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_SOFTWARE_ONOTOLOGY_S SCHEMA_KEYS_VAL ( "http://www.ebi.ac.uk/swo/" )

◆ SCHEMA_KEYS_VAL() [5/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_CROP_ONTOLOGY_S SCHEMA_KEYS_VAL ( "http://www.cropontology.org/terms/" )

◆ SCHEMA_KEYS_VAL() [6/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_ENVIRONMENT_ONTOLOGY_S SCHEMA_KEYS_VAL ( "http://purl.obolibrary.org/obo/ENVO_" )

◆ SCHEMA_KEYS_VAL() [7/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_AGRONOMY_ONTOLOGY_S SCHEMA_KEYS_VAL ( "http://purl.obolibrary.org/obo/AGRO_" )

◆ SCHEMA_KEYS_VAL() [8/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_NCI_THESAUSUS_ONTOLOGY_S SCHEMA_KEYS_VAL ( "http://purl.obolibrary.org/obo/NCIT_" )

◆ SCHEMA_KEYS_VAL() [9/148]

const SCHEMA_KEYS_PREFIX char* CONTEXT_URL_STATS_ONTOLOGY_S SCHEMA_KEYS_VAL ( "http://purl.obolibrary.org/obo/STATO_" )

◆ SCHEMA_KEYS_VAL() [10/148]

const SCHEMA_KEYS_PREFIX char *JOB_ERROR_S SCHEMA_KEYS_VAL ( "error" )

The JSON key for the errors object of the server response.

◆ SCHEMA_KEYS_VAL() [11/148]

const SCHEMA_KEYS_PREFIX char* HEADER_S SCHEMA_KEYS_VAL ( "header" )

The JSON key for the header object of the server response.

◆ SCHEMA_KEYS_VAL() [12/148]

const SCHEMA_KEYS_PREFIX char* REQUEST_S SCHEMA_KEYS_VAL ( "request" )

The JSON key for a request.

◆ SCHEMA_KEYS_VAL() [13/148]

const SCHEMA_KEYS_PREFIX char* REQUEST_VERBOSE_S SCHEMA_KEYS_VAL ( "verbose" )

◆ SCHEMA_KEYS_VAL() [14/148]

const SCHEMA_KEYS_PREFIX char* SCHEMA_S SCHEMA_KEYS_VAL ( "schema" )

The JSON key for the schema object of the server response.

This appears at the top level of JSON request objects.

◆ SCHEMA_KEYS_VAL() [15/148]

const SCHEMA_KEYS_PREFIX char* VERSION_MAJOR_S SCHEMA_KEYS_VAL ( "major" )

The JSON key for specifying the major version of the schema.

This is a child of SCHEMA_S

◆ SCHEMA_KEYS_VAL() [16/148]

const SCHEMA_KEYS_PREFIX char* VERSION_MINOR_S SCHEMA_KEYS_VAL ( "minor" )

The JSON key for specifying the minor version of the schema.

This is a child of SCHEMA_S

◆ SCHEMA_KEYS_CONCAT_VAL() [1/8]

const SCHEMA_KEYS_PREFIX char* VERSION_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"softwareVersion"
	)

◆ SCHEMA_KEYS_VAL() [17/148]

const SCHEMA_KEYS_PREFIX char* SERVER_MULTIPLE_PROVIDERS_S SCHEMA_KEYS_VAL ( "providers" )

The JSON key for specifying an array of external Grassroots Servers.

The objects contained in this array each have ::PROVIDER_NAME_S, ::PROVIDER_DESCRIPTION_S and ::PROVIDER_URI_S keys to describe each of the Servers.

◆ SCHEMA_KEYS_VAL() [18/148]

const SCHEMA_KEYS_PREFIX char* SERVER_PROVIDER_S SCHEMA_KEYS_VAL ( "provider" )

The JSON key for specifying details about this Grassroots Server.

The child key-value pairs of this object are ::PROVIDER_NAME_S, ::PROVIDER_DESCRIPTION_S and ::PROVIDER_URI_S keys to describe each of the Servers.

◆ SCHEMA_KEYS_CONCAT_VAL() [2/8]

const SCHEMA_KEYS_PREFIX char *INDEXING_NAME_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"name"
	)

The JSON key for the name of the Server to show to Clients and other connected Servers.

The JSON key for specifying the name of a ParameterGroup to a user.

The JSON key for the display name of Parameter.

The JSON key for the name of ParameterSet object of the server response.

The JSON key for the name of a ServiceJob.

See also: ::SERVER_MULTIPLE_PROVIDERS_S; :: SERVER_PROVIDER_S

This is a child of PARAM_SET_KEY_S

◆ SCHEMA_KEYS_CONCAT_VAL() [3/8]

const SCHEMA_KEYS_PREFIX char *INDEXING_DESCRIPTION_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"description"
	)

The JSON key for the description of the Server to show to Clients and other connected Servers.

The JSON key for specifying the a user-friendly description of a Resource.

The JSON key for the description of Parameter.

The JSON key for the description of ParameterSet object of the server response.

See also: ::SERVER_MULTIPLE_PROVIDERS_S; :: SERVER_PROVIDER_S

This is a child of PARAM_SET_KEY_S

◆ SCHEMA_KEYS_CONCAT_VAL() [4/8]

const SCHEMA_KEYS_PREFIX char* PROVIDER_LOGO_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"logo"
	)

The JSON key for the url of a logo of the Server to show to Clients and other connected Servers.

See also: ::SERVER_MULTIPLE_PROVIDERS_S; :: SERVER_PROVIDER_S

◆ SCHEMA_KEYS_CONCAT_VAL() [5/8]

const SCHEMA_KEYS_PREFIX char *WEB_SERVICE_URL_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"url"
	)

The JSON key for the URI that accepts Grassroots message on the Server.

See also: ::SERVER_MULTIPLE_PROVIDERS_S; :: SERVER_PROVIDER_S

◆ SCHEMA_KEYS_VAL() [19/148]

const SCHEMA_KEYS_PREFIX char* SERVERS_MANAGER_S SCHEMA_KEYS_VAL ( "servers_manager" )

◆ SCHEMA_KEYS_VAL() [20/148]

const SCHEMA_KEYS_PREFIX char* SERVERS_S SCHEMA_KEYS_VAL ( "servers" )

◆ SCHEMA_KEYS_VAL() [21/148]

const SCHEMA_KEYS_PREFIX char* SERVER_UUID_S SCHEMA_KEYS_VAL ( "server_uuid" )

◆ SCHEMA_KEYS_VAL() [22/148]

const SCHEMA_KEYS_PREFIX char* SERVER_NAME_S SCHEMA_KEYS_VAL ( "server_name" )

◆ SCHEMA_KEYS_VAL() [23/148]

const SCHEMA_KEYS_PREFIX char* SERVER_CONNECTION_TYPE_S SCHEMA_KEYS_VAL ( "server_connection" )

◆ SCHEMA_KEYS_VAL() [24/148]

const SCHEMA_KEYS_PREFIX char* SERVER_URI_S SCHEMA_KEYS_VAL ( "server_uri" )

◆ SCHEMA_KEYS_VAL() [25/148]

const SCHEMA_KEYS_PREFIX char* SERVER_PAIRED_SERVICES_S SCHEMA_KEYS_VAL ( "paired_services" )

◆ SCHEMA_KEYS_VAL() [26/148]

const SCHEMA_KEYS_PREFIX char* SERVER_LOCAL_PAIRED_SERVCE_S SCHEMA_KEYS_VAL ( "local" )

◆ SCHEMA_KEYS_VAL() [27/148]

const SCHEMA_KEYS_PREFIX char* SERVER_REMOTE_PAIRED_SERVCE_S SCHEMA_KEYS_VAL ( "remote" )

◆ SCHEMA_KEYS_VAL() [28/148]

const SCHEMA_KEYS_PREFIX char* CONNECTION_RAW_S SCHEMA_KEYS_VAL ( "connection_raw" )

◆ SCHEMA_KEYS_VAL() [29/148]

const SCHEMA_KEYS_PREFIX char* CONNECTION_WEB_S SCHEMA_KEYS_VAL ( "connection_web" )

◆ SCHEMA_KEYS_VAL() [30/148]

const SCHEMA_KEYS_PREFIX char* SERVER_OPERATIONS_S SCHEMA_KEYS_VAL ( "operations" )

◆ SCHEMA_KEYS_VAL() [31/148]

const SCHEMA_KEYS_PREFIX char *OPERATION_S SCHEMA_KEYS_VAL ( "operation" )

The key to specify the operation id.

This uses the string values returned from GetOperationAsString().

◆ SCHEMA_KEYS_VAL() [32/148]

const SCHEMA_KEYS_PREFIX char* OPERATION_ID_OLD_S SCHEMA_KEYS_VAL ( "operationId" )

The key to specify the operation id.

This uses the numeric values from enum Operation.

◆ SCHEMA_KEYS_VAL() [33/148]

const SCHEMA_KEYS_PREFIX char* OPERATION_ID_S SCHEMA_KEYS_VAL ( "so:name" )

The key to specify the operation id.

This uses the numeric values from enum Operation.

◆ SCHEMA_KEYS_CONCAT_VAL() [6/8]

const SCHEMA_KEYS_PREFIX char *INDEXING_ICON_URI_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"image"
	)

◆ SCHEMA_KEYS_VAL() [34/148]

const SCHEMA_KEYS_PREFIX char* OPERATION_ICON_DATA_S SCHEMA_KEYS_VAL ( "icon_data" )

◆ SCHEMA_KEYS_VAL() [35/148]

const SCHEMA_KEYS_PREFIX char* OPERATION_SYNCHRONOUS_S SCHEMA_KEYS_VAL ( "synchronous" )

◆ SCHEMA_KEYS_VAL() [36/148]

const SCHEMA_KEYS_PREFIX char* SERVICES_NAME_S SCHEMA_KEYS_VAL ( "services" )

◆ SCHEMA_KEYS_VAL() [37/148]

const SCHEMA_KEYS_PREFIX char* SERVICES_ID_S SCHEMA_KEYS_VAL ( "path" )

◆ SCHEMA_KEYS_VAL() [38/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_RUN_S SCHEMA_KEYS_VAL ( "start_service" )

◆ SCHEMA_KEYS_VAL() [39/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_REFRESH_S SCHEMA_KEYS_VAL ( "refresh_service" )

◆ SCHEMA_KEYS_VAL() [40/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_INDEXING_DATA_S SCHEMA_KEYS_VAL ( "indexing_data" )

◆ SCHEMA_KEYS_VAL() [41/148]

const SCHEMA_KEYS_PREFIX char *SERVICE_STATUS_VALUE_S SCHEMA_KEYS_VAL ( "status" )

◆ SCHEMA_KEYS_VAL() [42/148]

const SCHEMA_KEYS_PREFIX char* SERVICES_STATUS_DEFAULT_S SCHEMA_KEYS_VAL ( "default" )

◆ SCHEMA_KEYS_VAL() [43/148]

const SCHEMA_KEYS_PREFIX char* TYPE_SERVICE_S SCHEMA_KEYS_VAL ( "grassroots_service" )

◆ SCHEMA_KEYS_CONCAT_VAL() [7/8]

const SCHEMA_KEYS_PREFIX char* SERVICE_ALIAS_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"alternateName"
	)

◆ SCHEMA_KEYS_VAL() [44/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_UUID_S SCHEMA_KEYS_VAL ( "service_uuid" )

◆ SCHEMA_KEYS_VAL() [45/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_STATUS_S SCHEMA_KEYS_VAL ( "status_text" )

◆ SCHEMA_KEYS_VAL() [46/148]

const SCHEMA_KEYS_PREFIX char *JOB_RESULTS_S SCHEMA_KEYS_VAL ( "results" )

◆ SCHEMA_KEYS_VAL() [47/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_CATEGORY_S SCHEMA_KEYS_VAL ( "category" )

◆ SCHEMA_KEYS_VAL() [48/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_JOBS_S SCHEMA_KEYS_VAL ( "jobs" )

◆ SCHEMA_KEYS_VAL() [49/148]

const SCHEMA_KEYS_PREFIX char *CONFIG_S SCHEMA_KEYS_VAL ( "config" )

◆ SCHEMA_KEYS_VAL() [50/148]

const SCHEMA_KEYS_PREFIX char *INDEXING_TYPE_SERVICE_GRASSROOTS_S SCHEMA_KEYS_VAL ( "Grassroots:Service" )

◆ SCHEMA_KEYS_VAL() [51/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_RUN_MODE_S SCHEMA_KEYS_VAL ( "run_mode" )

◆ SCHEMA_KEYS_VAL() [52/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_METADATA_APPLICATION_CATEGORY_S SCHEMA_KEYS_VAL ( "application_category" )

◆ SCHEMA_KEYS_VAL() [53/148]

const SCHEMA_KEYS_PREFIX char* SERVICE_METADATA_APPLICATION_SUBCATEGORY_S SCHEMA_KEYS_VAL ( "application_subcategory" )

◆ SCHEMA_KEYS_VAL() [54/148]

const SCHEMA_KEYS_PREFIX char *TAG_INPUT_NAME_S SCHEMA_KEYS_VAL ( "input" )

◆ SCHEMA_KEYS_VAL() [55/148]

const SCHEMA_KEYS_PREFIX char *TAG_OUTPUT_NAME_S SCHEMA_KEYS_VAL ( "output" )

◆ SCHEMA_KEYS_CONCAT_VAL() [8/8]

const SCHEMA_KEYS_PREFIX char* SCHEMA_TERM_URL_S SCHEMA_KEYS_CONCAT_VAL	(	CONTEXT_PREFIX_SCHEMA_ORG_S	,
		"sameAs"
	)

◆ SCHEMA_KEYS_VAL() [56/148]

const SCHEMA_KEYS_PREFIX char* SCHEMA_TERM_ABBREVIATION_S SCHEMA_KEYS_VAL ( "abbreviation" )

◆ SCHEMA_KEYS_VAL() [57/148]

const SCHEMA_KEYS_PREFIX char* LINKED_SERVICES_S SCHEMA_KEYS_VAL ( "linked_services" )

◆ SCHEMA_KEYS_VAL() [58/148]

const SCHEMA_KEYS_PREFIX char* LINKED_SERVICE_S SCHEMA_KEYS_VAL ( "linked_service" )

◆ SCHEMA_KEYS_VAL() [59/148]

const SCHEMA_KEYS_PREFIX char* LINKED_SERVICE_FUNCTION_S SCHEMA_KEYS_VAL ( "function" )

◆ SCHEMA_KEYS_VAL() [60/148]

const SCHEMA_KEYS_PREFIX char* MAPPED_PARAMS_LIST_S SCHEMA_KEYS_VAL ( "mappings" )

◆ SCHEMA_KEYS_VAL() [61/148]

const SCHEMA_KEYS_PREFIX char *PARAM_REQUIRED_S SCHEMA_KEYS_VAL ( "required" )

◆ SCHEMA_KEYS_VAL() [62/148]

const SCHEMA_KEYS_PREFIX char* MAPPED_PARAMS_ROOT_S SCHEMA_KEYS_VAL ( "input_root" )

◆ SCHEMA_KEYS_VAL() [63/148]

const SCHEMA_KEYS_PREFIX char* MAPPED_PARAM_MULTI_VALUED_S SCHEMA_KEYS_VAL ( "multiple" )

◆ SCHEMA_KEYS_VAL() [64/148]

const SCHEMA_KEYS_PREFIX char* JOBS_MANAGER_S SCHEMA_KEYS_VAL ( "jobs_manager" )

◆ SCHEMA_KEYS_VAL() [65/148]

const SCHEMA_KEYS_PREFIX char* JOB_S SCHEMA_KEYS_VAL ( "job" )

◆ SCHEMA_KEYS_VAL() [66/148]

const SCHEMA_KEYS_PREFIX char* JOB_SERVICE_S SCHEMA_KEYS_VAL ( "service_name" )

The JSON key of the Service name for a ServiceJob.

◆ SCHEMA_KEYS_VAL() [67/148]

const SCHEMA_KEYS_PREFIX char* JOB_OMITTED_RESULTS_S SCHEMA_KEYS_VAL ( "results_omitted" )

◆ SCHEMA_KEYS_VAL() [68/148]

const SCHEMA_KEYS_PREFIX char *PARAM_ERRORS_S SCHEMA_KEYS_VAL ( "errors" )

◆ SCHEMA_KEYS_VAL() [69/148]

const SCHEMA_KEYS_PREFIX char* JOB_RUNTIME_ERRORS_S SCHEMA_KEYS_VAL ( "runtime_errors" )

The JSON key to specify errors for ServiceJobs where the parameters have been valid, yet the job has failed whilst running.

◆ SCHEMA_KEYS_VAL() [70/148]

const SCHEMA_KEYS_PREFIX char* JOB_METADATA_S SCHEMA_KEYS_VAL ( "metadata" )

◆ SCHEMA_KEYS_VAL() [71/148]

const SCHEMA_KEYS_PREFIX char* JOB_UUID_S SCHEMA_KEYS_VAL ( "job_uuid" )

◆ SCHEMA_KEYS_VAL() [72/148]

const SCHEMA_KEYS_PREFIX char *PARAM_REMOTE_URI_S SCHEMA_KEYS_VAL ( "remote_uri" )

◆ SCHEMA_KEYS_VAL() [73/148]

const SCHEMA_KEYS_PREFIX char* JOB_REMOTE_UUID_S SCHEMA_KEYS_VAL ( "remote_uuid" )

◆ SCHEMA_KEYS_VAL() [74/148]

const SCHEMA_KEYS_PREFIX char* JOB_REMOTE_SERVICE_S SCHEMA_KEYS_VAL ( "remote_service" )

◆ SCHEMA_KEYS_VAL() [75/148]

const SCHEMA_KEYS_PREFIX char* JOB_REMOTE_S SCHEMA_KEYS_VAL ( "remote_job" )

◆ SCHEMA_KEYS_VAL() [76/148]

const SCHEMA_KEYS_PREFIX char* JOB_TYPE_S SCHEMA_KEYS_VAL ( "job_type" )

◆ SCHEMA_KEYS_VAL() [77/148]

const SCHEMA_KEYS_PREFIX char* PLUGIN_NAME_S SCHEMA_KEYS_VAL ( "plugin" )

◆ SCHEMA_KEYS_VAL() [78/148]

const SCHEMA_KEYS_PREFIX char* PARAM_SET_KEY_S SCHEMA_KEYS_VAL ( "parameter_set" )

The JSON key for the ParameterSet object of the server response.

◆ SCHEMA_KEYS_VAL() [79/148]

const SCHEMA_KEYS_PREFIX char *PARAM_GROUP_PARAMS_S SCHEMA_KEYS_VAL ( "parameters" )

The JSON key for the child object detailing all of the Parameters within a ParameterSet.

If the parameters are repeatable, specify the parameter to use the entry labels.

This is a child of PARAM_SET_KEY_S

◆ SCHEMA_KEYS_VAL() [80/148]

const SCHEMA_KEYS_PREFIX char *PARAM_REPEATED_GROUPS_S SCHEMA_KEYS_VAL ( "groups" )

The JSON key for the child object containing the names of all of the ParameterGroups within a ParameterSet.

The JSON key for the name of the ParameterGroup for this Parameter.

This is a child of PARAM_SET_KEY_S

◆ SCHEMA_KEYS_VAL() [81/148]

const SCHEMA_KEYS_PREFIX char* PARAM_NAME_S SCHEMA_KEYS_VAL ( "param" )

The JSON key for the name of Parameter.

◆ SCHEMA_KEYS_VAL() [82/148]

const SCHEMA_KEYS_PREFIX char* PARAM_CONCISE_DEFINITION_S SCHEMA_KEYS_VAL ( "concise" )

◆ SCHEMA_KEYS_VAL() [83/148]

const SCHEMA_KEYS_PREFIX char* PARAM_STORE_S SCHEMA_KEYS_VAL ( "store" )

◆ SCHEMA_KEYS_VAL() [84/148]

const SCHEMA_KEYS_PREFIX char* PARAM_TYPE_S SCHEMA_KEYS_VAL ( "type" )

◆ SCHEMA_KEYS_VAL() [85/148]

const SCHEMA_KEYS_PREFIX char* PARAM_GRASSROOTS_TYPE_INFO_S SCHEMA_KEYS_VAL ( "grassroots_type_number" )

◆ SCHEMA_KEYS_VAL() [86/148]

const SCHEMA_KEYS_PREFIX char* PARAM_GRASSROOTS_TYPE_INFO_TEXT_S SCHEMA_KEYS_VAL ( "grassroots_type" )

◆ SCHEMA_KEYS_VAL() [87/148]

const SCHEMA_KEYS_PREFIX char* PARAM_GRASSROOTS_S SCHEMA_KEYS_VAL ( "parameter_type" )

◆ SCHEMA_KEYS_VAL() [88/148]

const SCHEMA_KEYS_PREFIX char* PARAM_COMPOUND_TEXT_S SCHEMA_KEYS_VAL ( "text" )

◆ SCHEMA_KEYS_VAL() [89/148]

const SCHEMA_KEYS_PREFIX char *KVP_VALUE_S SCHEMA_KEYS_VAL ( "value" )

The JSON key for specifying the value of a Resource.

This could be the filename, uri, etc. depending upon the protocol for this Resource.

◆ SCHEMA_KEYS_VAL() [90/148]

const SCHEMA_KEYS_PREFIX char* PARAM_REFRESH_S SCHEMA_KEYS_VAL ( "refresh" )

◆ SCHEMA_KEYS_VAL() [91/148]

const SCHEMA_KEYS_PREFIX char* PARAM_READ_ONLY_S SCHEMA_KEYS_VAL ( "read_only" )

◆ SCHEMA_KEYS_VAL() [92/148]

const SCHEMA_KEYS_PREFIX char* PARAM_DEFAULT_VALUE_S SCHEMA_KEYS_VAL ( "default_value" )

The JSON key for the default value of Parameter.

◆ SCHEMA_KEYS_VAL() [93/148]

const SCHEMA_KEYS_PREFIX char* PARAM_CURRENT_VALUE_S SCHEMA_KEYS_VAL ( "current_value" )

The JSON key for the current value of Parameter.

◆ SCHEMA_KEYS_VAL() [94/148]

const SCHEMA_KEYS_PREFIX char* PARAM_OPTIONS_S SCHEMA_KEYS_VAL ( "enum" )

◆ SCHEMA_KEYS_VAL() [95/148]

const SCHEMA_KEYS_PREFIX char *PARAM_GROUP_VISIBLE_S SCHEMA_KEYS_VAL ( "visible" )

The JSON key for specifying the default visibility of a ParameterGroup to a user.

◆ SCHEMA_KEYS_VAL() [96/148]

const SCHEMA_KEYS_PREFIX char* PARAM_GROUP_S SCHEMA_KEYS_VAL ( "group" )

The JSON key for the name of the ParameterGroup for this Parameter.

◆ SCHEMA_KEYS_VAL() [97/148]

const SCHEMA_KEYS_PREFIX char* PARAM_GROUP_REPEATABLE_S SCHEMA_KEYS_VAL ( "repeatable" )

The JSON key for specifying whether the parameters within a ParameterGroup can be repeated multiple times.

◆ SCHEMA_KEYS_VAL() [98/148]

const SCHEMA_KEYS_PREFIX char* PARAM_GROUP_REPEATABLE_LABEL_S SCHEMA_KEYS_VAL ( "repeatable_label" )

If the parameters are repeatable, specify the parameter to use the entry labels.

◆ SCHEMA_KEYS_VAL() [99/148]

const SCHEMA_KEYS_PREFIX char* PARAM_MIN_S SCHEMA_KEYS_VAL ( "min" )

The JSON key for specifying the minimum value that a numeric Parameter can take.

◆ SCHEMA_KEYS_VAL() [100/148]

const SCHEMA_KEYS_PREFIX char* PARAM_MAX_S SCHEMA_KEYS_VAL ( "max" )

The JSON key for specifying the maximum value that a numeric Parameter can take.

◆ SCHEMA_KEYS_VAL() [101/148]

const SCHEMA_KEYS_PREFIX char* PARAM_LEVEL_S SCHEMA_KEYS_VAL ( "level" )

The JSON key for specifying the level of the Parameter.

◆ SCHEMA_KEYS_VAL() [102/148]

const SCHEMA_KEYS_PREFIX char* PARAM_LEVEL_TEXT_S SCHEMA_KEYS_VAL ( "level_text" )

◆ SCHEMA_KEYS_VAL() [103/148]

const SCHEMA_KEYS_PREFIX char* PARAM_LEVEL_TEXT_ALL_S SCHEMA_KEYS_VAL ( "all" )

The JSON key for specifying that a Parameter is suitable for all levels.

◆ SCHEMA_KEYS_VAL() [104/148]

const SCHEMA_KEYS_PREFIX char* PARAM_LEVEL_TEXT_SIMPLE_S SCHEMA_KEYS_VAL ( "simple" )

The JSON key for specifying that a Parameter to be available for a client at the beginner level.

◆ SCHEMA_KEYS_VAL() [105/148]

const SCHEMA_KEYS_PREFIX char* PARAM_LEVEL_TEXT_ADVANCED_S SCHEMA_KEYS_VAL ( "advanced" )

The JSON key for specifying that a Parameter to be available for a client at the advanced level.

◆ SCHEMA_KEYS_VAL() [106/148]

const SCHEMA_KEYS_PREFIX char* PARAM_SERVER_ID_S SCHEMA_KEYS_VAL ( "server_id" )

◆ SCHEMA_KEYS_VAL() [107/148]

const SCHEMA_KEYS_PREFIX char* PARAM_REMOTE_S SCHEMA_KEYS_VAL ( "remote_details" )

◆ SCHEMA_KEYS_VAL() [108/148]

const SCHEMA_KEYS_PREFIX char* PARAM_VALUE_SET_FROM_TEXT_S SCHEMA_KEYS_VAL ( "value_as_text" )

◆ SCHEMA_KEYS_VAL() [109/148]

const SCHEMA_KEYS_PREFIX char* KEYWORDS_QUERY_S SCHEMA_KEYS_VAL ( "query" )

◆ SCHEMA_KEYS_VAL() [110/148]

const SCHEMA_KEYS_PREFIX char* RESOURCE_S SCHEMA_KEYS_VAL ( "resource" )

The JSON key for specifying a Resource object.

◆ SCHEMA_KEYS_VAL() [111/148]

const SCHEMA_KEYS_PREFIX char* RESOURCE_PROTOCOL_S SCHEMA_KEYS_VAL ( "protocol" )

The JSON key for specifying the protocol for a Resource.

◆ SCHEMA_KEYS_VAL() [112/148]

const SCHEMA_KEYS_PREFIX char* RESOURCE_TITLE_S SCHEMA_KEYS_VAL ( "title" )

The JSON key for specifying a title to display to Clients and external Servers, rather than show the name.

◆ SCHEMA_KEYS_VAL() [113/148]

const SCHEMA_KEYS_PREFIX char* RESOURCE_DATA_S SCHEMA_KEYS_VAL ( "data" )

The JSON key for specifying any inline data for a Resource.

◆ SCHEMA_KEYS_VAL() [114/148]

const SCHEMA_KEYS_PREFIX char *DRMAA_USERNAME_S SCHEMA_KEYS_VAL ( "user" )

◆ SCHEMA_KEYS_VAL() [115/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_S SCHEMA_KEYS_VAL ( "credentials" )

◆ SCHEMA_KEYS_VAL() [116/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_USERNAME_S SCHEMA_KEYS_VAL ( "username" )

◆ SCHEMA_KEYS_VAL() [117/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_PASSWORD_S SCHEMA_KEYS_VAL ( "password" )

◆ SCHEMA_KEYS_VAL() [118/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_UUID_S SCHEMA_KEYS_VAL ( "user_uuid" )

◆ SCHEMA_KEYS_VAL() [119/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_TOKEN_KEY_S SCHEMA_KEYS_VAL ( "token_key" )

◆ SCHEMA_KEYS_VAL() [120/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_TOKEN_SECRET_S SCHEMA_KEYS_VAL ( "token_secret" )

◆ SCHEMA_KEYS_VAL() [121/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_APP_KEY_S SCHEMA_KEYS_VAL ( "app_key" )

◆ SCHEMA_KEYS_VAL() [122/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_APP_SECRET_S SCHEMA_KEYS_VAL ( "app_secret" )

◆ SCHEMA_KEYS_VAL() [123/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_ENCRYPTION_METHOD_S SCHEMA_KEYS_VAL ( "encrypt_method" )

◆ SCHEMA_KEYS_VAL() [124/148]

const SCHEMA_KEYS_PREFIX char* CREDENTIALS_ENCRYPTION_KEY_S SCHEMA_KEYS_VAL ( "encrypt_key" )

◆ SCHEMA_KEYS_VAL() [125/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_S SCHEMA_KEYS_VAL ( "drmaa" )

◆ SCHEMA_KEYS_VAL() [126/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_PROGRAM_NAME_S SCHEMA_KEYS_VAL ( "program_name" )

◆ SCHEMA_KEYS_VAL() [127/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_ENVIRONMENT_S SCHEMA_KEYS_VAL ( "env_vars" )

◆ SCHEMA_KEYS_VAL() [128/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_JOB_NAME_S SCHEMA_KEYS_VAL ( "job_name" )

◆ SCHEMA_KEYS_VAL() [129/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_QUEUE_S SCHEMA_KEYS_VAL ( "queue" )

◆ SCHEMA_KEYS_VAL() [130/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_WORKING_DIR_S SCHEMA_KEYS_VAL ( "working_dir" )

◆ SCHEMA_KEYS_VAL() [131/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_OUTPUT_FILE_S SCHEMA_KEYS_VAL ( "output_file" )

◆ SCHEMA_KEYS_VAL() [132/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_ID_S SCHEMA_KEYS_VAL ( "drmma_job_id" )

◆ SCHEMA_KEYS_VAL() [133/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_UUID_S SCHEMA_KEYS_VAL ( "drmma_grassroots_uuid" )

◆ SCHEMA_KEYS_VAL() [134/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_OUT_ID_S SCHEMA_KEYS_VAL ( "drmma_job_out_id" )

◆ SCHEMA_KEYS_VAL() [135/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_HOSTNAME_S SCHEMA_KEYS_VAL ( "host" )

◆ SCHEMA_KEYS_VAL() [136/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_EMAILS_S SCHEMA_KEYS_VAL ( "emails" )

◆ SCHEMA_KEYS_VAL() [137/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_ARGS_S SCHEMA_KEYS_VAL ( "args" )

◆ SCHEMA_KEYS_VAL() [138/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_NUM_CORES_S SCHEMA_KEYS_VAL ( "num_cores" )

◆ SCHEMA_KEYS_VAL() [139/148]

const SCHEMA_KEYS_PREFIX char* DRMAA_MEM_USAGE_S SCHEMA_KEYS_VAL ( "mem" )

◆ SCHEMA_KEYS_VAL() [140/148]

const SCHEMA_KEYS_PREFIX char* WEB_SERVICE_METHOD_S SCHEMA_KEYS_VAL ( "method" )

◆ SCHEMA_KEYS_VAL() [141/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_SERVICE_NAME_S SCHEMA_KEYS_VAL ( "service" )

◆ SCHEMA_KEYS_VAL() [142/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_SERVICE_ALIAS_S SCHEMA_KEYS_VAL ( "service_alternate_name" )

◆ SCHEMA_KEYS_VAL() [143/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_TYPE_S SCHEMA_KEYS_VAL ( "@type" )

◆ SCHEMA_KEYS_VAL() [144/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_TYPE_DESCRIPTION_S SCHEMA_KEYS_VAL ( "type_description" )

◆ SCHEMA_KEYS_VAL() [145/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_TYPE_DESCRIPTION_SERVICE_GRASSROOTS_S SCHEMA_KEYS_VAL ( "Service" )

◆ SCHEMA_KEYS_VAL() [146/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_PAYLOAD_DATA_S SCHEMA_KEYS_VAL ( "payload" )

◆ SCHEMA_KEYS_VAL() [147/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_PAYLOAD_URL_S SCHEMA_KEYS_VAL ( "internal_url" )

◆ SCHEMA_KEYS_VAL() [148/148]

const SCHEMA_KEYS_PREFIX char* INDEXING_ID_S SCHEMA_KEYS_VAL ( "id" )

◆ GetExpandedContextTerm()

char* GetExpandedContextTerm ( const char * term_s )

Expand a context ontology term to its fully qualified version.

For instance "so:name" will become "http://schema.org/name" since "so:" is a shortcut for "http://schmema.org"

Parameters

term_s The term to expand.

Returns: The newly-allocated fully-qualified term url or NULL upon error. This will need to be freed with FreeCopiedString() to avoid a memory leak

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ CONTEXT_PREFIX_SCHEMA_ORG_S

◆ CONTEXT_PREFIX_EDAM_ONTOLOGY_S

◆ CONTEXT_PREFIX_EXPERIMENTAL_FACTOR_ONTOLOGY_S

◆ CONTEXT_PREFIX_SOFTWARE_ONTOLOGY_S

◆ CONTEXT_PREFIX_CROP_ONTOLOGY_S

◆ CONTEXT_PREFIX_ENVIRONMENT_ONTOLOGY_S

◆ CONTEXT_PREFIX_AGRONOMY_ONTOLOGY_S

◆ CONTEXT_PREFIX_NCI_THESAUSUS_ONTOLOGY_S

◆ CONTEXT_PREFIX_STATS_ONTOLOGY_S

Function Documentation

◆ SCHEMA_KEYS_VAL() [1/148]

◆ SCHEMA_KEYS_VAL() [2/148]

◆ SCHEMA_KEYS_VAL() [3/148]

◆ SCHEMA_KEYS_VAL() [4/148]

◆ SCHEMA_KEYS_VAL() [5/148]

◆ SCHEMA_KEYS_VAL() [6/148]

◆ SCHEMA_KEYS_VAL() [7/148]

◆ SCHEMA_KEYS_VAL() [8/148]

◆ SCHEMA_KEYS_VAL() [9/148]

◆ SCHEMA_KEYS_VAL() [10/148]

◆ SCHEMA_KEYS_VAL() [11/148]

◆ SCHEMA_KEYS_VAL() [12/148]

◆ SCHEMA_KEYS_VAL() [13/148]

◆ SCHEMA_KEYS_VAL() [14/148]

◆ SCHEMA_KEYS_VAL() [15/148]

◆ SCHEMA_KEYS_VAL() [16/148]

◆ SCHEMA_KEYS_CONCAT_VAL() [1/8]

◆ SCHEMA_KEYS_VAL() [17/148]

◆ SCHEMA_KEYS_VAL() [18/148]

◆ SCHEMA_KEYS_CONCAT_VAL() [2/8]

◆ SCHEMA_KEYS_CONCAT_VAL() [3/8]

◆ SCHEMA_KEYS_CONCAT_VAL() [4/8]

◆ SCHEMA_KEYS_CONCAT_VAL() [5/8]

◆ SCHEMA_KEYS_VAL() [19/148]

◆ SCHEMA_KEYS_VAL() [20/148]

◆ SCHEMA_KEYS_VAL() [21/148]

◆ SCHEMA_KEYS_VAL() [22/148]

◆ SCHEMA_KEYS_VAL() [23/148]

◆ SCHEMA_KEYS_VAL() [24/148]

◆ SCHEMA_KEYS_VAL() [25/148]

◆ SCHEMA_KEYS_VAL() [26/148]

◆ SCHEMA_KEYS_VAL() [27/148]

◆ SCHEMA_KEYS_VAL() [28/148]

◆ SCHEMA_KEYS_VAL() [29/148]

◆ SCHEMA_KEYS_VAL() [30/148]

◆ SCHEMA_KEYS_VAL() [31/148]

◆ SCHEMA_KEYS_VAL() [32/148]

◆ SCHEMA_KEYS_VAL() [33/148]

◆ SCHEMA_KEYS_CONCAT_VAL() [6/8]

◆ SCHEMA_KEYS_VAL() [34/148]

◆ SCHEMA_KEYS_VAL() [35/148]

◆ SCHEMA_KEYS_VAL() [36/148]

◆ SCHEMA_KEYS_VAL() [37/148]

◆ SCHEMA_KEYS_VAL() [38/148]

◆ SCHEMA_KEYS_VAL() [39/148]

◆ SCHEMA_KEYS_VAL() [40/148]

◆ SCHEMA_KEYS_VAL() [41/148]

◆ SCHEMA_KEYS_VAL() [42/148]

◆ SCHEMA_KEYS_VAL() [43/148]

◆ SCHEMA_KEYS_CONCAT_VAL() [7/8]

◆ SCHEMA_KEYS_VAL() [44/148]

◆ SCHEMA_KEYS_VAL() [45/148]

◆ SCHEMA_KEYS_VAL() [46/148]

◆ SCHEMA_KEYS_VAL() [47/148]

◆ SCHEMA_KEYS_VAL() [48/148]

◆ SCHEMA_KEYS_VAL() [49/148]

◆ SCHEMA_KEYS_VAL() [50/148]

◆ SCHEMA_KEYS_VAL() [51/148]

◆ SCHEMA_KEYS_VAL() [52/148]

◆ SCHEMA_KEYS_VAL() [53/148]

◆ SCHEMA_KEYS_VAL() [54/148]

◆ SCHEMA_KEYS_VAL() [55/148]

◆ SCHEMA_KEYS_CONCAT_VAL() [8/8]

◆ SCHEMA_KEYS_VAL() [56/148]

◆ SCHEMA_KEYS_VAL() [57/148]

◆ SCHEMA_KEYS_VAL() [58/148]