CentraSite Documentation : Working with REST-based APIs : Getting Started with the CentraSite REST API Data Model : REST Parameters : Parameter Data Types
Parameter Data Types
When you add a parameter to the API, you specify the parameter's data type. The data type determines what kind of information the parameter can hold.
CentraSite supports the following data types for parameters.
Data Type
Description
String
Specifies a string of text.
URL
Holds a URL/URI. This type of parameter only accepts values in the form:
protocol://host:port/path
Where:
*protocol is any protocol that java.net.URL supports.
*host is the name or IP address of a host machine.
*port is the port on which the host machine is listening.
*path (optional) is the path to the requested resource on the specified host.
Boolean
Specifies a true or false value.
Email
Specifies an email address. This data type only accepts values in the format:
anyString@anyString
Number
Specifies a numeric value.
Duration
Specifies a value that represents a period of time as expressed in years, months, days, hours, minutes and seconds.
This duration is specified using an xs:duration format. It specifies a duration in terms of years (either 0 or 1), months, days, hours, minutes and seconds.
Date/Time
Specifies a timestamp that represents a specific date and/or time.
The date/time input parameters allow year, month and day input as well as hour and minute. Hour and minute default to 0.
This data type only accepts date values in the format yyyy-mm-dd; and time values in the format hh:mm:ss.
IP Address
Specifies a numeric IP address in the v4 or v6 format.
Copyright © Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback