Get an enumeration
get
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
Request
Path Parameters
-
EnumName: string
The name of the enumeration.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorOpaEnumerations-item
Type:
Show Source
object
-
ChildEnumName(optional):
string
Title:
Child Enumeration Name
Maximum Length:30
The name of the child enumeration. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the enumeration. -
CreatedOn(optional):
string(date-time)
The date on which the enumeration was created.
-
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date on which the enumeration was created. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the enumeration. -
EnumName(optional):
string
Title:
Enumeration Name
Maximum Length:30
The name of the enumeration. -
EnumType(optional):
string
Title:
Enumeration Type
Maximum Length:10
The data type of the enumeration. -
EnumValueService(optional):
array Enumeration Values
Title:
Enumeration Values
The enumerations resource is used to view all the enumeration names that are present in the Oracle Policy Automation configuration schema. An enumeration can have a single or multiple levels of values. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The name of the user who last updated the enumeration. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date on which the enumeration was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
OwnerId(optional):
string
Maximum Length:
10
The identifier of the owner who is associated with the enumeration. -
SeedDataLock(optional):
integer(int32)
Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
-
UncertainValue(optional):
string
Title:
Uncertain Value
Maximum Length:40
Indicates that the value for the enumeration is uncertain. -
UsesCustomTable(optional):
string
Maximum Length:
1
Indicates if the enumeration uses a user-defined table. Valid values are Y or N. -
ViewObjectId(optional):
number
Title:
View Object ID
The identifier of the View object that is associated with the enumeration.
Nested Schema : Enumeration Values
Type:
array
Title:
Enumeration Values
The enumerations resource is used to view all the enumeration names that are present in the Oracle Policy Automation configuration schema. An enumeration can have a single or multiple levels of values.
Show Source
Nested Schema : publicSectorOpaEnumerations-EnumValueService-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the enumeration value. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date on which the enumeration value was created. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N. -
Description(optional):
string
Title:
Description
Maximum Length:30
The description of the enumeration value. -
EnumName(optional):
string
Title:
Enumeration Name
Maximum Length:30
The name of the enumeration that is associated with the enumeration value. -
EnumValue(optional):
string
Title:
Enumeration Value
Maximum Length:50
The value of the enumeration. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date on which the enumeration value was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the enumeration value. -
links(optional):
array Items
Title:
Items
Link Relations -
OwnerId(optional):
string
Maximum Length:
10
The identifier of the owner who is associated with the enumeration value. -
SeedDataLock(optional):
integer(int32)
Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.