Package com.thingworx.common

Class RESTAPIConstants

java.lang.Object

com.thingworx.common.RESTAPIConstants

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public final class RESTAPIConstants
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RESTAPIConstants.Characteristic
static enum	RESTAPIConstants.FunctionType
static enum	RESTAPIConstants.Method
static enum	RESTAPIConstants.StatusCode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_HEADER
static final String	ACTION_CHANGE_PASSWORD
static final String	ACTION_CONFIRM
static final String	ACTION_LOGIN
static final String	ACTION_LOGOUT
static final String	ATTACHMENT
static final String	AVATAR_CHARACTERISTIC
static final String	CONFIRM_PATH
static final String	CONTENT_DISPOSITION
static final String	CONTENT_LENGTH
static final String	CONTENT_TYPE
static final char	CR_CHARACTER
static final String	CSRF_COOKIE_NAME
static final String	DEFAULT_ACCEPT_TYPE
static final String	DEFAULT_CONTENT_TYPE
static final int	DEFAULT_FEED_ITEM_COUNT
static final int	DEFAULT_ITEM_COUNT
static final int	DEFAULT_SEARCH_ITEM_COUNT
static final int	DEFAULT_TIMEOUT
static final String	DEFINITION_CHARACTERISTIC
static final String	DESIGNTIMEPERMISSIONCHECK_CHARACTERISTIC
static HashSet<String>	DISABLED_METRICS_HASH_SET
static final String	FORM_CSRF_INPUT_NAME
static final String	FORM_LOGIN
static final String	FUNCTIONDEFINITIONS_CHARACTERISTIC
static final String	HEADER_AUTHENTICATE_CHALLENGE
static final String	HEADER_AUTHENTICATE_CHALLENGE_BASIC_REALM
static final String	HEADER_AUTHORIZATION
static final String	HEADER_AUTHORIZATION_BASIC
static final String	HEADER_AUTHORIZATION_MOBILE
static final String	HEADER_CONTENT_DISPOSITION
static final String	HEADER_COOKIE
static final String	HEADER_IF_NONE_MATCH
static final String	HEADER_IF_RANGE
static final String	HEADER_MOBILE_AUTH_REQUIRED
static final String	HEADER_TWX_MOBILE_TOKEN
static final String	HEADER_X_FORWARDED_FOR1
static final String	HEADER_X_FORWARDED_FOR2
static final String	HEADER_X_REQUESTED_WITH
static final char	HTML_TAG_START_CHARACTER
static final String	IMPLEMENTINGTHINGS_CHARACTERISTIC
static final String	IMPLEMENTINGTHINGSWITHDATA_CHARACTERISTIC
static final String	INSTANCEEVENTDEFINITIONS_CHARACTERISTIC
static final String	INSTANCEMETADATA_CHARACTERISTIC
static final String	INSTANCEMETADATAWITHPERMISSIONS_CHARACTERISTIC
static final String	INSTANCEPROPERTYDEFINITIONS_CHARACTERISTIC
static final String	INSTANCESERVICEDEFINITIONS_CHARACTERISTIC
static final String	INTERNAL_ERROR_MESSAGE
static final String	LAST_ORGANIZATION_COOKIE_NAME
static final String	LOCALHOST_IPV4
static final String	LOCALHOST_STRING
static final String	LOGIN_JSP_SUFFIX
static final int	MAX_SEARCH_API_ITEM_COUNT
static final String	MESSAGE_FIELD_NAME
static final String	METADATA_CHARACTERISTIC
static final String	METADATAWITHPERMISSIONS_CHARACTERISTIC
static final String	MIME_TYPE_APP_XML
static final String	MIME_TYPE_ATOM
static final String	MIME_TYPE_BINARY
static final String	MIME_TYPE_BMP
static final String	MIME_TYPE_CSV
static final String	MIME_TYPE_FORMDATA
static final String	MIME_TYPE_FORMENCODED
static final String	MIME_TYPE_GIF
static final String	MIME_TYPE_HTML
static final String	MIME_TYPE_JPG
static final String	MIME_TYPE_JSON
static final String	MIME_TYPE_JSONCOMPRESSED
static final String	MIME_TYPE_OCTETSTREAM
static final String	MIME_TYPE_PDF
static final String	MIME_TYPE_PNG
static final String	MIME_TYPE_RSS
static final String	MIME_TYPE_SVG
static final String	MIME_TYPE_TEXT
static final String	MIME_TYPE_UNKNOWNIMAGE
static final String	MIME_TYPE_WINDOWS_ICON
static final String	MIME_TYPE_XML
static final String	MIME_TYPE_ZIP
static final char	NL_CHARACTER
static final String	ORGANIZATION_NAME
static final String	PARAM_APIMETHOD
static final String	PARAM_APPKEY
static final String	PARAM_AUTHTYPE
static final String	PARAM_CHARACTERISTIC
static final String	PARAM_ENTITYNAME
static final String	PARAM_ENTITYTYPE
static final String	PARAM_EXPIRES
static final String	PARAM_FILTER_BASED_ON_SCOPE
static final String	PARAM_IF_MODIFIED_SINCE
static final String	PARAM_IF_UNMODIFIED_SINCE
static final String	PARAM_INCLUDE_ADDITIONAL_FIELDS
static final String	PARAM_LAST_MODIFIED
static final String	PARAM_MAXITEMS
static final String	PARAM_METADATA
static final String	PARAM_METHOD
static final String	PARAM_NAMEMASK
static final String	PARAM_PASSWORD
static final String	PARAM_POSTPARAMETER
static final String	PARAM_REASON
static final String	PARAM_SEARCHASPECTS
static final String	PARAM_SEARCHTAGS
static final String	PARAM_TARGET
static final String	PARAM_THINGNAME
static final String	PARAM_TWSR
static final String	PARAM_USE_SESSION
static final String	PARAM_USERID
static final String	PARAM_USERNAME
static final String	PARAM_WITHPERMISSIONS
static final String	PARAMETER_DELIMITER
static final String	PARAMETER_VALUE_DELIMITER
static final String	PREVIEW_CHARACTERISTIC
static final String	PROTOCOL_FTP
static final String	PROTOCOL_HTTP
static final String	PROTOCOL_HTTPS
static final String	PROTOCOL_SFTP
static final String	PROTOCOL_SSL
static final String	PROTOCOL_TCP
static final String	PROTOCOL_WS
static final String	PROTOCOL_WSS
static final String	QUERY_DELIMITER
static final String	RELATIVE_PATH_STRING
static final String	RESET_PATH
static final int	SESSION_DEFAULT_TIMEOUT
static final int	SESSION_FOREVER
static final String	SUCCESS_MESSAGE
static final String	SUMMARY_CHARACTERISTIC
static HashSet<String>	SUPPORTED_ACCEPT_TYPES
static HashSet<String>	SUPPORTED_CONTENT_TYPES
static HashSet<String>	SUPPORTED_IMAGE_TYPES
static HashSet<String>	SUPPORTED_MEDIA_ENTITY_CONTENT_TYPES
static final String	THINGWORX_CHANGEPASSWORD_PAGE
static final String	THINGWORX_FORM_CURRENT_PASSWORD
static final String	THINGWORX_FORM_EMAIL
static final String	THINGWORX_FORM_FIRSTNAME
static final String	THINGWORX_FORM_LASTNAME
static final String	THINGWORX_FORM_NEW_PASSWORD
static final String	THINGWORX_FORM_NEW_PASSWORD_CONFIRM
static final String	THINGWORX_FORM_ORIGINAL_URI_FIELD
static final String	THINGWORX_FORM_PASSWORD
static final String	THINGWORX_FORM_USERNAME
static final String	THINGWORX_HOME_URI
static final String	THINGWORX_JSESSIONID
static final String	THINGWORX_LOGIN_ERROR_MESSAGE
static final String	THINGWORX_LOGIN_PAGE
static final String	THINGWORX_MAIN_PAGE
static final String	THINGWORX_MEDIAENTITIES
static final String	THINGWORX_METRIC_HC_URI
static final String	THINGWORX_METRIC_URI
static final String	THINGWORX_PASSWORD_CHANGE_MESSAGE
static final String	THINGWORX_REPORT_URI
static final String	THINGWORX_SESSIONID
static final String	TRACE_PARAMETER
static final String	TWX_PUT_AS_PUT
static final String	UNSUPPORTED_ERROR_MESSAGE
static final String	UTF8_ENCODING
static final String	VISIBILITYPERMISSIONCHECK_CHARACTERISTIC
static final String	WEBAPP_NAME
static final String	WEBAPP_PATH_DELIMITER
static final String	WEBAPP_SCHEME_DELIMITER
static final String	WEBSOCKET_API_ENDPOINT
static final String	WEBSOCKET_RELATIVE_URI

Constructor Summary

Constructors

Constructor	Description
RESTAPIConstants()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
static String	buildBaseURL(String servletName)
static String	createURI(String entityType, String entityName, String characteristic, String target)
static RESTAPIConstants.Method	getMethod(String method)
static String	getMethodName(byte method)
static String	getSupportedAcceptType(String type)
static String	getSupportedContentType(String type)
static Charset	getUTF8Charset()
static boolean	isError(int statusCode)
static boolean	isImageType(String type)
static boolean	isOK(int statusCode)
static boolean	isRequest(byte code)
static boolean	isResponse(byte code)
static String[]	splitURI(String uri)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UTF8_ENCODING

public static final String UTF8_ENCODING

See Also:

• Constant Field Values

PROTOCOL_HTTP

public static final String PROTOCOL_HTTP

See Also:

• Constant Field Values

PROTOCOL_HTTPS

public static final String PROTOCOL_HTTPS

See Also:

• Constant Field Values

PROTOCOL_TCP

public static final String PROTOCOL_TCP

See Also:

• Constant Field Values

PROTOCOL_SSL

public static final String PROTOCOL_SSL

See Also:

• Constant Field Values

PROTOCOL_FTP

public static final String PROTOCOL_FTP

See Also:

• Constant Field Values

PROTOCOL_SFTP

public static final String PROTOCOL_SFTP

See Also:

• Constant Field Values

PROTOCOL_WS

public static final String PROTOCOL_WS

See Also:

• Constant Field Values

PROTOCOL_WSS

public static final String PROTOCOL_WSS

See Also:

• Constant Field Values

WEBAPP_NAME

public static final String WEBAPP_NAME

See Also:

• Constant Field Values

FORM_LOGIN

public static final String FORM_LOGIN

See Also:

• Constant Field Values

CONFIRM_PATH

public static final String CONFIRM_PATH

See Also:

• Constant Field Values

RESET_PATH

public static final String RESET_PATH

See Also:

• Constant Field Values

WEBAPP_PATH_DELIMITER

public static final String WEBAPP_PATH_DELIMITER

See Also:

• Constant Field Values

WEBAPP_SCHEME_DELIMITER

public static final String WEBAPP_SCHEME_DELIMITER

See Also:

• Constant Field Values

QUERY_DELIMITER

public static final String QUERY_DELIMITER

See Also:

• Constant Field Values

PARAMETER_DELIMITER

public static final String PARAMETER_DELIMITER

See Also:

• Constant Field Values

PARAMETER_VALUE_DELIMITER

public static final String PARAMETER_VALUE_DELIMITER

See Also:

• Constant Field Values

WEBSOCKET_API_ENDPOINT

public static final String WEBSOCKET_API_ENDPOINT

See Also:

• Constant Field Values

WEBSOCKET_RELATIVE_URI

public static final String WEBSOCKET_RELATIVE_URI

See Also:

• Constant Field Values

LOGIN_JSP_SUFFIX

public static final String LOGIN_JSP_SUFFIX

See Also:

• Constant Field Values

PARAM_METHOD

public static final String PARAM_METHOD

See Also:

• Constant Field Values

PARAM_MAXITEMS

public static final String PARAM_MAXITEMS

See Also:

• Constant Field Values

PARAM_SEARCHTAGS

public static final String PARAM_SEARCHTAGS

See Also:

• Constant Field Values

PARAM_SEARCHASPECTS

public static final String PARAM_SEARCHASPECTS

See Also:

• Constant Field Values

PARAM_NAMEMASK

public static final String PARAM_NAMEMASK

See Also:

• Constant Field Values

PARAM_METADATA

public static final String PARAM_METADATA

See Also:

• Constant Field Values

PARAM_ENTITYTYPE

public static final String PARAM_ENTITYTYPE

See Also:

• Constant Field Values

PARAM_ENTITYNAME

public static final String PARAM_ENTITYNAME

See Also:

• Constant Field Values

PARAM_THINGNAME

public static final String PARAM_THINGNAME

See Also:

• Constant Field Values

PARAM_CHARACTERISTIC

public static final String PARAM_CHARACTERISTIC

See Also:

• Constant Field Values

PARAM_TARGET

public static final String PARAM_TARGET

See Also:

• Constant Field Values

PARAM_APIMETHOD

public static final String PARAM_APIMETHOD

See Also:

• Constant Field Values

PARAM_WITHPERMISSIONS

public static final String PARAM_WITHPERMISSIONS

See Also:

• Constant Field Values

PARAM_POSTPARAMETER

public static final String PARAM_POSTPARAMETER

See Also:

• Constant Field Values

PARAM_TWSR

public static final String PARAM_TWSR

See Also:

• Constant Field Values

ORGANIZATION_NAME

public static final String ORGANIZATION_NAME

See Also:

• Constant Field Values

LOCALHOST_STRING

public static final String LOCALHOST_STRING

See Also:

• Constant Field Values

LOCALHOST_IPV4

public static final String LOCALHOST_IPV4

See Also:

• Constant Field Values

SESSION_FOREVER

public static final int SESSION_FOREVER

See Also:

• Constant Field Values

SESSION_DEFAULT_TIMEOUT

public static final int SESSION_DEFAULT_TIMEOUT

See Also:

• Constant Field Values

THINGWORX_SESSIONID

public static final String THINGWORX_SESSIONID

See Also:

• Constant Field Values

THINGWORX_JSESSIONID

public static final String THINGWORX_JSESSIONID

See Also:

• Constant Field Values

HEADER_AUTHENTICATE_CHALLENGE

public static final String HEADER_AUTHENTICATE_CHALLENGE

See Also:

• Constant Field Values

HEADER_AUTHENTICATE_CHALLENGE_BASIC_REALM

public static final String HEADER_AUTHENTICATE_CHALLENGE_BASIC_REALM

See Also:

• Constant Field Values

HEADER_AUTHORIZATION

public static final String HEADER_AUTHORIZATION

See Also:

• Constant Field Values

HEADER_AUTHORIZATION_BASIC

public static final String HEADER_AUTHORIZATION_BASIC

See Also:

• Constant Field Values

HEADER_AUTHORIZATION_MOBILE

public static final String HEADER_AUTHORIZATION_MOBILE

See Also:

• Constant Field Values

HEADER_TWX_MOBILE_TOKEN

public static final String HEADER_TWX_MOBILE_TOKEN

See Also:

• Constant Field Values

HEADER_MOBILE_AUTH_REQUIRED

public static final String HEADER_MOBILE_AUTH_REQUIRED

See Also:

• Constant Field Values

HEADER_X_FORWARDED_FOR1

public static final String HEADER_X_FORWARDED_FOR1

See Also:

• Constant Field Values

HEADER_X_FORWARDED_FOR2

public static final String HEADER_X_FORWARDED_FOR2

See Also:

• Constant Field Values

HEADER_X_REQUESTED_WITH

public static final String HEADER_X_REQUESTED_WITH

See Also:

• Constant Field Values

HEADER_COOKIE

public static final String HEADER_COOKIE

See Also:

• Constant Field Values

HEADER_IF_NONE_MATCH

public static final String HEADER_IF_NONE_MATCH

See Also:

• Constant Field Values

HEADER_IF_RANGE

public static final String HEADER_IF_RANGE

See Also:

• Constant Field Values

HEADER_CONTENT_DISPOSITION

public static final String HEADER_CONTENT_DISPOSITION

See Also:

• Constant Field Values

PARAM_AUTHTYPE

public static final String PARAM_AUTHTYPE

See Also:

• Constant Field Values

PARAM_USERID

public static final String PARAM_USERID

See Also:

• Constant Field Values

PARAM_USERNAME

public static final String PARAM_USERNAME

See Also:

• Constant Field Values

PARAM_PASSWORD

public static final String PARAM_PASSWORD

See Also:

• Constant Field Values

PARAM_APPKEY

public static final String PARAM_APPKEY

See Also:

• Constant Field Values

PARAM_USE_SESSION

public static final String PARAM_USE_SESSION

See Also:

• Constant Field Values

PARAM_IF_MODIFIED_SINCE

public static final String PARAM_IF_MODIFIED_SINCE

See Also:

• Constant Field Values

PARAM_IF_UNMODIFIED_SINCE

public static final String PARAM_IF_UNMODIFIED_SINCE

See Also:

• Constant Field Values

PARAM_LAST_MODIFIED

public static final String PARAM_LAST_MODIFIED

See Also:

• Constant Field Values

TWX_PUT_AS_PUT

public static final String TWX_PUT_AS_PUT

See Also:

• Constant Field Values

PARAM_REASON

public static final String PARAM_REASON

See Also:

• Constant Field Values

PARAM_EXPIRES

public static final String PARAM_EXPIRES

See Also:

• Constant Field Values

PARAM_INCLUDE_ADDITIONAL_FIELDS

public static final String PARAM_INCLUDE_ADDITIONAL_FIELDS

See Also:

• Constant Field Values

PARAM_FILTER_BASED_ON_SCOPE

public static final String PARAM_FILTER_BASED_ON_SCOPE

See Also:

• Constant Field Values

ACTION_LOGIN

public static final String ACTION_LOGIN

See Also:

• Constant Field Values

ACTION_CONFIRM

public static final String ACTION_CONFIRM

See Also:

• Constant Field Values

ACTION_CHANGE_PASSWORD

public static final String ACTION_CHANGE_PASSWORD

See Also:

• Constant Field Values

ACTION_LOGOUT

public static final String ACTION_LOGOUT

See Also:

• Constant Field Values

THINGWORX_LOGIN_PAGE

public static final String THINGWORX_LOGIN_PAGE

See Also:

• Constant Field Values

THINGWORX_MAIN_PAGE

public static final String THINGWORX_MAIN_PAGE

See Also:

• Constant Field Values

THINGWORX_CHANGEPASSWORD_PAGE

public static final String THINGWORX_CHANGEPASSWORD_PAGE

See Also:

• Constant Field Values

THINGWORX_FORM_USERNAME

public static final String THINGWORX_FORM_USERNAME

See Also:

• Constant Field Values

THINGWORX_FORM_PASSWORD

public static final String THINGWORX_FORM_PASSWORD

See Also:

• Constant Field Values

THINGWORX_FORM_FIRSTNAME

public static final String THINGWORX_FORM_FIRSTNAME

See Also:

• Constant Field Values

THINGWORX_FORM_LASTNAME

public static final String THINGWORX_FORM_LASTNAME

See Also:

• Constant Field Values

THINGWORX_FORM_EMAIL

public static final String THINGWORX_FORM_EMAIL

See Also:

• Constant Field Values

THINGWORX_FORM_CURRENT_PASSWORD

public static final String THINGWORX_FORM_CURRENT_PASSWORD

See Also:

• Constant Field Values

THINGWORX_FORM_NEW_PASSWORD

public static final String THINGWORX_FORM_NEW_PASSWORD

See Also:

• Constant Field Values

THINGWORX_FORM_NEW_PASSWORD_CONFIRM

public static final String THINGWORX_FORM_NEW_PASSWORD_CONFIRM

See Also:

• Constant Field Values

THINGWORX_FORM_ORIGINAL_URI_FIELD

public static final String THINGWORX_FORM_ORIGINAL_URI_FIELD

See Also:

• Constant Field Values

THINGWORX_LOGIN_ERROR_MESSAGE

public static final String THINGWORX_LOGIN_ERROR_MESSAGE

See Also:

• Constant Field Values

THINGWORX_PASSWORD_CHANGE_MESSAGE

public static final String THINGWORX_PASSWORD_CHANGE_MESSAGE

See Also:

• Constant Field Values

THINGWORX_HOME_URI

public static final String THINGWORX_HOME_URI

See Also:

• Constant Field Values

THINGWORX_METRIC_URI

public static final String THINGWORX_METRIC_URI

See Also:

• Constant Field Values

THINGWORX_METRIC_HC_URI

public static final String THINGWORX_METRIC_HC_URI

See Also:

• Constant Field Values

THINGWORX_MEDIAENTITIES

public static final String THINGWORX_MEDIAENTITIES

See Also:

• Constant Field Values

THINGWORX_REPORT_URI

public static final String THINGWORX_REPORT_URI

See Also:

• Constant Field Values

LAST_ORGANIZATION_COOKIE_NAME

public static final String LAST_ORGANIZATION_COOKIE_NAME

See Also:

• Constant Field Values

CSRF_COOKIE_NAME

public static final String CSRF_COOKIE_NAME

See Also:

• Constant Field Values

FORM_CSRF_INPUT_NAME

public static final String FORM_CSRF_INPUT_NAME

See Also:

• Constant Field Values

INTERNAL_ERROR_MESSAGE

public static final String INTERNAL_ERROR_MESSAGE

See Also:

• Constant Field Values

UNSUPPORTED_ERROR_MESSAGE

public static final String UNSUPPORTED_ERROR_MESSAGE

See Also:

• Constant Field Values

MESSAGE_FIELD_NAME

public static final String MESSAGE_FIELD_NAME

See Also:

• Constant Field Values

SUCCESS_MESSAGE

public static final String SUCCESS_MESSAGE

See Also:

• Constant Field Values

MIME_TYPE_XML

public static final String MIME_TYPE_XML

See Also:

• Constant Field Values

MIME_TYPE_HTML

public static final String MIME_TYPE_HTML

See Also:

• Constant Field Values

MIME_TYPE_ATOM

public static final String MIME_TYPE_ATOM

See Also:

• Constant Field Values

MIME_TYPE_RSS

public static final String MIME_TYPE_RSS

See Also:

• Constant Field Values

MIME_TYPE_JSON

public static final String MIME_TYPE_JSON

See Also:

• Constant Field Values

MIME_TYPE_JSONCOMPRESSED

public static final String MIME_TYPE_JSONCOMPRESSED

See Also:

• Constant Field Values

MIME_TYPE_CSV

public static final String MIME_TYPE_CSV

See Also:

• Constant Field Values

MIME_TYPE_FORMENCODED

public static final String MIME_TYPE_FORMENCODED

See Also:

• Constant Field Values

MIME_TYPE_FORMDATA

public static final String MIME_TYPE_FORMDATA

See Also:

• Constant Field Values

MIME_TYPE_SVG

public static final String MIME_TYPE_SVG

See Also:

• Constant Field Values

MIME_TYPE_PNG

public static final String MIME_TYPE_PNG

See Also:

• Constant Field Values

MIME_TYPE_ZIP

public static final String MIME_TYPE_ZIP

See Also:

• Constant Field Values

MIME_TYPE_JPG

public static final String MIME_TYPE_JPG

See Also:

• Constant Field Values

MIME_TYPE_GIF

public static final String MIME_TYPE_GIF

See Also:

• Constant Field Values

MIME_TYPE_BMP

public static final String MIME_TYPE_BMP

See Also:

• Constant Field Values

MIME_TYPE_WINDOWS_ICON

public static final String MIME_TYPE_WINDOWS_ICON

See Also:

• Constant Field Values

MIME_TYPE_PDF

public static final String MIME_TYPE_PDF

See Also:

• Constant Field Values

MIME_TYPE_UNKNOWNIMAGE

public static final String MIME_TYPE_UNKNOWNIMAGE

See Also:

• Constant Field Values

MIME_TYPE_BINARY

public static final String MIME_TYPE_BINARY

See Also:

• Constant Field Values

MIME_TYPE_OCTETSTREAM

public static final String MIME_TYPE_OCTETSTREAM

See Also:

• Constant Field Values

MIME_TYPE_TEXT

public static final String MIME_TYPE_TEXT

See Also:

• Constant Field Values

MIME_TYPE_APP_XML

public static final String MIME_TYPE_APP_XML

See Also:

• Constant Field Values

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

See Also:

• Constant Field Values

DEFAULT_ACCEPT_TYPE

public static final String DEFAULT_ACCEPT_TYPE

See Also:

• Constant Field Values

SUPPORTED_CONTENT_TYPES

public static HashSet<String> SUPPORTED_CONTENT_TYPES

SUPPORTED_ACCEPT_TYPES

public static HashSet<String> SUPPORTED_ACCEPT_TYPES

SUPPORTED_IMAGE_TYPES

public static HashSet<String> SUPPORTED_IMAGE_TYPES

SUPPORTED_MEDIA_ENTITY_CONTENT_TYPES

public static HashSet<String> SUPPORTED_MEDIA_ENTITY_CONTENT_TYPES

DISABLED_METRICS_HASH_SET

public static HashSet<String> DISABLED_METRICS_HASH_SET

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

• Constant Field Values

CONTENT_DISPOSITION

public static final String CONTENT_DISPOSITION

See Also:

• Constant Field Values

ATTACHMENT

public static final String ATTACHMENT

See Also:

• Constant Field Values

ACCEPT_HEADER

public static final String ACCEPT_HEADER

See Also:

• Constant Field Values

DEFAULT_ITEM_COUNT

public static final int DEFAULT_ITEM_COUNT

See Also:

• Constant Field Values

MAX_SEARCH_API_ITEM_COUNT

public static final int MAX_SEARCH_API_ITEM_COUNT

See Also:

• Constant Field Values

DEFAULT_SEARCH_ITEM_COUNT

public static final int DEFAULT_SEARCH_ITEM_COUNT

See Also:

• Constant Field Values

DEFAULT_FEED_ITEM_COUNT

public static final int DEFAULT_FEED_ITEM_COUNT

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

See Also:

• Constant Field Values

AVATAR_CHARACTERISTIC

public static final String AVATAR_CHARACTERISTIC

See Also:

• Constant Field Values

PREVIEW_CHARACTERISTIC

public static final String PREVIEW_CHARACTERISTIC

See Also:

• Constant Field Values

DEFINITION_CHARACTERISTIC

public static final String DEFINITION_CHARACTERISTIC

See Also:

• Constant Field Values

METADATA_CHARACTERISTIC

public static final String METADATA_CHARACTERISTIC

See Also:

• Constant Field Values

METADATAWITHPERMISSIONS_CHARACTERISTIC

public static final String METADATAWITHPERMISSIONS_CHARACTERISTIC

See Also:

• Constant Field Values

INSTANCEMETADATA_CHARACTERISTIC

public static final String INSTANCEMETADATA_CHARACTERISTIC

See Also:

• Constant Field Values

INSTANCEMETADATAWITHPERMISSIONS_CHARACTERISTIC

public static final String INSTANCEMETADATAWITHPERMISSIONS_CHARACTERISTIC

See Also:

• Constant Field Values

INSTANCESERVICEDEFINITIONS_CHARACTERISTIC

public static final String INSTANCESERVICEDEFINITIONS_CHARACTERISTIC

See Also:

• Constant Field Values

INSTANCEPROPERTYDEFINITIONS_CHARACTERISTIC

public static final String INSTANCEPROPERTYDEFINITIONS_CHARACTERISTIC

See Also:

• Constant Field Values

INSTANCEEVENTDEFINITIONS_CHARACTERISTIC

public static final String INSTANCEEVENTDEFINITIONS_CHARACTERISTIC

See Also:

• Constant Field Values

FUNCTIONDEFINITIONS_CHARACTERISTIC

public static final String FUNCTIONDEFINITIONS_CHARACTERISTIC

See Also:

• Constant Field Values

IMPLEMENTINGTHINGS_CHARACTERISTIC

public static final String IMPLEMENTINGTHINGS_CHARACTERISTIC

See Also:

• Constant Field Values

IMPLEMENTINGTHINGSWITHDATA_CHARACTERISTIC

public static final String IMPLEMENTINGTHINGSWITHDATA_CHARACTERISTIC

See Also:

• Constant Field Values

SUMMARY_CHARACTERISTIC

public static final String SUMMARY_CHARACTERISTIC

See Also:

• Constant Field Values

DESIGNTIMEPERMISSIONCHECK_CHARACTERISTIC

public static final String DESIGNTIMEPERMISSIONCHECK_CHARACTERISTIC

See Also:

• Constant Field Values

VISIBILITYPERMISSIONCHECK_CHARACTERISTIC

public static final String VISIBILITYPERMISSIONCHECK_CHARACTERISTIC

See Also:

• Constant Field Values

RELATIVE_PATH_STRING

public static final String RELATIVE_PATH_STRING

See Also:

• Constant Field Values

TRACE_PARAMETER

public static final String TRACE_PARAMETER

See Also:

• Constant Field Values

NL_CHARACTER

public static final char NL_CHARACTER

See Also:

• Constant Field Values

CR_CHARACTER

public static final char CR_CHARACTER

See Also:

• Constant Field Values

HTML_TAG_START_CHARACTER

public static final char HTML_TAG_START_CHARACTER

See Also:

• Constant Field Values

Constructor Details

RESTAPIConstants

public RESTAPIConstants()

Initializes this instace with default values.

Method Details

isRequest

@ThingworxExtensionApiMethod(since={6,6})
public static boolean isRequest(byte code)

isResponse

@ThingworxExtensionApiMethod(since={6,6})
public static boolean isResponse(byte code)

getUTF8Charset

@ThingworxExtensionApiMethod(since={6,6})
public static Charset getUTF8Charset()

getMethod

@ThingworxExtensionApiMethod(since={6,6})
public static RESTAPIConstants.Method getMethod(String method)

getMethodName

@ThingworxExtensionApiMethod(since={6,6})
public static String getMethodName(byte method)

getSupportedContentType

@ThingworxExtensionApiMethod(since={6,6})
public static String getSupportedContentType(String type)

isImageType

@ThingworxExtensionApiMethod(since={6,6})
public static boolean isImageType(String type)

getSupportedAcceptType

@ThingworxExtensionApiMethod(since={6,6})
public static String getSupportedAcceptType(String type)

buildBaseURL

@ThingworxExtensionApiMethod(since={6,6})
public static String buildBaseURL(String servletName)

splitURI

@ThingworxExtensionApiMethod(since={6,6})
public static String[] splitURI(String uri)

createURI

@ThingworxExtensionApiMethod(since={6,6})
public static String createURI(String entityType,
 String entityName,
 String characteristic,
 String target)

isOK

@ThingworxExtensionApiMethod(since={6,6})
public static boolean isOK(int statusCode)

isError

@ThingworxExtensionApiMethod(since={6,6})
public static boolean isError(int statusCode)