Get all subclasses
get
/fscmRestApi/resources/11.13.18.05/publicSectorSubClassMetas
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Find a subclass with the specified subclass ID.
Finder Variables:- SubclassId; string; The unique identifier for a subclass.
- PrimaryKey: Find a subclass with the specified subclass ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdfmCatalog; string; The Oracle Application Development Framework catalog associated with a subclass. For example: /oracle/apps/psc/permits/applicationIntake/publicModel/adfmcatalog.xml.
- AppmodConfig; string; The application module definition. For example, ApplicationIntakeAMLocal.
- AppmodName; string; The application module name. It must include full package name. For example, oracle.apps.psc.permits.applicationIntake.model.applicationModule.ApplicationIntakeAM.
- BaseEoName; string; The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO.
- BasePackageName; string; The base package name. For example, oracle.apps.psc.permits.applicationIntake.model.
- BaseVoName; string; The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO.
- CustomApplyDataRole; string; The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA.
- CustomManageAgencyRole; string; The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY.
- CustomManageRole; string; The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE.
- CustomPscViewAllAppl; string; The custom role for viewing workflow process definitions.
- CustomViewRole; string; The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE.
- DiscrCodeProperty; string; The value of the discriminator. For example, RecordTypeId.
- DiscrColumnName; string; The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID.
- DiscrPropertyName; string; The property name of the discriminator. For example, RecordTypeId.
- NewEoSuffix; string; The new suffix for the entity object. For example, RecordEO.
- NewFlatvoSuffix; string; The suffix for the flattened view object. For example, RecordFlatVO.
- NewRestSuffix; string; The new REST suffix. For example, RecordVO.
- NewRestflatSuffix; string; The new REST suffix for the flattened view object. For example, RecordFlatVO.
- NewVoSuffix; string; The new suffix for the view object. For example, RecordVO.
- OpssAdministratorPrivileges; string; The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update.
- OpssAdministratorUser; string; The user ID of the OPSS administrator user. For example, Admin.
- OpssPolicyName; string; The OPSS policy name associated with the subclass.
- OpssRestPermission; string; The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission.
- ResourceRegistry; string; The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx.
- RestSubpackage; string; The REST subpackage of the subclass. For example, resources.
- SessiondefPackageName; string; The session definition package name. For example, sessiondef.civic.model.
- SourcePropertyName; string; The name of the source property. For example, SourceAlias.
- SubclassDescription; string; The description of a subclass.
- SubclassId; string; The unique identifier for a subclass, which is generated during a create action.
- TableKey; string; The key for the underlying table.
- TableName; string; The table name of a subclass. For example, PSC_LNP_RECORD.
- VoKey; string; The key for the underlying view object.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorSubClassMetas
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorSubClassMetas-item-response
Type:
Show Source
object
-
AdfmCatalog: string
Maximum Length:
200
The Oracle Application Development Framework catalog associated with a subclass. For example: /oracle/apps/psc/permits/applicationIntake/publicModel/adfmcatalog.xml. -
AppmodConfig: string
Maximum Length:
100
The application module definition. For example, ApplicationIntakeAMLocal. -
AppmodName: string
Maximum Length:
100
The application module name. It must include full package name. For example, oracle.apps.psc.permits.applicationIntake.model.applicationModule.ApplicationIntakeAM. -
BaseEoName: string
Maximum Length:
200
The name of the base entity object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.entity.RecordEO. -
BasePackageName: string
Maximum Length:
200
The base package name. For example, oracle.apps.psc.permits.applicationIntake.model. -
BaseVoName: string
Maximum Length:
200
The name of base view object. For example, oracle.apps.psc.permits.applicationIntake.publicModel.view.RecordVO. -
CustomApplyDataRole: string
Maximum Length:
100
The custom role for applying permits data for a subclass. For example, CUSTOM_PSC_APPLY_PERMITS_DATA. -
CustomManageAgencyRole: string
Maximum Length:
100
The custom manage agency role for a subclass. For example, CUSTOM_PSC_MANAGE_PERMITS_AGENCY. -
CustomManageRole: string
Maximum Length:
100
The custom manage role for a subclass. For example, CUSTOM_PSC_MANAGE_ROLE. -
CustomPscViewAllAppl: string
Maximum Length:
100
The custom role for viewing workflow process definitions. -
CustomViewRole: string
Maximum Length:
100
The custom view role for a subclass. For example, CUSTOM_PSC_VIEW_ROLE. -
DiscrCodeProperty: string
Maximum Length:
60
The value of the discriminator. For example, RecordTypeId. -
DiscrColumnName: string
Maximum Length:
60
The column name used as the discriminator for polymorphic entity usage. For example, RECORD_TYPE_ID. -
DiscrPropertyName: string
Maximum Length:
60
The property name of the discriminator. For example, RecordTypeId. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewEoSuffix: string
Maximum Length:
60
The new suffix for the entity object. For example, RecordEO. -
NewFlatvoSuffix: string
Maximum Length:
60
The suffix for the flattened view object. For example, RecordFlatVO. -
NewRestflatSuffix: string
Maximum Length:
60
The new REST suffix for the flattened view object. For example, RecordFlatVO. -
NewRestSuffix: string
Maximum Length:
60
The new REST suffix. For example, RecordVO. -
NewVoSuffix: string
Maximum Length:
60
The new suffix for the view object. For example, RecordVO. -
OpssAdministratorPrivileges: string
Maximum Length:
200
The OPSS administrator privilege. For example, get, create, describe, delete, invoke, or update. -
OpssAdministratorUser: string
Maximum Length:
20
The user ID of the OPSS administrator user. For example, Admin. -
OpssPolicyName: string
Maximum Length:
60
The OPSS policy name associated with the subclass. -
OpssRestPermission: string
Maximum Length:
200
The OPSS REST permission for a subclass. For example, oracle.adf.share.security.authorization.RestServicePermission. -
ResourceRegistry: string
Maximum Length:
200
The resource registry for a subclass. For example, /oracle/apps/psc/permits/applicationIntake/model/ResourceRegistry.rpx. -
RestSubpackage: string
Maximum Length:
60
The REST subpackage of the subclass. For example, resources. -
SessiondefPackageName: string
Maximum Length:
200
The session definition package name. For example, sessiondef.civic.model. -
SourcePropertyName: string
Maximum Length:
60
The name of the source property. For example, SourceAlias. -
SubclassDescription: string
Maximum Length:
100
The description of a subclass. -
SubclassId: string
Maximum Length:
50
The unique identifier for a subclass, which is generated during a create action. -
TableKey: string
Maximum Length:
100
The key for the underlying table. -
TableName: string
Maximum Length:
60
The table name of a subclass. For example, PSC_LNP_RECORD. -
VoKey: string
Maximum Length:
100
The key for the underlying view object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.