Naming Conventions for Flexfield APIs
Application Programming Interface (API) name is a name for your flexfield component, which isn't exposed to users. These names are used to identify flexfield components in various integration points, including web services, rules, and business intelligence.
How to Frame API Names
You must use only alphanumeric characters for API names. For example, enter a name with the characters A-Z, a-z, or 0-9, with a non-numeric leading character. Don't use spaces, underscores, multi-byte characters, or leading numeric characters in your API names.
Do not change API names after they're created. Doing so could break integration points.
Words You Can't Use for API Names
You can't use certain words for API names when configuring flexfields because they're reserved words in ADF, SQL, PL/SQL, Java, Groovy, and so on.
This table lists some of the reserved words that can't be used as API names. This list isn't exhaustive.
|
Letter |
Reserved Words |
|---|---|
|
A |
ABORT, ABSTRACT, ACCEPT, ACCESS, ACTIONENABLED, ADD, ALL, ALLROWSINRANGE, ALTER, AND, ANY, ARRAY, ARRAYLEN, AS, ASC, ASSERT, ASSIGN, AT, ATTRIBUTEDEF, ATTRIBUTEDEFS, ATTRIBUTEVALUE, ATTRIBUTEVALUES, AUDIT, AUTHORIZATION, AVG |
|
B |
BEGIN, BETWEEN, BINDINGS, BODY, BOOLEAN, BREAK, BY, BYTE, BYVALUE |
|
C |
CASCADE, CASE, CAST, CATCH, CATEGORY, CHAR, CHECK, CHILDREN, CLASS, CLONE, CLOSE, CLUSTER, CLUSTERS, COALESCE, COLAUTH, COLUMN, COLUMNS, COMMENT, COMMIT, COMPRESS, CONNECT, CONST, CONSTANT, CONSTRIANT, CONTAINS, CONTINUE, COUNT, CRASH, CREATE, CURRENT, CURRENTROW, CURRVAL, CURSOR |
|
D |
DATABASE, DATACONTROL, DATE, DBA, DEBUGOFF, DEBUGON, DECIMAL, DECLARE, DEFAULT, DEFINITION, DELAY, DELETE, DELTA, DESC, DESCRIPTION, DIGITS, DISPLAY, DISPLAYDATA, DISPLAYHINT, DISPLAYHINTS, DISPOSE, DISTINCT, DIV, DO, DOUBLE, DROP |
|
E |
ELSE, ELSIF, EMPTY, ENABLED, ENABLEDSTRING, END, ENTRY, EQ, EQUALS, ERROR, ESTIMATEDROWCOUNT, EXCEPTION, EXCLUSIVE, EXISTS, EXIT, EXTENDS |
|
F |
FALSE, FETCH, FILE, FINAL, FINALIZE, FINALLY, FINDMODE, FLOAT, FOR, FORM, FROM, FULLNAME, FUNCTION, FUTURE |
|
G |
GE, GENERIC, GETCLASS, GOTO, GRANT, GROUP, GROUPBY, GT |
|
H |
HASHCODE, HAVING, HINTS |
|
I |
IDENTIFIED, IF, IMMEDIATE, IMPLEMENTS, IMPORT, IN, INCREMENT, INDEX, INDEXES, INDICATOR, INITIAL, INNER, INPUTVALUE, INSERT, INSTANCEOF, INT, INTEGER, INTERFACE, INTERSECT, INTO, IS, ITERATORBINDING |
|
J |
JAVA |
|
K |
KEY |
|
L |
LABEL, LABELS, LABELSET, LE, LEVEL, LIKE, LIMITED, LOCK, LONG, LOOP, LT |
|
M |
MANDATORY, MAX, MAXEXTENTS, MIN, MINUS, MLSLABEL, MOD, MODE, MODIFY |
|
N |
NAME, NATIVE, NATURAL, NE, NEW, NEXTVAL, NOAUDIT, NOCOMPRESS, NOT, NOTFOUND, NOTIFY, NOTIFYALL, NOWAIT, NULL, NULLIF, NUMBER |
|
O |
OF, OFFLINE, ON, ONLINE, OPEN, OPERATIONENABLED, OPERATOR, OPTION, OR, ORDER, ORDERBY, OTHERS, OUT, OUTER, OVERLAPS |
|
P |
PACKAGE, PARTITION, PCTFREE, POSITIVE, PRAGMA, PRIMARY, PRIOR, PRIVATE, PRIVILEGES, PROCEDURE, PROTECTED, PUBLIC |
|
R |
RAISE, RANGE, RANGESET, RANGESIZE, RANGESTART, RAW, REAL, RECORD, REFERENCES, RELEASE, REMR, RENAME, RESOURCE, REST, RESULT, RETURN, REVERSE, REVOKE, ROLLBACK, ROOTNODEBINDING, ROW, ROWID, ROWLABEL, ROWNUM, ROWS, ROWTYPE, RUN |
|
S |
SAVEPOINT, SCHEMA, SELECT, SELECTEDVALUE, SEPARATE, SESSION, SET, SHARE, SHORT, SIZE, SMALLINT, SPACE, SQL, SQLBUF, SQLCODE, SQLERRM, START, STATEMENT, STATIC, STDDEV, SUBTYPE, SUCCESSFUL, SUM, SUPER, SWITCH, SYNCHRONIZED, SYNONYM, SYSDATE |
|
T |
TABAUTH, TABLE, TABLES, TASK, TERMINATE, THEN, THIS, THROW, THROWS, TO, TOOLTIP, TOSTRING, TRANSIENT, TRIGGER, TRUE, TRY, TYPE |
|
U |
UID, UNION, UNIQUE, UPDATE, UPDATEABLE, USE, USER |
|
V |
VALIDATE, VALUES, VAR, VARCHAR, VARCHAR2, VARIANCE, VIEW, VIEWS, VOID, VOLATILE |
|
W |
WAIT, WHEN, WHENEVER, WHERE, WHILE, WITH, WORK |
|
X |
XOR |